Skip to navigation
API ReferenceRuns

Get a whole-Run recording

View as Markdown

Read one recording belonging to this Run. A succeeded recording includes a direct standalone MP4 download URL, expiry, SHA-256 and byte size. Partial capture is reported explicitly. Download URLs expire within five minutes and never outlive a View.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runIdstringRequired
Unique run identifier generated by BCTRL.
recordingIdstringRequired
Unique recording 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.

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

OK
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
downloadExpiresAtdatetime or null
RFC 3339 timestamp with a UTC offset.
downloadUrlstring or nullformat: "uri"

A short-lived direct download of the standalone MP4. Available only when status is succeeded.

durationMsinteger or null>=0
endedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
idstring
Unique recording identifier generated by BCTRL.
kind"whole_run"
object"recording"
partialboolean or null
Whether the completed capture is missing media. Null until capture completes.
runIdstring
Unique run identifier generated by BCTRL.
sha256string or null
sizeBytesinteger or null
startedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
statusenum

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error