Skip to navigation

Relay a Grok GET: models, responses, files, batches

View as Markdown

GET /v1/models and GET /v1/models/{id} answer locally from the gateway’s six-model catalog. Every other admitted GET reads a stored Response, file, or batch you created through this gateway (including its bare list form, answered locally from the gateway’s ownership records), or resolves a deferred-completion request_id via GET /v1/chat/deferred-completion/{id}; an id you don’t own answers the same anonymous 404 as an id that never existed.

Authentication

AuthorizationBearer

Your per-client bearer token — the API key the gateway issued to you. Present it in Authorization: Bearer <token> form. A token that is missing, unknown, or revoked draws a 401. Before the call is sent upstream the token is removed (stripped, or swapped for the upstream’s own credential); it never makes it past the gateway.

Path parameters

pathstringRequired

The path to call on xAI’s Grok API, any further / segments included — all of it after /grok/ is passed to https://api.x.ai/ when the gateway’s model catalog and endpoint/field policy admit the request (see the Grok tag description above). Examples: v1/chat/completions, v1/chat/deferred-completion/{id}, v1/responses, v1/responses/compact, v1/tokenize-text, v1/models, v1/models/{model}, v1/files, v1/files/{id}, v1/batches, v1/batches/{id}.

Response

Whatever the upstream answered, relayed as-is (status, headers, body). Rendered here as JSON; the true shape is the upstream provider’s to define.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error