Skip to main content

API reference (portal)

/developers/api is the in-app API reference: gateway endpoints with copy-paste examples. Any signed-in user can open it.

Open it from:

  • the sidebar, Build & monitor → API reference
  • the API reference button on API Keys
  • the key reveal page, which links here for operations without a test button

What it shows​

Endpoints lists the operations in this order, with the gateway API version:

OperationEndpoint
List modelsGET /v1/models
Chat completionsPOST /v1/chat/completions
ResponsesPOST /v1/responses
EmbeddingsPOST /v1/embeddings
Speech-to-textPOST /v1/audio/transcriptions
Text-to-speechPOST /v1/audio/speech
Realtime (voice)WebSocket /v1/realtime

For the selected operation the page shows the method and path, Auth (Bearer zea-…), where the Model goes (body, form field or ?model= query) and the Base URL. Realtime also shows the WebSocket URL.

Examples has curl, Python, Node and Environment variables tabs. Each example uses the portal's public gateway URL (ZEAGATE_PUBLIC_URL, see Environment variables) with placeholders zea-YOUR_KEY and YOUR_MODEL_GROUP. Copy copies the example.

Header actions​

  • Realtime docs opens the Realtime protocol page on this documentation site (NEXT_PUBLIC_DOCS_URL).
  • OpenAPI downloads the gateway's /openapi.json as zeallm-openapi.json.

Full reference​

The page is a quick reference. For request and response details see Gateway API, Chat, Embeddings, Audio, Realtime and SDK snippets.