Sessions

Get session status

Returns the current state and full results of a session. Poll this endpoint until status is a terminal value.

Terminal statuses (stop polling): succeeded, failed, terminated, error, archived.

get/api/sessions/{sessionId}

Request

Path parameters

sessionIdstring uuid required

Session UUID returned by POST /api/sessions.

Response

Session details.

idstring uuid required
titlestring required
promptstring required
platform'desktop' | 'android' | 'ios' required
model'default' | 'haiku' | 'sonnet' | 'opus' | 'kimi' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.5' | 'auto' required
status'queued' | 'created' | 'preparing' | 'running' | 'succeeded' | 'failed' | 'terminated' | 'error' | 'archived' required

Terminal statuses (stop polling): succeeded, failed, terminated, error, archived.

result'passed' | 'failed' | 'error' nullable
summarystring nullable

AI-generated summary of what happened during the session.

tagsstring[] required

A session's tags. A session created directly carries the tags it was created with. A session created from a test case, by a plan run or by running the case on its own, carries the run's tags (if any) merged with the case's tags, each tag once; each source holds at most 10, so a session can carry up to 20.

screenshotsCountinteger required
toolCountinteger required
failedToolCountinteger required
llmCallCountinteger required
creditsUsednumber nullable

Credits consumed by this session.

startedAtstring date-time nullable
completedAtstring date-time nullable
durationinteger nullable

Execution duration in milliseconds.

createdAtstring date-time required
archivedAtstring date-time nullable

Set when the session was archived (soft-deleted). Archived sessions are excluded from lists but stay readable by id.

waitingForUserboolean

True while a running session is parked on a [manual] step and waits for POST /api/sessions/{sessionId}/messages.

waitingForUserInstructionstring

The step's instruction, present only while waitingForUser is true.

Example response

{
  "tags": [
    "git:sha:3f2c1e9a7b6d5c4e3f2a1b0c9d8e7f6a5b4c3d2e",
    "checkout"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.