ChatResponse

The ChatResponse object containing AI chat response data.

Attributes

message (Object)

An object containing the chat message data.

• role (String) - The role of the message sender.

• content (String) - The content of the message.

• tool_calls (Array) - An optional array of ToolCall objects if the model wants to call tools.

• tool_call_id (String) - An optional identifier linking this message to the tool call it responds to.

• cache_control (Object) - An optional object controlling prompt caching for this message. Contains a type (String) property.

• images (Array) - An array of image content objects associated with the message. Each object contains a type (String) and an image_url object with a url (String) property.

compaction (Object)

Present only on non-streaming responses where the model compacted earlier context (see Compaction). A drop-in messages item of the form { type: 'compaction', id, encrypted_content } — resend it on the next turn in place of the summarized history. Absent when no compaction occurred.