Skip to main content
POST
Create an OpenAI Responses-compatible response

Authorizations

Authorization
string
header
required

Org API key as Authorization: Bearer z_sk_...

Body

application/json

Request payload for createOpenAIResponse. Examples use placeholder-safe values and do not include real secrets or private prompt content.

OpenAI-compatible Responses request. Unknown fields are ignored after duplicate-key checks; recognized fields that request unsupported behavior are rejected.

input
required

The input field on ResponsesRequest.

Example:

"Say hello."

background
boolean | null

The background field on ResponsesRequest.

Example:

false

client_metadata
object | null

The client_metadata field on ResponsesRequest.

Example:
context_management
null

The context_management field on ResponsesRequest.

Example:

null

conversation
null

The conversation field on ResponsesRequest.

Example:

null

frequency_penalty
number | null

The frequency_penalty field on ResponsesRequest.

Required range: -2 <= x <= 2
Example:

0.5

include
string[] | null

The include field on ResponsesRequest.

Nested schema within ResponsesRequest for ResponsesRequest.include.oneOf[0].items.

Pattern: ^\s*([Rr][Ee][Aa][Ss][Oo][Nn][Ii][Nn][Gg]\.[Ee][Nn][Cc][Rr][Yy][Pp][Tt][Ee][Dd]_[Cc][Oo][Nn][Tt][Ee][Nn][Tt])\s*$
Example:
instructions
string | null

The instructions field on ResponsesRequest.

Example:

"example"

max_output_tokens
integer | null

The max_output_tokens field on ResponsesRequest.

Example:

12

max_tool_calls
null

The max_tool_calls field on ResponsesRequest.

Example:

null

metadata
object | null

The metadata field on ResponsesRequest.

Example:
model
string

The model field on ResponsesRequest.

Example:

"openai/gpt-5.5"

parallel_tool_calls
boolean | null

The parallel_tool_calls field on ResponsesRequest.

Example:

true

presence_penalty
number | null

The presence_penalty field on ResponsesRequest.

Required range: -2 <= x <= 2
Example:

0.5

previous_response_id
string | null

The previous_response_id field on ResponsesRequest.

Example:

"00000000-0000-4000-8000-000000000001"

prompt
null

The prompt field on ResponsesRequest.

Example:

null

prompt_cache_key
string | null

The prompt_cache_key field on ResponsesRequest.

Maximum string length: 256
Example:

"Say hello."

prompt_cache_options
null

The prompt_cache_options field on ResponsesRequest.

Example:

null

prompt_cache_retention
null

The prompt_cache_retention field on ResponsesRequest.

Example:

null

reasoning
object | null

The reasoning field on ResponsesRequest.

Example:
safety_identifier
string | null

The safety_identifier field on ResponsesRequest.

Example:

"example"

service_tier
string | null

The service_tier field on ResponsesRequest.

Pattern: ^\s*([Aa][Uu][Tt][Oo]|[Dd][Ee][Ff][Aa][Uu][Ll][Tt]|[Ff][Ll][Ee][Xx]|[Pp][Rr][Ii][Oo][Rr][Ii][Tt][Yy])\s*$
Example:

"example"

store
boolean | null

The store field on ResponsesRequest.

Example:

false

stream
boolean

The stream field on ResponsesRequest.

Example:

true

stream_options
object

The stream_options field on ResponsesRequest.

Example:
temperature
number | null

The temperature field on ResponsesRequest.

Example:

0.5

text
object

The text field on ResponsesRequest.

Example:
tool_choice

The tool_choice field on ResponsesRequest.

Available options:
auto,
none,
required
Example:

"auto"

tools
object[]

The tools field on ResponsesRequest.

Nested schema within ResponsesRequest for ResponsesRequest.tools.items.

Example:
top_logprobs
null

The top_logprobs field on ResponsesRequest.

Example:

null

top_p
number | null

The top_p field on ResponsesRequest.

Example:

0.5

truncation
string | null

The truncation field on ResponsesRequest.

Pattern: ^\s*([Aa][Uu][Tt][Oo]|[Dd][Ii][Ss][Aa][Bb][Ll][Ee][Dd])\s*$
Example:

"example"

user
string | null

The user field on ResponsesRequest.

Example:

"example"

Response

JSON response or server-sent event stream.

Schema for ResponsesResponse values returned by or accepted by the Nito gateway.

created_at
integer
required

The created_at field on ResponsesResponse.

Example:

1778268600

error
object | null
required

The error field on ResponsesResponse.

id
string
required

The id field on ResponsesResponse.

Example:

"00000000-0000-4000-8000-000000000001"

incomplete_details
object | null
required

The incomplete_details field on ResponsesResponse.

model
string
required

The model field on ResponsesResponse.

Example:

"openai/gpt-5.5"

object
enum<string>
required

The object field on ResponsesResponse.

Available options:
response
Example:

"response"

output
object[]
required

The output field on ResponsesResponse.

Example:
parallel_tool_calls
boolean
required

The parallel_tool_calls field on ResponsesResponse.

Example:

true

status
string
required

The status field on ResponsesResponse.

Example:

"example"

store
boolean
required

The store field on ResponsesResponse.

Example:

true

usage
object
required

The usage field on ResponsesResponse.

Example:
completed_at
integer | null

The completed_at field on ResponsesResponse.

Example:

1778268600

free_tier
object

The free_tier field on ResponsesResponse.

Example:

"example"

instructions
string | null

The instructions field on ResponsesResponse.

Example:

"example"

max_output_tokens
integer | null

The max_output_tokens field on ResponsesResponse.

Example:

12

metadata
object

The metadata field on ResponsesResponse.

Example:
output_text
string

The output_text field on ResponsesResponse.

Example:

"example"

previous_response_id
string | null

The previous_response_id field on ResponsesResponse.

Example:

"00000000-0000-4000-8000-000000000001"

reasoning
object

The reasoning field on ResponsesResponse.

Example:
temperature
number | null

The temperature field on ResponsesResponse.

Example:

0.5

text
object

The text field on ResponsesResponse.

Example:
tool_choice

The tool_choice field on ResponsesResponse.

Example:

"example"

tools
object[]

The tools field on ResponsesResponse.

Example:
top_p
number | null

The top_p field on ResponsesResponse.

Example:

0.5

truncation
string

The truncation field on ResponsesResponse.

Example:

"example"

user
string | null

The user field on ResponsesResponse.

Example:

"example"

The web_search field on ResponsesResponse.

Example: