Create OpenResponse
OpenResponses endpoint backed by Arrow. The endpoint is stateless: previous_response_id may only be null and store may only be false, so a prior turn is continued by replaying it in input. Caller-declared function and custom tools are returned as function_call and custom_tool_call output items for the caller to execute and replay. Streaming ends with the literal [DONE] transport sentinel.
/v1/responsesAuthorizationBearer token · headerrequiredAuthentication via Bearer token API key
x-trace-idstringOptional client-supplied trace identifier. The API echoes this value in X-Trace-ID and includes it in request logs for client-side correlation.
application/jsonbackgroundbooleanThe endpoint answers inline and never queues a background response, so background may only be false. Omitting it means the same thing. Unlike the upstream contract this is not nullable, because a response resource types background as false and a null echoed back would fail response validation.
falsefrequency_penaltynumber | nullincludestring[] | nullThe endpoint returns no additional response content, so include may only be the empty array or null. Omitting it means the same thing. reasoning.encrypted_content is refused because encrypted reasoning is not part of the public contract.
inputstring | object[] | anyShow propertiesHide properties
stringobjectcontentstring | object[]requiredShow propertiesHide properties
stringobjecttextstringrequiredtypestringrequiredinput_textdetailstring | nulllowhighautooriginalnullfile_idstring | nullimage_urlstring | nullrefstring | nulltypestringrequiredinput_imagedetailstring | nullautolowhighnullfile_datastring | nullfile_idstring | nullfile_urlstring | nullfilenamestring | nulltypestringrequiredinput_fileannotationsobject[] | nulltextstringrequiredtypestringrequiredoutput_textrefusalstringrequiredtypestringrequiredrefusalidstring | nullphasestring | nullcommentaryfinal_answernullrolestringrequiredassistantdevelopersystemuserstatusstring | nullin_progresscompletedincompletenulltypestringmessageargumentsstringcall_idstringrequiredidstring | nullnamestringrequiredstatusstring | nullin_progresscompletedincompletenulltypestringrequiredfunction_callcall_idstringrequiredidstring | nulloutputstring | object[]requiredShow propertiesHide properties
stringobjecttextstringrequiredtypestringrequiredinput_textdetailstring | nulllowhighautooriginalnullfile_idstring | nullimage_urlstring | nullrefstring | nulltypestringrequiredinput_imagedetailstring | nullautolowhighnullfile_datastring | nullfile_idstring | nullfile_urlstring | nullfilenamestring | nulltypestringrequiredinput_filetypestringrequiredinput_videovideo_urlstringrequiredstatusstring | nullin_progresscompletedincompletenulltypestringrequiredfunction_call_outputcall_idstringrequiredidstring | nullinputstringnamestringrequiredstatusstring | nullin_progresscompletedincompletenulltypestringrequiredcustom_tool_callcall_idstringrequiredidstring | nulloutputstring | object[]requiredShow propertiesHide properties
stringobjecttextstringrequiredtypestringrequiredinput_textstatusstring | nullin_progresscompletedincompletenulltypestringrequiredcustom_tool_call_outputcontentanyencrypted_contentstring | nullidstring | nullstatusstring | nullin_progresscompletedincompletenullsummaryobject[] | nullShow propertiesHide properties
objecttextstringrequiredtypestringsummary_texttypestringreasoningrolestring | nulldevelopersystemusernulltoolsobject[]typestringrequiredadditional_toolsidstringrequiredtypestring | nullitem_referenceanyinstructionsstring | nullmax_output_tokensinteger | nullmax_tool_callsinteger | nullmetadataobject | nullmodelstringrequiredparallel_tool_callsboolean | nullpresence_penaltynumber | nullprevious_response_idanyThe endpoint is stateless and holds no prior response to continue from; only null is accepted. Continue a conversation by replaying the earlier items in input.
prompt_cache_keystring | nullreasoningobject | nullShow propertiesHide properties
effortstring | nulllowmediumhighxhighnullsummarystring | nullautoconcisedetailednullsafety_identifierstring | nullservice_tierstringautodefaultflexprioritystorebooleanThe endpoint is stateless and never persists a response, so store may only be false. Omitting it means the same thing.
falsestreambooleanstream_optionsobject | nullShow propertiesHide properties
include_obfuscationbooleantemperaturenumber | nulltextobject | nullShow propertiesHide properties
formatobject | nullShow propertiesHide properties
typestringtextverbositystringlowmediumhightool_choicestring | object | anyShow propertiesHide properties
stringnamestringrequiredtypestringrequiredfunctionnamestringrequiredtypestringrequiredcustommodestringautononerequiredtoolsobject[]requiredShow propertiesHide properties
objectnamestringrequiredtypestringrequiredfunctionnamestringrequiredtypestringrequiredcustomtypestringrequiredallowed_toolsanytoolsobject[] | nullShow propertiesHide properties
objectdescriptionstring | nullnamestringrequiredparametersobject | nullstrictbooleantypestringrequiredfunctiondescriptionstring | nullformatobject | anyShow propertiesHide properties
typestringtextdefinitionstringrequiredsyntaxstringrequiredlarkregextypestringrequiredgrammaranynamestringrequiredtypestringrequiredcustomtop_logprobsinteger | nulltop_pnumber | nulltruncationstringautodisabledOpenResponses-compatible ResponseResource returned by the upstream inference service.
backgroundbooleanrequiredfalsecompleted_atinteger | nullrequiredcreated_atintegerrequirederrorobject | nullrequiredShow propertiesHide properties
codestringrequiredShow propertiesHide properties
stringstringmessagestringrequiredquiver_codestring | nullinvalid_requestmodel_not_foundunsupported_animation_requestimage_dimensions_too_largemissing_reference_imagetoo_many_reference_imagestoo_many_subjectsartwork_ids_mismatchinvalid_image_urlimage_url_restrictedimage_url_unresolvedimage_fetch_failedimage_payload_too_largeinvalid_image_payloadunsupported_image_referenceinvalid_svg_sourcesvg_too_largecontent_policy_violationrate_limitedrequest_timeoutupstream_errorinternal_errornullreasonstring | nullmax_tool_callstool_failurerequired_tool_missingprovider_incompletenullstatus_codeinteger | nulltypestring | nullinvalid_request_errorfrequency_penaltynumberrequiredidstringrequiredincomplete_detailsobject | nullrequiredShow propertiesHide properties
codestring | nullinvalid_requestmodel_not_foundunsupported_animation_requestimage_dimensions_too_largemissing_reference_imagetoo_many_reference_imagestoo_many_subjectsartwork_ids_mismatchinvalid_image_urlimage_url_restrictedimage_url_unresolvedimage_fetch_failedimage_payload_too_largeinvalid_image_payloadunsupported_image_referenceinvalid_svg_sourcesvg_too_largecontent_policy_violationrate_limitedrequest_timeoutupstream_errorinternal_errornullmessagestring | nullreasonstringrequiredcontent_filtermax_output_tokensstatus_codeinteger | nullinstructionsstring | nullrequiredmax_output_tokensinteger | nullrequiredmax_tool_callsinteger | nullrequiredmetadataobjectrequiredmodelstringrequiredobjectstringrequiredresponseoutputobject[]requiredShow propertiesHide properties
objectargumentsstringcall_idstringrequiredidstringrequirednamestringrequiredstatusstringcompletedincompletetypestringfunction_callcall_idstringrequiredidstringrequiredinputstringnamestringrequiredstatusstringcompletedincompletetypestringcustom_tool_callcall_idstringrequiredidstringrequiredoutputstringrequiredstatusstringcompletedtypestringfunction_call_outputencrypted_contentstring | nullidstringrequiredstatusstringcompletedsummaryobject[]requiredShow propertiesHide properties
objecttextstringrequiredtypestringsummary_texttypestringreasoningcontentobject[]requiredShow propertiesHide properties
objectannotationsobject[]logprobsobject[]textstringrequiredtypestringoutput_textidstringrequiredphasestringcommentaryfinal_answerrolestringassistantstatusstringcompletedtypestringmessageparallel_tool_callsbooleanrequiredpresence_penaltynumberrequiredprevious_response_idstring | nullrequiredThe endpoint is stateless and holds no prior response to continue from. Continue a conversation by replaying the earlier items in input.
prompt_cache_keystring | nullrequiredreasoningobjectrequiredShow propertiesHide properties
effortstring | nulllowmediumhighxhighnullsummarystring | nullautoconcisedetailednullsafety_identifierstring | nullrequiredservice_tierstringrequiredautodefaultflexprioritystatusstringrequiredcompletedincompletefailedstorebooleanrequiredThe endpoint is stateless and never persists a response.
temperaturenumberrequiredtextobjectrequiredShow propertiesHide properties
formatobject | nullShow propertiesHide properties
typestringtextverbositystringlowmediumhightool_choicestring | objectrequiredShow propertiesHide properties
stringnamestringrequiredtypestringrequiredfunctionnamestringrequiredtypestringrequiredcustommodestringautononerequiredtoolsobject[]requiredShow propertiesHide properties
objectnamestringrequiredtypestringrequiredfunctionnamestringrequiredtypestringrequiredcustomtypestringrequiredallowed_toolstoolsobject[]requiredShow propertiesHide properties
objectdescriptionstring | nullnamestringrequiredparametersobject | nullstrictbooleantypestringrequiredfunctiondescriptionstring | nullformatobject | anyShow propertiesHide properties
typestringtextdefinitionstringrequiredsyntaxstringrequiredlarkregextypestringrequiredgrammaranynamestringrequiredtypestringrequiredcustomtop_logprobsintegerrequiredtop_pnumberrequiredtruncationstringrequiredautodisabledusageobject | nullrequiredShow propertiesHide properties
input_tokensintegerrequiredinput_tokens_detailsobjectrequiredShow propertiesHide properties
cache_write_tokensintegerrequiredcached_tokensintegerrequiredoutput_tokensintegerrequiredoutput_tokens_detailsobjectrequiredShow propertiesHide properties
reasoning_tokensintegerrequiredtotal_tokensintegerrequiredBad request – malformed body, missing required fields, or invalid parameter values.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredUnauthorized – missing, malformed, revoked, otherwise invalid API credentials, or an organization that could not be resolved for billing.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredPayment required – the organization has insufficient credits, or a funding payment has not settled.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredForbidden – the account is frozen, the request is not allowed, or content policy rejected the request.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredNot found – the requested model does not exist, or the endpoint path and method are not served.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredRequest timeout – the request exceeded an allowed client-facing deadline.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredPayload too large – the request input is too large.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredUnsupported media type – the request body arrived without a JSON Content-Type, so it could not be read.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredRate limit exceeded – request throughput or measured input/output token usage exhausted a binding ceiling. operation_rate_limit_exceeded identifies operation throughput; rate_limit_exceeded covers overall request and token rates. X-RateLimit-Dimension names the exact dimension. When Retry-After is present, retry after the indicated period.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredThe request could not be completed. Please retry.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredBad gateway – model execution returned an invalid or failed response.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredService unavailable – model execution is temporarily unavailable.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequiredGateway timeout – model execution exceeded the server deadline.
codestringrequiredinvalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailablemessagestringrequiredparamstringThe request parameter the failure is about, as a path from the request body root: size.width, input[0].content. A parameter name, never a submitted value. The same field, with the same meaning, as param on the Open Responses error payload, so one name reads across a failure raised before streaming and one raised during it. Absent, rather than null, when the failure is not about one particular parameter.
request_idstringrequiredretry_afterintegerstatusintegerrequired