Skip to main content
POST

OpenAI Multimodal Responses API

The Responses API is a unified response interface for multimodal workflows, tool calling, and context continuation. Compared with Chat Completions, its input, output, and tool-calling structure is better suited for complex task orchestration.

Request Body

string
required
Model name.
string | array<object>
User input. Can be a string or a structured message array.
string
Developer or system-level instructions.
string
The ID of the previous response. Can be used for context continuation when supported by the upstream.
array<object>
Tool list. Supports function tools, and can also forward upstream-compatible built-in tools.
string | object
Tool selection strategy.
integer
Maximum number of output tokens. Explicitly passing 0 will be preserved and forwarded to supported upstreams.
object
Reasoning configuration, for example { "effort": "medium", "summary": "auto" }.
object
Text output configuration, commonly used for JSON Schema structured output.
boolean
Whether to enable SSE streaming output.
boolean
Whether to include token usage in streaming responses.
boolean
Controls whether the upstream stores the request and response. This field is allowed to be forwarded by default, and can be disabled by channel settings.
object
Additional business-side metadata.
array<string>
Additional fields to include in the request response; the specific values depend on the upstream implementation.

Request Example

Multimodal Input

Tool Calling

Streaming Output

Response Example

Context Compression

Used to compress a long context into a summary suitable for continuing the conversation later. The request structure is similar to /v1/responses, and the commonly used fields are model, input, instructions, and previous_response_id.