API Referencefiles

Get a file

View as Markdown
Get one file metadata record using the canonical file resource.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

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

Response

OK
contentTypestring
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
downloadUrlstring
idstring
Unique file identifier generated by BCTRL.
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

pathstring
sizeBytesinteger>=0

Non-negative number of bytes.

sourceenum
spaceIdstring
Unique space identifier generated by BCTRL.
expiresAtdatetimeOptional
RFC 3339 timestamp with a UTC offset.
metadataobject or nullOptional
runIdstringOptional
Unique run identifier generated by BCTRL.
runtimeIdstringOptional
Unique runtime identifier generated by BCTRL.
typestringOptional1-64 characters

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error