Skip to content
/
Response object
Last updated

Response Object

Represents a complete model response returned when stream: false. Contains the generated output, thread information, and optional metadata.

Properties

success boolean

Always true for successful responses.

thread_id string

The thread ID this response belongs to. Format: thread_ followed by alphanumeric characters.

response string

The complete AI-generated response text. Format depends on output_mode parameter:

  • text mode: Rich text with markdown formatting (default)
  • plain mode: Plain text with all markdown formatting stripped
  • blocks mode: Not included; use response_blocks instead

response_id string optional

Unique identifier for this response. Can be used with previous_response_id parameter to reset conversation context.

is_summarized boolean

Indicates whether the conversation history was summarized due to context window limits. When true, older messages were compressed to fit within the model's context window.

response_blocks array optional

Structured response blocks when output_mode is set to blocks or when tool calls are present. Each block represents a discrete piece of content (text, tool call, tool result).

Show block structure

Each block contains:

type string

Block type. Values: text, tool_call, tool_result.

content string optional

Text content (when type is text).

tool_name string optional

Name of the tool called (when type is tool_call or tool_result).

tool_arguments object optional

Arguments passed to the tool (when type is tool_call).

tool_result string optional

Result returned by the tool (when type is tool_result).

assistant_id string optional

The assistant ID bound to this thread, if any.

reasoning_content string optional

The model's internal reasoning/thinking process when reasoning is enabled. Contains the chain-of-thought analysis that led to the final response. Only present when using reasoning-capable models with reasoning configuration.

tools object optional

Tool information when include parameter contains tools.available or tools.used.

Show tools structure

available array optional

List of tools that were available to the model during response generation. Present when include contains tools.available.

used array optional

List of tools that were actually called by the model. Present when include contains tools.used.

Each used tool contains:

  • name string - Tool name
  • arguments object - Arguments passed to tool
  • success boolean - Whether execution succeeded
  • result_preview string - Preview of the result (truncated)

rules array optional

List of rules that were applied to this response. Present when include parameter contains rules.

Show rule structure

Each rule contains:

rule_id string

Rule identifier.

name string

Rule name.

priority integer

Rule priority (0-100).

category string optional

Rule category.

{
  "success": true,
  "thread_id": "thread_xyz789",
  "response": "The capital of France is Paris. It is located in the north-central part of the country and is known for its art, culture, and iconic landmarks like the Eiffel Tower.",
  "response_id": "resp_abc123",
  "is_summarized": false
}
Previous page
Next page