Skip to main content
GET
Get one step of a run with its outputs
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns one step: status, kind (procedure, router, join, publish, notify, human or agent), agent, model, timing, totalTokens and cost, its governance hold (with a person handoff while it waits), outputs, stdout, error (the message plus the recorded code, phase, retryable and correlationId) and, while the step delivers outputs to other systems, deliveryProgress counts. stepId is the step id GET /api/v2/runs/getTimeline returns. nodeId is the graph node the step ran, the key GET /api/v2/runs/listValidatorRuns and GET /api/v2/runs/listStepContext take. A step the run does not have answers 404 “Step not found”.

Runtime content

Outputs, stdout, errors, tool input and output and validator snapshots are returned as the run recorded them, except that credential-shaped strings (JWTs, Bearer tokens, x-access-token: URLs and GitHub tokens) are replaced by a [REDACTED] marker. A human step’s outputs, and the outputs its validator passes received, never carry completedBy, completedVia or response: who answered, the channel and the person’s free text. No field names who acted, answered, was notified or repaired, and no answer carries a credential or where it is stored, an agent thread, a storage handle or the run’s company list; runtime content is returned as recorded, so it may mention anything the run itself wrote.

Visibility

You need runs:read at the run’s home (its own org unit, else its workflow’s owning org unit) and at every company it carries, the same rule as GET /api/v2/runs/get. Any other run, and a run with neither home, answers 404 “Run not found” like a missing one. A Personal key reads as its owner, cut down to the key’s scopes; an External App reads by its own role grants.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

stepId
string
required

The step id.

Minimum string length: 1

Query Parameters

runId
string
required

The run id.

Minimum string length: 1

Response

The step

data
object
required
meta
object
required