API Referenceruntimes

Start a runtime

View as Markdown

Start a profile-backed runtime and open its active run. Ephemeral runtimes cannot be restarted after their session ends — create a new runtime instead.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired
Unique runtime identifier generated by BCTRL.

Headers

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.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.
recordingbooleanOptional

Response

OK
connectionobject
runIdstring
Unique run identifier generated by BCTRL.
runtimeIdstring
Unique runtime identifier generated by BCTRL.
startedboolean
statusenum

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error