v1

latestOpenAPI 3.0.32026-07-26231418.5 KB

Sessions

Create a session

post/session

Request body

titlestring

agentstring

Agent ID or configured harness ID. For local DB agents, use agent_id or agent.

agent_idstring

harnessstring

runtimestring

Built-in runtime ID or runtime harness alias. When present, creates a runtime-backed session.

promptstring

Optional initial prompt. If present, the runtime session starts immediately.

timezonestring

tzstring

Example request

{
  "runtime": "cursor",
  "environment": {
    "repository": "https://github.com/your-org/your-repo",
    "ref": "main"
  },
  "timezone": "America/Los_Angeles",
  "tz": "America/Los_Angeles"
}

Response

Session created

idstring

titlestring

agentstring

agent_idstring

harnessstring

runtimestring

runtime_agent_ref_idstring nullable

provider_session_idstring nullable

provider_run_idstring nullable

status'pending' | 'running' | 'idle' | 'error'

environmentobject

Example response

{
  "status": "idle"
}