Skip to main content
POST
The Responses API is OpenAI’s newer agentic API. Compared with Chat Completions, it adds richer tool use and server-side conversation state.
  • Function calling: let models call custom functions
  • Built-in tools: use tools such as web_search_preview
  • Server-side context: use previous_response_id instead of resending the full conversation
  • Reasoning control: tune thinking depth with reasoning.effort
Models marked as Responses Only, such as gpt-5-pro-official and gpt-5.3-codex-official, only support this API and do not support Chat Completions. See the model list for details.

Authorizations

string
required
Use Bearer Token authentication.
Get your API key from the API Key management page.

Body

string
required
Model name.Examples: "gpt-5-pro-official", "gpt-5.3-codex-official", "gpt-5.2-official"
string | object[]
required
User input. Supports simple string input or a message array for multi-turn conversations.
string
System instructions that guide model behavior.
boolean
default:false
Whether to enable streaming output.
integer
Maximum number of output tokens.
number
default:1
Sampling temperature, from 0 to 2.
number
default:1
Nucleus sampling threshold, from 0 to 1.
string
Previous response ID for server-side multi-turn context.
object
Reasoning configuration. reasoning.effort can be high, medium, low, or none.
object[]
Available tools. Supported tool types include function and web_search_preview.
string
default:"auto"
Tool selection policy: auto, none, or required.

Response

string
Unique response ID, usable as previous_response_id.
string
Always response.
string
Response status: completed, failed, or in_progress.
object[]
Output items, such as message, function_call, reasoning, or web_search_call.
object
Token usage statistics, including input, output, reasoning, and total tokens.