Skip to main content
POST
Create compact OpenAI Responses-compatible output items

Authorizations

Authorization
string
header
required

Org API key as Authorization: Bearer z_sk_...

Body

application/json

Request payload for createOpenAIResponseCompact. 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 ResponsesCompactRequest.

Example:

"Say hello."

background
boolean | null

The background field on ResponsesCompactRequest.

Example:

false

client_metadata
object | null

The client_metadata field on ResponsesCompactRequest.

Example:
context_management
null

The context_management field on ResponsesCompactRequest.

Example:

null

conversation
null

The conversation field on ResponsesCompactRequest.

Example:

null

frequency_penalty
number | null

The frequency_penalty field on ResponsesCompactRequest.

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

0.5

include
string[] | null

The include field on ResponsesCompactRequest.

Nested schema within ResponsesCompactRequest for ResponsesCompactRequest.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 ResponsesCompactRequest.

Example:

"example"

max_output_tokens
integer | null

The max_output_tokens field on ResponsesCompactRequest.

Example:

12

max_tool_calls
null

The max_tool_calls field on ResponsesCompactRequest.

Example:

null

metadata
object | null

The metadata field on ResponsesCompactRequest.

Example:
model
string

The model field on ResponsesCompactRequest.

Example:

"openai/gpt-5.5"

parallel_tool_calls
boolean | null

The parallel_tool_calls field on ResponsesCompactRequest.

Example:

true

presence_penalty
number | null

The presence_penalty field on ResponsesCompactRequest.

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

0.5

previous_response_id
string | null

The previous_response_id field on ResponsesCompactRequest.

Example:

"00000000-0000-4000-8000-000000000001"

prompt
null

The prompt field on ResponsesCompactRequest.

Example:

null

prompt_cache_key
string | null

The prompt_cache_key field on ResponsesCompactRequest.

Maximum string length: 256
Example:

"Say hello."

prompt_cache_options
null

The prompt_cache_options field on ResponsesCompactRequest.

Example:

null

prompt_cache_retention
null

The prompt_cache_retention field on ResponsesCompactRequest.

Example:

null

reasoning
object | null

The reasoning field on ResponsesCompactRequest.

Example:
safety_identifier
string | null

The safety_identifier field on ResponsesCompactRequest.

Example:

"example"

service_tier
string | null

The service_tier field on ResponsesCompactRequest.

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 ResponsesCompactRequest.

Example:

false

stream
boolean | null

The stream field on ResponsesCompactRequest.

Example:

false

stream_options
object

The stream_options field on ResponsesCompactRequest.

Example:
temperature
number | null

The temperature field on ResponsesCompactRequest.

Example:

0.5

text
object

The text field on ResponsesCompactRequest.

Example:
tool_choice

The tool_choice field on ResponsesCompactRequest.

Available options:
auto,
none,
required
Example:

"auto"

tools
object[]

The tools field on ResponsesCompactRequest.

Nested schema within ResponsesCompactRequest for ResponsesCompactRequest.tools.items.

Example:
top_logprobs
null

The top_logprobs field on ResponsesCompactRequest.

Example:

null

top_p
number | null

The top_p field on ResponsesCompactRequest.

Example:

0.5

truncation
string | null

The truncation field on ResponsesCompactRequest.

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

"example"

user
string | null

The user field on ResponsesCompactRequest.

Example:

"example"

Response

OK

type
string
required

The type field on ResponsesOutputItem.

Example:

"example"

arguments
string

The arguments field on ResponsesOutputItem.

Example:

"example"

call_id
string

The call_id field on ResponsesOutputItem.

Example:

"00000000-0000-4000-8000-000000000001"

content
object[]

The content field on ResponsesOutputItem.

Example:
encrypted_content
string | null

The encrypted_content field on ResponsesOutputItem.

Example:

"example"

id
string

The id field on ResponsesOutputItem.

Example:

"00000000-0000-4000-8000-000000000001"

input
string

The input field on ResponsesOutputItem.

Example:

"Say hello."

name
string

The name field on ResponsesOutputItem.

Example:

"example"

namespace
string

The namespace field on ResponsesOutputItem.

Example:

"example"

role
string

The role field on ResponsesOutputItem.

Example:

"example"

status
string

The status field on ResponsesOutputItem.

Example:

"example"

summary
object[]

The summary field on ResponsesOutputItem.

Example:
Example: