Skip to main content
This runs the standalone image: Relay and its own Postgres in one container, with the catalog seeded on first boot.
1

Start the relay

The volume keeps your data, the generated credentials and the master key across container restarts. The image is built for linux/amd64.
Admin UI and control API on :8081, OpenAI- and Anthropic-compatible inference API on :8080.
To run the lean image with separate Postgres and Valkey containers instead, use the Compose stack.
2

Sign in and run the setup wizard

On first boot the container prints a generated password for the user admin, and an admin token, to its log:
Open localhost:8081, sign in as admin with that password, and follow the setup wizard to add a provider’s API key and create a relay key.
The relay key is shown once, when it is created. Copy it then; only its hash is stored.
3

Make a request

Use a model from a provider you added a key for. To see what your relay key can reach:

Hit a snag?

Status codes and error codes, login problems, keys that stop working.

Next steps

Docker

Persisting data, pinning the master key, the Compose stack and the lean image.

Kubernetes

The Helm chart, migrations, scaling and monitoring.

Clients

Point the OpenAI and Anthropic SDKs at Relay.

Inference API

Endpoints, wire shapes, streaming and errors.