Skip to content

Integration

Integration means using both the Proxy (inference) and the admin HTTP APIs behind Admin (provisioning and operations). Admin also has Analytics (usage and reliability) and other menus — use them as needed alongside this flow.

VariableRole
GATEWAY_URLProxy origin — where apps/SDKs send inference requests
GATEWAY_MASTER_URLAdmin origin — where backends call admin APIs
GATEWAY_MASTER_KEYA named Admin API Key created under System Integration → Integration Keysserver-side only; the environment-variable name can remain unchanged
  • Paths and payloads follow the current gateway release, including OpenAI-compatible Chat and Responses endpoints. Auth: Authorization: Bearer sk-….
  • Optional GET /v1/me on the Proxy with the user key returns budget-related summaries for your UI (fields vary by release).

Typical flow: after signup, your backend uses a named Integration Key to create or update gateway users and create API keys, then returns sk-… only to trusted environments or stores it server-side only.

Upgrades migrate the old MASTER_KEY value into a full-permission legacy-master key. Rotate or revoke it after external systems switch to named least-privilege keys.

API index: GitHub technical reference.