Skip to main content
GET
Get Task

Authorizations

Authorization
string
header
required

Workspace API key as a bearer token: Authorization: Bearer ish_sk_live_.... Keys are workspace-scoped machine principals minted in Settings > Developers (shown once at mint). Scopes: sessions:run (create a session, submit turns, close), sessions:read (read the session and its decision trace), environments:read and environments:write (manage the workspace's registered environments), tasks:read and tasks:write (manage the workspace's registered tasks), people:read and people:write (the people the workspace can run a session for), and usage:read (the workspace's own consumption, spend limits and rate-limit budgets). A key is minted with sessions:run, sessions:read, and tasks:read by default; every other scope must be requested, people:read and usage:read included. An ish user access token also works on the same header for personal scripts.

Path Parameters

task_id
string<uuid>
required

Response

Successful Response

A registered task as the caller sees it.

archived_at
string<date-time> | null
required

Set when the task is archived (DELETE). An archived task stays readable by id so existing sessions keep resolving, is hidden from the default list, refuses new sessions (409), and frees its name for reuse.

background
string | null
required

Background the person is treated as already knowing, or null. Accepted and stored; not yet consumed by API sessions, which currently render the instructions only.

created_at
string<date-time>
required
id
string<uuid>
required
instructions
string
required
name
string
required
revision
integer
required

Increments on every write to this task. Sessions freeze the revision they bound, so runs are comparable within a revision of the content.

steps
TaskStepView · object[] | null
required

The actions a run is checked against afterwards, or null when the task has none. Steps are never shown to the person doing the run. Accepted and stored; not yet consumed by API sessions.

updated_at
string<date-time>
required
workspace_id
string<uuid>
required