Skip to main content
GET
Get a Run

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version
enum<string>
required
Available options:
2026-08-24

Path Parameters

id
string
required
Pattern: ^run_[0-9a-f]{32}$

Response

Success

id
string
required
Pattern: ^run_[0-9a-f]{32}$
workspace_id
string
required
Pattern: ^wrkspc_[0-9a-f]{32}$
session_id
string
required
Pattern: ^sess_[0-9a-f]{32}$
agent
string
required
Pattern: ^agent_[0-9a-f]{32}$
principal
string
required
Pattern: ^prin_[0-9a-f]{32}$
requested_by
object
required
acted_as
string
required
Pattern: ^prin_[0-9a-f]{32}$
caused_by
object
required
agent_installation_id
string | null
required
Pattern: ^aini_[0-9a-f]{32}$
surface_scope_id
string | null
required
Pattern: ^surf_[0-9a-f]{32}$
trigger
object
required
status
enum<string>
required
Available options:
queued,
running,
requires_action,
completed,
failed,
canceled
cost
object
required
artifacts
object[]
required
stop_reason
enum<string> | null
required
Available options:
end_turn,
requires_action,
interrupted,
retries_exhausted,
max_tokens,
max_turn_requests,
refusal,
error,
budget_reached
error
object | null
required
created_at
string
required
updated_at
string
required
completed_at
string | null
required
surface_scope_kind
enum<string>
Available options:
root,
team,
channel,
personal