Container Responses
Generate a model response from text or image inputs. Follows the OpenAI Responses API format, with support for streaming, function and custom tool calls, structured outputs, and reasoning controls.
stream option is set to true), the response is in MIME type text/event-stream. Otherwise, the content type is application/json.
You can view the schema of the streamed sequence of chunk objects in streaming mode here.
Body
Text or image inputs to the model, used to generate a response.
A system (or developer) message inserted into the model's context.
An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
Whether to allow the model to run tool calls in parallel.
An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.
- Function
- Custom
Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. An object can be used to force the model to call a specific function or custom tool.
none, auto, required Configuration options for a text response from the model. Can be plain text or structured JSON data.
Configuration options for reasoning models.
Whether to stream the generation result. When set to true, the response is sent as server-sent events once generated.
Routes the request to a specific adapter.
"(adapter-route)"
Response
Successfully generated a response.
Unique identifier for this response.
The object type of this resource - always set to response.
"response"Unix timestamp (in seconds) of when this response was created.
An array of content items generated by the model.
- Message
- Reasoning
- Function Tool Call
An error object returned when the model fails to generate a Response.
The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete.
completed, failed, in_progress, cancelled, queued, incomplete Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.
Details about why the response is incomplete.
Model ID used to generate the response.