Skip to navigation
API ReferenceRuns

Save a file from a Run's workspace

View as Markdown
Save a file from the Run's workspace as an output File.

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.
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.
runtimePathstringRequired1-1024 characters
filenamestringOptional1-255 characters
pathstringOptional1-4096 characters

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

Created
bindingobject or null
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
fileIdstring
Unique file identifier generated by BCTRL.
filenamestring
object"run.file"
roleenum
Allowed values:
runtimePathstring or null
sizeinteger>=0
sourcePathstring or null
spacePathstring
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error