CreateSessionRequest

Type object

Shape

Field	Type	Description
idempotency_keyrequired	IdempotencyKey
profilerequired	SessionProfileKey	Stable identity for a launch profile. Built-ins remain readable across machines; user-created profiles are opaque UUIDs.
parent_session_id	TerminalSessionId or null
mode	SessionMode	Raw remains the compatibility default. Managed creation is accepted only for a profile whose provider passes the rooted host handshake. Default `{"kind":"raw_pty"}`
working_directoryrequired	string	An absolute local path. The Agent-owned host validates it at spawn.
sizerequired	GridSize

Example

{
  "idempotency_key": "00000000-0000-4000-8000-000000000000",
  "profile": {
    "kind": "built_in",
    "value": "string"
  },
  "parent_session_id": "00000000-0000-4000-8000-000000000000",
  "mode": {
    "kind": "raw_pty"
  },
  "working_directory": "string",
  "size": {
    "columns": 0,
    "rows": 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/v1/sessions
Create a rooted process session

Generated from contract version 1. Last updated November 12, 2026.