Create a response
Creates a streaming or non-streaming response using OpenResponses API format
Authentication
AuthorizationBearer
API key as bearer token in Authorization header
Request
This endpoint expects an object.
input
Input for a response request - can be a string or array of items
instructions
metadata
Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed.
tools
tool_choice
parallel_tool_calls
model
models
text
Text output configuration including format and verbosity
reasoning
Configuration for reasoning mode in the response
max_output_tokens
temperature
top_p
top_k
prompt_cache_key
previous_response_id
prompt
include
Allowed values:
background
safety_identifier
store
service_tier
truncation
stream
provider
When multiple model providers are available, optionally indicate your routing preference.
plugins
Plugins you want to enable for this request, including their settings.
user
A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 128 characters.
Response
Successful response
created_at
error
Error information returned from the API
id
incomplete_details
instructions
metadata
Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed.
model
object
Allowed values:
parallel_tool_calls
temperature
tool_choice
tools
top_p
background
max_output_tokens
max_tool_calls
output
output_text
previous_response_id
prompt
prompt_cache_key
reasoning
safety_identifier
service_tier
Allowed values:
status
store
text
Text output configuration including format and verbosity
top_logprobs
truncation
Allowed values:
usage
Token usage information for the response
user