Skip to navigation
API ReferenceFiles

Download File Content

View as Markdown
Download the bytes for one file.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

fileIdstringRequired
Unique file 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.

Query parameters

runIdstringOptional

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
Content-DispositionstringOptional
Attachment filename for the downloaded file.
Content-Lengthinteger
Size of the streamed content in bytes when known.
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

File content stream

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error