Skip to content
8080
Home Docs Blog
GitHub Login

Create a response

POST
/v1/responses

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
model
required
string
background
boolean
conversation
One of:
string
include
Array<string>
Allowed values: code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content
input
One of:
string
instructions
string
max_output_tokens
integer
max_tool_calls
integer
metadata
object
key
additional properties
any
parallel_tool_calls
boolean
previous_response_id
string
reasoning
object
effort
string
Allowed values: minimal medium high
generate_summary
string
summary
string
service_tier
string
Allowed values: auto default flex scale priority
store
boolean
stream
boolean
temperature
number format: double
text
object
format
object
type
required
string
Allowed values: text json_object json_schema
name
string
schema
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object
key
additional properties
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object recursive
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
description
string
strict
boolean
verbosity
string
Allowed values: low medium high
tool_choice
One of:
string
Allowed values: auto none required
tools
Array<object>
object
type
required
string
Allowed values: function file_search computer_use_preview web_search code_interpreter image_generation local_shell mcp custom
name
string
description
string
parameters
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object
key
additional properties
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object recursive
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
strict
boolean
top_logprobs
integer
top_p
number format: double
truncation
string
Allowed values: auto disabled
user
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response object

object
id
required
string
created_at
required
number format: double
error
object
code
string
message
required
string
type
string
incomplete_details
object
reason
string
Allowed values: max_output_tokens content_filter
instructions
One of:
string
metadata
object
key
additional properties
any
model
required
string
object
required
string
Example
response
output
required
Array<object>
object
type
required
string
Allowed values: message function_call reasoning web_search_call file_search_call computer_call code_interpreter_call image_generation_call local_shell_call mcp_call custom_tool_call
id
string
content
Array<object>
object
type
required
string
Allowed values: output_text refusal
text
string
annotations
Array<object>
object
type
required
string
Allowed values: file_citation url_citation container_file_citation file_path
file_id
string
filename
string
index
integer
url
string
title
string
start_index
integer
end_index
integer
refusal
string
role
string
status
string
arguments
string
call_id
string
name
string
parallel_tool_calls
required
boolean
temperature
number format: double
tool_choice
required
One of:
string
Allowed values: auto none required
tools
required
Array<object>
object
type
required
string
Allowed values: function file_search computer_use_preview web_search code_interpreter image_generation local_shell mcp custom
name
string
description
string
parameters
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object
key
additional properties
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object recursive
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
strict
boolean
top_p
number format: double
background
boolean
conversation
required
object
id
required
string
max_output_tokens
integer
max_tool_calls
integer
previous_response_id
string
reasoning
object
effort
string
Allowed values: minimal medium high
generate_summary
string
summary
string
service_tier
string
status
string
Allowed values: completed failed in_progress cancelled queued incomplete
text
object
format
object
type
required
string
Allowed values: text json_object json_schema
name
string
schema
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object
key
additional properties
object
type
string
Allowed values: object array string number boolean integer null
description
string
properties
object recursive
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
required
Array<string>
items
object recursive
enum
Array
additionalProperties
boolean
description
string
strict
boolean
verbosity
string
Allowed values: low medium high
top_logprobs
integer
truncation
string
user
string
usage
required
object
input_tokens
required
integer
input_tokens_details
required
object
cached_tokens
integer
output_tokens
required
integer
output_tokens_details
required
object
reasoning_tokens
integer
total_tokens
required
integer

401

Section titled “401 ”

Unauthorized

object
error
object
message
string
type
string
code
string

429

Section titled “429 ”

Rate limited

object
error
object
message
string
type
string
code
string