API Referencebeta.responses

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.
inputobjectOptional
instructionsstring or nullOptional
metadatamap from strings to stringsOptional

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.

toolslist of maps from strings to any or objectsOptional
tool_choiceenum or object or map from strings to anyOptional
Controls which tool the model should call
parallel_tool_callsboolean or nullOptional
modelstringOptional
modelslist of stringsOptional
textobjectOptional
Text output configuration including format and verbosity
reasoningobjectOptional
Configuration for reasoning mode in the response
max_output_tokensdouble or nullOptional
temperaturedouble or nullOptional>=0<=2
top_pdouble or nullOptional>=0
top_kdoubleOptional
prompt_cache_keystring or nullOptional
previous_response_idstring or nullOptional
promptobjectOptional
Prompt template with variables for the response
includelist of enums or nullOptional
Allowed values:
backgroundboolean or nullOptional
safety_identifierstring or nullOptional
storeboolean or nullOptional
service_tierenumOptional
Allowed values:
truncationenumOptional
Allowed values:
streamboolean or nullOptional
providerobject or nullOptional
When multiple model providers are available, optionally indicate your routing preference.
pluginslist of objectsOptional
Plugins you want to enable for this request, including their settings.
userstringOptional<=128 characters

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
objectenum
Allowed values:
created_atdouble
modelstring
outputlist of maps from strings to any
errorobject
Error information returned from the API
incomplete_detailsobject or null
temperaturedouble or null
top_pdouble or null
instructionsstring or list of objects or maps from strings to any or any

Input for a response request - can be a string or array of items

metadatamap from strings to strings

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.

toolslist of maps from strings to any or objects
tool_choiceenum or object or map from strings to any
Controls which tool the model should call
parallel_tool_callsboolean
idstring or null
statusenum or null
userstring or null
output_textstring or null
prompt_cache_keystring or null
safety_identifierstring or null
usageobject or null
Token usage information for the response
max_tool_callsdouble or null
top_logprobsdouble or null
max_output_tokensdouble or null
promptobject or null
Prompt template with variables for the response
backgroundboolean or null
previous_response_idstring or null
reasoningobject or null
Configuration for reasoning mode in the response
service_tierenum or null
Allowed values:
storeboolean or null
truncationenum or null
Allowed values:
textobject or null
Text output configuration including format and verbosity