Skip to main content
GET
Get Run Status

Authorizations

Authorization
string
header
required

Send the credential as Authorization: Bearer <key>.

Scoped partner credentials use the exclusive nxsk_v1_... namespace. Each scoped key is bound at issuance to one organization, one canonical named environment, an explicit engine set, and a least-privilege capability set. A malformed, unknown, rotated, or revoked nxsk_ key fails closed and is never retried as a legacy key.

Capabilities used by this API are runs:write, runs:read, engines:read, catalog:read, webhooks:manage, runs:defensibility:read, runs:test, and converse:use. Operation descriptions name the required capability. Grandfathered nx_live_... and nx_test_... keys retain their existing broad access during the compatibility window.

Path Parameters

run_id
string<uuid>
required

The run identifier returned by POST /api/v1/engines/{engine_slug}/runs.

Response

Current run status and results (if completed).

run_id
string<uuid>
required

Stable run identifier.

status
enum<string>
required

Current run status. queued and processing are non-terminal: keep polling. completed, degraded, and failed are terminal. degraded carries the same output shape as completed plus output.degradation_reason: treat it as a successful response with a warning, not as a state to keep polling on.

Available options:
queued,
processing,
completed,
degraded,
failed
environment
enum<string>
required

Environment the run executed in.

Available options:
test,
live
attempt
integer
required

Execution attempt count. A terminal value of 1 means no worker retry.

Required range: x >= 0
created_at
string<date-time>
required

RFC 3339 timestamp when the run was created.

engine_type
string

Runtime engine type. Omitted on legacy rows without engine metadata.

engine_version
string

The released engine version this run executed against (major.minor), resolved from the engine_version pin at submit time and frozen for the run's lifetime. Absent when the run used the engine's current configuration without a pin.

Example:

"1.3"

stage
string

Last known pipeline stage (e.g. EVALUATE, FILTER).

output
object

Run summary. Present on completed runs.

duration_ms
integer

Duration of the final execution attempt in milliseconds.

total_duration_ms
integer

Wall-clock milliseconds from creation to terminal completion.

error
string

Error message on failed runs.

error_details
object

Structured failure details.

trace_id
string

Trace identifier for support correlation.

Pattern: ^[0-9a-f]{32}$
completed_at
string<date-time>

RFC 3339 timestamp when the run reached a terminal state.

solutions
object[]

Ranked solutions. Present on completed placement runs.

warnings
object

Structured input-quality warnings. Present only when the released engine configuration enables warning exposure.