Appearance
response
POST
/v1/responses
Authorizations
bearer
TypeHTTP (bearer)
Request Body
application/json
JSON
{
"metadata": {
"additionalProperties": "string"
},
"temperature": 1,
"top_p": 1,
"user": "user-1234",
"service_tier": "auto",
"previous_response_id": "string",
"model": "string",
"reasoning": {
"effort": "medium",
"summary": "string",
"generate_summary": "string"
},
"max_output_tokens": 0,
"instructions": "string",
"text": {
"format": {
"type": "string"
}
},
"tools": [
{
"type": "file_search",
"vector_store_ids": [
"string"
],
"max_num_results": 0,
"ranking_options": {
"ranker": "string",
"score_threshold": 0
},
"filters": null
}
],
"tool_choice": "string",
"truncation": "disabled",
"input": "string",
"include": [
"string"
],
"parallel_tool_calls": true,
"store": true,
"stream": false
}
Responses
OK
application/json
JSON
{
"metadata": {
"additionalProperties": "string"
},
"temperature": 1,
"top_p": 1,
"user": "user-1234",
"service_tier": "auto",
"previous_response_id": "string",
"model": "string",
"reasoning": {
"effort": "medium",
"summary": "string",
"generate_summary": "string"
},
"max_output_tokens": 0,
"instructions": "string",
"text": {
"format": {
"type": "string"
}
},
"tools": [
{
"type": "file_search",
"vector_store_ids": [
"string"
],
"max_num_results": 0,
"ranking_options": {
"ranker": "string",
"score_threshold": 0
},
"filters": null
}
],
"tool_choice": "string",
"truncation": "disabled",
"id": "string",
"object": "string",
"status": "string",
"created_at": 0,
"error": {
"code": "string",
"message": "string"
},
"incomplete_details": {
"reason": "string"
},
"output": [
{
"id": "string",
"type": "string",
"role": "string",
"content": [
{
"type": "output_text",
"text": "string",
"annotations": [
{
"type": "file_citation",
"file_id": "string",
"index": 0
}
]
}
],
"status": "string"
}
],
"output_text": "string",
"usage": {
"input_tokens": 0,
"input_tokens_details": {
"cached_tokens": 0
},
"output_tokens": 0,
"output_tokens_details": {
"reasoning_tokens": 0
},
"total_tokens": 0
},
"parallel_tool_calls": true
}