Skip to main content
GET
Get headless agent run state

Authorizations

Authorization
string
header
required

API key or personal access token (NEX-1042). Send as Authorization: Bearer <token>. Token format:

  • nex_live_… — live API key (server-to-server)
  • nex_test_… — sandbox API key
  • nex_pat_… — personal access token (acts as the issuing user)

Authorization is decided by the key's scopes array, not the owning user's RBAC role. See POST /api/api-keys to mint a key.

Headers

NexSpace-Version
string

Pin the request to a dated API version (e.g. 2026-05-10). Applied by app-level middleware to every /api route (server/routes/index.ts → apiVersionMiddleware), which echoes the resolved value back in the NexSpace-Version response header. Omit to get the latest version. Discover the catalog at GET /.well-known/api-versions.

Pattern: ^\d{4}-\d{2}-\d{2}$

Path Parameters

id
integer
required
runId
string
required

Response

Run state

runId
string
agentId
integer
status
enum<string>
Available options:
running,
completed,
pending_approval,
error,
rejected
sessionId
string | null
requestId
string
startedAt
string<date-time>
finishedAt
string<date-time> | null
durationMs
integer | null
content
string
toolsInvoked
string[]
pendingApprovalIds
integer[]
error
string | null