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.
inputstring or list of objectsOptional

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

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 objectOptional
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
includelist of enums or nullOptional
Allowed values:
backgroundboolean or nullOptional
safety_identifierstring or nullOptional
storeboolean or nullOptional
service_tierobjectOptional
truncationobjectOptional
streambooleanOptionalDefaults to false
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
created_atdouble
errorobject
Error information returned from the API
idstring
incomplete_detailsobject
instructionsstring or list of objects or any
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.

modelstring
objectenum
Allowed values:
parallel_tool_callsboolean
temperaturedouble or null
tool_choiceenum or object
toolslist of maps from strings to any or objects
top_pdouble or null
backgroundboolean or null
max_output_tokensdouble or null
max_tool_callsdouble or null
outputlist of objects or null
output_textstring or null
previous_response_idstring or null
promptobject or null
prompt_cache_keystring or null
reasoningobject or null
safety_identifierstring or null
service_tierenum or null
Allowed values:
statusenum or null
storeboolean or null
textobject or null
Text output configuration including format and verbosity
top_logprobsdouble or null
truncationenum or null
Allowed values:
usageobject or null
Token usage information for the response
userstring or null

Errors