API reference sections
Schema
BranchChatResponse
Type object
Shape
| Field | Type | Description |
|---|---|---|
| transcriptrequired | ChatTranscript |
{
"transcript": {
"chat": {
"id": "00000000-0000-4000-8000-000000000000",
"title": "string",
"private": false,
"current_model": {
"provider": "string",
"requested_model": "string",
"default_reasoning": "default"
},
"branched_from": {
"chat_id": "00000000-0000-4000-8000-000000000000",
"through_message_id": "00000000-0000-4000-8000-000000000000"
},
"agent_working_folder": "string",
"agent_mode": "string",
"agent_fast": false,
"pinned_at": 0,
"profile_id": "00000000-0000-4000-8000-000000000000",
"created_at": 0,
"updated_at": 0
},
"tool_policy": {
"chat_id": "00000000-0000-4000-8000-000000000000",
"mode": "manual",
"workspace_ids": [
"00000000-0000-4000-8000-000000000000"
]
},
"tool_activities": [],
"notices": [
{
"id": "00000000-0000-4000-8000-000000000000",
"attempt_id": "00000000-0000-4000-8000-000000000000",
"chat_id": "00000000-0000-4000-8000-000000000000",
"assistant_message_id": "00000000-0000-4000-8000-000000000000",
"text": "string",
"text_offset": 0,
"created_at": 0
}
],
"messages": [
{
"id": "00000000-0000-4000-8000-000000000000",
"chat_id": "00000000-0000-4000-8000-000000000000",
"ordinal": 0,
"role": "user",
"state": "pending",
"markdown": "string",
"origin_message_id": "00000000-0000-4000-8000-000000000000",
"provider": "string",
"requested_model": "string",
"resolved_model": "string",
"error_class": "configuration",
"created_at": 0,
"completed_at": 0
}
],
"blocks": [
{
"id": "00000000-0000-4000-8000-000000000000",
"message_id": "00000000-0000-4000-8000-000000000000",
"ordinal": 0,
"kind": "paragraph",
"markdown": "string",
"plain_text": "string"
}
],
"pinned_documents": [
{
"chat_id": "00000000-0000-4000-8000-000000000000",
"document_id": "00000000-0000-4000-8000-000000000000",
"display_title": "string",
"pinned": false,
"first_used_at": 0,
"last_used_at": 0
}
],
"feedback": [],
"usage": [],
"sources": [],
"reasoning_control": {
"kind": "unsupported"
},
"agent_commands": [
{
"name": "string",
"description": "string",
"display_name": "string",
"kind": "command",
"input_hint": "string"
}
],
"attachments": []
}
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Used by
Generated from contract version 1. Last updated .
