Skip to main content
POST
Create Response
This endpoint requires an enabled model. It supports a stateless subset of the Responses protocol. Send the complete history with each request and use store:false. See compatibility and tool replay.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
model
string
required
Minimum string length: 1
input
required
instructions
string | null
stream
boolean
default:false
store
boolean | null
default:false
background
boolean | null
default:false
previous_response_id
string | null
conversation
any
tools
Tools · object[]
Maximum array length: 128
tool_choice
default:auto
Available options:
auto,
none,
required
parallel_tool_calls
boolean
default:true
reasoning
ResponsesReasoning · object | null
text
ResponsesText · object | null
max_output_tokens
integer | null
Required range: x >= 1
temperature
number | null
Required range: 0 <= x <= 2
top_p
number | null
Required range: 0 <= x <= 1
top_k
integer | null
Required range: x >= -1
frequency_penalty
number | null
Required range: -2 <= x <= 2
presence_penalty
number | null
Required range: -2 <= x <= 2
top_logprobs
integer | null
Required range: 0 <= x <= 20
include
string[]
metadata
Metadata · object | null
client_metadata
any
user
string | null
safety_identifier
string | null
prompt_cache_key
string | null
service_tier
enum<string> | null
Available options:
auto,
default,
flex,
priority,
scale
truncation
enum<string> | null
default:disabled
Available options:
disabled,
auto

Response

Response JSON, or ordered Responses SSE events when stream=true. No [DONE] sentinel.

id
string
required
created_at
integer
required
model
string
required
status
enum<string>
required
Available options:
in_progress,
completed,
incomplete,
failed
object
string
default:response
Allowed value: "response"
completed_at
integer | null
output
Output · object[]
error
Error · object | null
incomplete_details
Incomplete Details · object | null
usage
ResponsesUsage · object | null
store
boolean
default:false
background
boolean
default:false
previous_response_id
null
instructions
string | null
max_output_tokens
integer | null
parallel_tool_calls
boolean
default:true
tool_choice
any
tools
Tools · object[]
text
Text · object | null
reasoning
Reasoning · object | null
temperature
number | null
top_p
number | null
truncation
string
default:disabled
Allowed value: "disabled"
service_tier
string
default:default
Allowed value: "default"
metadata
Metadata · object