Operator journey
- Install Gateway via install.sh, or bring up Compose/Swarm yourself (see Docker / Swarm).
- Activate .lic against the configured issuer (air-gap / offline activation is not supported).
- Add provider credentials in Gateway admin.
- Create a pool alias (this becomes the OpenAI model id).
- Create or use the bootstrap API key; call /v1/chat/completions.
API surface
After licensing, the Gateway exposes the broader OpenAI-compatible /v1 surface: models, chat/completions, responses, embeddings, moderations, images/generations, audio transcriptions/speech, rerank, plus MCP authorize/audit endpoints. MCP does not execute tools locally. Browse the interactive reference at /docs/api/gateway on Cloud, or at https://your-domain.demo/docs (OpenAPI https://your-domain.demo/openapi.json) on your Gateway origin.
Critical volumes
| Volume | Mount | Why it matters |
|---|---|---|
| gateway-data | /var/lib/zenith | master.key — losing it breaks encrypted provider API keys |
| pg-data | /var/lib/postgresql/data | Gateway database |
| nats-data | /data/jetstream | Optional JetStream state when NATS is enabled |