API endpoint
Errors
Every error shape the endpoint returns, and the failures that are not errors.
Errors follow the OpenAI JSON shape: a body of
{"error": {"message", "type", "param", "code"}}.
| Status | When | What to do |
|---|---|---|
401 | Missing or invalid API key ("Authentication Error, No api key passed in.") | Check the Authorization: Bearer header and the key value |
400 | Invalid request: malformed JSON ("Invalid JSON payload"), a missing required parameter ("Missing required parameter: 'messages'"), or an unaccepted reasoning_effort ("Unexpected reasoning effort") | Fix the request; for effort, only low, medium, xhigh and {"enable_thinking": false} are accepted; high is not |
403 | Model not available to your key ("key not allowed to access model"; the message lists the models you can access) | Use a model from GET /v1/models; the list is filtered per key |
No rate-limit responses are currently issued on the evaluation deployment. The 400-concurrent-requests figure in the quick start is an operational ceiling to respect, not an enforced limit.
Failures that do not return an error
Two failure modes arrive as HTTP 200 and need client-side checks:
- Capped output with reasoning on:
finish_reason: "length"with truncated (sometimes empty)content. Checkfinish_reasonon every response if you pass a token cap at all; better, do not cap (see the client configuration advice). - Client timeout: your SDK aborts a request the endpoint was still serving. This surfaces as a client-side exception, not an endpoint error; set the timeout to at least 600 seconds.
When reporting a problem
Include the id field from the failing response (for example
chatcmpl-...); it lets support find the exact request.