← All docs

POST /v1/responses

OpenAI Responses-compatible shim, including background job polling and cancellation.

OpenAI Responses compatible — a shim that converts the request into a chat request internally. Anything like previous_response_id is stateful storage, which is not supported.

Parameters

ParameterTypeRequiredDescription
modelstringYesModel ID
inputstring | arrayYesA string, or an array of message / function_call / function_call_output items
instructionsstringNosystem instructions
max_output_tokensintegerNoMaximum output tokens
temperaturenumberNo0–2
top_pnumberNo0–1
streambooleanNoStream events token by token
backgroundbooleanNoIf true, submits as an async job and returns queued immediately
tools / tool_choicearray / string|objectNoSame format as chat
reasoning_effortstringNonone / low / medium / high
userstringNoEnd-user identifier
everyaisobjectNoGateway caching options

Request

{
  "model": "everyais/claude-opus-5",
  "input": "Hello!",
  "instructions": "Be concise."
}

GET /v1/responses/{id}

Poll the status of a job submitted with background: true.

{
  "id": "resp_abc123",
  "object": "response",
  "created_at": 1709884800,
  "model": "everyais/claude-opus-5",
  "status": "queued",
  "output": [],
  "error": null,
  "incomplete_details": null,
  "usage": null
}

status transitions queuedin_progresscompleted / incomplete / failed / cancelled. Once it completes, the full stored Response body is returned.

Returns 404 if the job does not exist, has expired, or belongs to another key or user.

POST /v1/responses/{id}/cancel

Transitions a job in queued or in_progress state to cancelled and refunds the reserved credit. A job that has already finished is returned as its current Response with no status change.