Stable identity for a launch profile. Built-ins remain readable across machines; user-created profiles are opaque UUIDs.
API reference sections
Schema
SessionSummary
Type object
Shape
| Field | Type | Description |
|---|---|---|
| idrequired | TerminalSessionId | |
| parent_session_id | TerminalSessionId or null | |
| profilerequired | SessionProfileKey | |
| display_namerequired | string | |
| working_directory | string or null | |
| moderequired | SessionMode | |
| processrequired | ProcessState | |
| controllerrequired | ControllerState | |
| managed | ManagedState or null | |
| active_turn_id | AgentTurnId or null | |
| attentionrequired | AttentionState | |
| pending_attachment_countrequired | integer (uint32, >= 0) | |
| capabilities | CapabilitySet | Default |
| project_id | ProjectId or null | The project this session was placed in, if any. Absent from a peer that predates projects, which is why it defaults rather than being required; absent for a session nobody placed, which the tree draws under its virtual Unassigned bucket rather than a persisted project. Default |
| handover | HandoverState | Protocol v14. Where a controller handover stands. Default |
| model | ModelIdentity or null | Protocol v14. The model the session asked for and the one last reported, for a managed session whose adapter can say. Default |
| origin | SessionOrigin | Protocol v16. What created this session. Default |
| created_at_msrequired | integer (int64) |
{
"id": "00000000-0000-4000-8000-000000000000",
"parent_session_id": "00000000-0000-4000-8000-000000000000",
"profile": {
"kind": "built_in",
"value": "string"
},
"display_name": "string",
"working_directory": "string",
"mode": {
"kind": "raw_pty"
},
"process": {
"kind": "starting"
},
"controller": "detached",
"managed": "idle",
"active_turn_id": "00000000-0000-4000-8000-000000000000",
"attention": {
"unread_count": 0,
"requires_user": false,
"reason": "background_output"
},
"pending_attachment_count": 0,
"capabilities": [],
"project_id": "00000000-0000-4000-8000-000000000000",
"handover": "idle",
"model": {
"requested": "string",
"reported": "string"
},
"origin": {
"kind": "manual"
},
"created_at_ms": 0
}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
POST
Create a rooted process session/v1/sessionsGET
Get one session's metadata/v1/sessions/{session_id}
Generated from contract version 1. Last updated .
