Responses API
Create a model response through a Responses API-compatible format. input can be a string or a message array. For multi-turn context, pass the previous response previous_response_id, or pass messages, reasoning items, or tool call items from the previous output back into input.
Public fields: model, input, instructions, previous_response_id, conversation, stream, store, tools, tool_choice, temperature, top_p, enable_thinking, reasoning, and ocr_options. Whether a field takes effect depends on the model and upstream provider capabilities.
Authorizations
Pass Authorization: Bearer <token> in the request header.
Headers
Optional upstream session cache switch. It only takes effect when the current model and upstream provider support it.
enable Body
Model name. Use a model that is publicly exposed by the platform API and supports the Responses API. Whether a model supports tools, OCR, or thinking mode depends on the current provider channel.
MiniMax-M2.5, MiniMax-M2.5-highspeed, MiniMax-M2.7, MiniMax-M2.7-highspeed, MiniMax-M3, qwen3-coder-plus, qwen3-max, qwen3.5-flash, qwen3.6-plus, deepseek-v3-2-251201, seed-1-6-250915, seed-1-6-flash-250715, seed-1-8-251228, seed-2-0-lite-260228, seed-2-0-mini-260215, seed-2-0-pro-260328 "qwen3.6-plus"
Model input. Pass a plain text string or a message array arranged in conversation order. For multi-turn tool calls, pass back message, function_call, function_call_output, or reasoning items from the previous response.
System instructions inserted at the start of the context. When you use previous_response_id, the previous turn's instructions are not automatically passed into this turn.
The previous response id. Use it to create a multi-turn conversation. The server combines the previous input and output as context. Do not use it together with conversation.
Conversation ID for the current response. Conversation history is passed as context, and this input and output are added to the conversation after the response completes. Do not use it together with previous_response_id.
Whether to enable streaming output. When set to true, the endpoint returns an SSE event stream.
Whether to store this response. When set to false, this response cannot be used later as context through previous_response_id.
Array of tools the model can call while generating the response. You can mix built-in tools and custom function tools. Whether a tool takes effect depends on model and upstream provider support.
- Option 1
- Option 2
- Option 3
- Option 4
Controls how the model chooses tools. String mode supports auto, none, and required; object mode restricts the model to a given tool list.
auto, none, required Sampling temperature. It controls output randomness. Avoid setting both temperature and top_p.
0 <= x < 2Nucleus sampling probability threshold. It controls output diversity. Avoid setting both temperature and top_p.
0 < x <= 1Whether to enable thinking mode. This is not a standard OpenAI field; prefer reasoning.effort instead.
Controls the model thinking effort. When set, the model may generate reasoning output items before the reply.
Custom OCR task parameters. Use only with models that support OCR. The custom task result is returned through ocr_result in the response content.
Response
The call succeeded. Non-streaming mode returns a complete Response object; streaming mode returns an SSE event stream.
Unique identifier for this response. It can be used as previous_response_id.
Unix timestamp for this request, in seconds.
Fixed to response.
response Response generation status.
completed, failed, in_progress, cancelled, queued, incomplete Model ID used to generate the response.
Array of output items generated by the model. Item types and order depend on the model response and tool calls.
- Option 1
- Option 2
- Function call
- Option 4
- Option 5
- Option 6
Whether tools are called in parallel.
Echoes the tool choice strategy from the request.
Echoes the tool configuration from the request.
- Option 1
- Option 2
- Option 3
- Option 4
Token usage statistics. When tools, cache, OCR, or multimodal input are enabled, extra detail fields may be returned.
Error object when generation fails; usually null on success.