Skip to navigation
API ReferenceRuns

Stream Run Events

View as Markdown
Stream ordered trace and runtime events for a run.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runIdstringRequired
Unique run identifier generated by BCTRL.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Last-Event-IDstringOptional
Optional last delivered event identifier used to resume an SSE stream.

Query parameters

includeanyOptionalDefaults to ["trace","events"]
afterstringOptional

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

Server-Sent Events stream of normalized run trace and runtime event frames

any
OR
any
OR
any
OR
any
OR
any
OR
any

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error