Skip to main content

ResponsesFormat

POST /v1/responses

Request Parameters​

ParameterTypeRequiredDescription
modelstringRequired-
inputstring | array<object>OptionalInput content, can be a string or message array
instructionsstringOptional-
max_output_tokensintegerOptional-
temperaturenumberOptional-
top_pnumberOptional-
streambooleanOptional-
toolsarray<object>Optional-
tool_choicestring | objectOptional-
reasoningobjectOptional-
reasoning.effortstringOptional-
reasoning.summarystringOptional-
previous_response_idstringOptional-
truncationstringOptional-

Request Example​

{
"body": {
"model": "string"
}
}

Response Fields(200)​

Field NameTypeDescription
modelstring-
inputstring | array<object>p p-0 Input content, can be a string or message array
instructionsstring-
max_output_tokensinteger-
temperaturenumber-
top_pnumber-
streamboolean-
toolsarray<object>-
tool_choicestring | object-
reasoningobject-
reasoning.effortstring-
reasoning.summarystring-
previous_response_idstring-
truncationstring-