Create a chat completion

Part of Gateway, 7 operations. The overview covers keys, scopes and errors.

POST /v1/chat/completions

OpenAI Chat Completions: passed through to your own vendor key, transcoded, or answered by your agent (model: "superbot"). A request that declares its own tools, the way Codex, Claude Code and Cursor do, is answered by the superbot model driving those tools: its tool calls come back in your dialect for your client to run. So is a call that caps its reply at 512 tokens or fewer, and a call that asks for structured output (a JSON object or a JSON schema), whose reply is the model’s output alone. Any other request is answered by your agent, and outside superbot’s own apps a card it draws comes back as plain markdown: a choice as a list, sources as a Sources: list. When the agent answers with files (a generated picture, sound or clip, a document), the reply carries them beside the text as a top-level superbot_assets array of {name, mime, size, url} (a streamed reply sends it on its last chunk before [DONE]), only for a caller that draws no cards and only when there are files; the text is unchanged. The url is a durable public link for a zapier/ or n8n/ client (x-superbot-client) and the artifact’s signed link (valid 24 hours) for any other caller. When your agent answers, its server-side memory is kept per conversation: name one with the x-superbot-session header, or superbot reads the id your client sends (prompt_cache_key, metadata.session_id, metadata.conversation_id, a Responses conversation or an Anthropic metadata.user_id), else it keys the conversation on its first message.

A caller key holding gateway:invoke (Authorization: Bearer sbc_… or x-api-key: sbc_…).

Operation id createChatCompletion in Gateway.

Header parameters

x-superbot-route string optional
Override the key’s route for this request. One of byo, credits, auto.
x-superbot-mode string optional
Override the key’s mode for this request. One of model, agent.
x-superbot-engine string optional
Run the agent lane on your computer (omni). One of omni.
x-superbot-session string optional
Names the server-side conversation your agent continues: letters, digits, _ and -, at most 59 characters.
x-superbot-callback-url string optional
An https URL (a Zapier catch hook, an n8n webhook node). The call is accepted at once with 202 {session, request_id}, the turn runs, and when it settles Superbot POSTs {session, request_id, status, text} to this URL (status is done or error; an error also carries error: {code, message}; a turn that made files also carries assets, the same list as the reply’s superbot_assets). The URL is a secret: it is stored sealed, never logged, and forgotten once delivered. A 2xx from your URL ends the delivery; a network error, 408, 429 or 5xx is retried (1 s, 5 s, 30 s, 2 min, 10 min). Each delivery carries x-superbot-event: turn.settled and a stable x-superbot-delivery id. Every refusal a plain call gets (401, 402, 403, 429, a bad body) is still answered synchronously and starts no turn. The reply is the non-streamed one whatever stream says. Name the thread with x-superbot-session to continue it; a key holding turns:read reads the same turn back at GET /v1/turns/{session}?request={request_id}.
Prefer string optional
respond-async (RFC 7240) starts the turn and answers 202 {session, request_id} with Preference-Applied: respond-async as soon as it is accepted; nothing is delivered, so read the result by polling GET /v1/turns/{session}?request={request_id} (or re-attach at /stream) with turns:read. The turn runs on whether or not you stay connected. It applies to the agent (the default for model: superbot); on a call that dials a model directly the preference is ignored, the call is answered as usual and the response carries no Preference-Applied. With x-superbot-callback-url too, the callback form is used. Every refusal a plain call gets is still answered synchronously and starts no turn. The reply is the non-streamed one whatever stream says.

Request body

application/json, required.

An OpenAI Chat Completions request body.

model string required

Body reference: OpenAI Chat Completions reference.

Response 200

The answer in the dialect you dialed; streamed as server-sent events when the body asks for stream: true.

application/json: object.

text/event-stream: string.

Response 202

Only with x-superbot-callback-url or Prefer: respond-async: the call was accepted and the turn is running. With the callback header the result is POSTed to that URL when it settles; with Prefer: respond-async alone nothing is delivered and the caller polls. session and request_id read it back with turns:read. Preference-Applied: respond-async names the preference whenever the call asked for it.

application/json: TurnCallbackAccepted.

session string required
The conversation the turn runs in: what x-superbot-session named, else the id the gateway derived.
request_id string required
The turn’s id (also the response’s x-request-id): the request of GET /v1/turns/{session}.

Errors

Status	Code	What to change
400	`invalid_request`	A parameter or body field is invalid; `param` names it and `issues` lists every problem.
401	`unauthorized`	Send a live caller key or session as `Authorization: Bearer …` or `x-api-key`. No key yet: create one at /account/api, or sign a user in at /auth.md.
402	`byo_url`	The key’s budget or your credits are spent (`byo_url` on the body).
403	`insufficient_scope`	The key lacks the scope in `required_scopes`; mint a key that holds it.
403	`model_not_allowed`	Revoked · insufficient_scope · model_not_allowed · no_vendor_credential · no_custom_upstream. A 403 that carries `x-superbot-error-origin: vendor` is your vendor credential’s refusal, not the gateway’s.
403	`no_vendor_credential`	Revoked · insufficient_scope · model_not_allowed · no_vendor_credential · no_custom_upstream. A 403 that carries `x-superbot-error-origin: vendor` is your vendor credential’s refusal, not the gateway’s.
403	`no_custom_upstream`	Revoked · insufficient_scope · model_not_allowed · no_vendor_credential · no_custom_upstream. A 403 that carries `x-superbot-error-origin: vendor` is your vendor credential’s refusal, not the gateway’s.
429	`rate_limited`	Over the per-key request bucket; retry after `x-ratelimit-reset`.
499		The caller hung up; the agent turn keeps running.
5XX		The upstream’s own status, rendered in your dialect. When a status is your own vendor credential’s answer (a BYO or custom-endpoint dial) the response carries `x-superbot-error-origin: vendor` and `error.origin: "vendor"` with `error.vendor_status`; a refusal without them is the gateway’s own.

view .md openapi

Request

curl

curl -sS -X POST "https://superbot.gg/v1/chat/completions" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"model":"superbot"}'

JavaScript

const res = await fetch(`https://superbot.gg/v1/chat/completions`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
    'content-type': 'application/json',
  },
  body: JSON.stringify({"model":"superbot"}),
});
console.log(res.status, await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://superbot.gg/v1/chat/completions",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
        "content-type": "application/json",
    },
    json={"model":"superbot"},
)
print(res.status_code, res.json())

Response

200 The answer in the dialect you dialed; streamed as server-sent events when the body asks for `stream: true`.

{}

202 Only with `x-superbot-callback-url` or `Prefer: respond-async`: the call was accepted and the turn is running. With the callback header the result is POSTed to that URL when it settles; with `Prefer: respond-async` alone nothing is delivered and the caller polls. `session` and `request_id` read it back with `turns:read`. `Preference-Applied: respond-async` names the preference whenever the call asked for it.

{
  "session": "your-session",
  "request_id": "your-request-id"
}

400 The body is not JSON or the dialect refused it.

"string"

401 Missing, malformed or unknown key. A 401 that carries `x-superbot-error-origin: vendor` is your vendor credential’s refusal, not the gateway’s.

"string"

402 The key’s budget or your credits are spent (`byo_url` on the body).

"string"

403 Revoked · insufficient_scope · model_not_allowed · no_vendor_credential · no_custom_upstream. A 403 that carries `x-superbot-error-origin: vendor` is your vendor credential’s refusal, not the gateway’s.

"string"

429 Over the per-key request bucket. A 429 that carries `x-superbot-error-origin: vendor` is your vendor’s rate limit, not the gateway’s.

"string"

499 The caller hung up; the agent turn keeps running.

(no body)

5XX The upstream’s own status, rendered in your dialect. When a status is your own vendor credential’s answer (a BYO or custom-endpoint dial) the response carries `x-superbot-error-origin: vendor` and `error.origin: "vendor"` with `error.vendor_status`; a refusal without them is the gateway’s own.

"string"