Get File | BCTRL Docs

curl https://api.bctrl.ai/v1/files/fileId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "contentType": "application/pdf",
  "createdAt": "2024-01-15T09:30:00Z",
  "downloadUrl": "https://cdn.bctrl.ai/files/123e4567-e89b-12d3-a456-426614174000/download",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Q1 Financial Report.pdf",
  "path": "/reports/2024/Q1/Q1_Financial_Report.pdf",
  "sizeBytes": 1048576,
  "source": "upload",
  "spaceId": "321e6547-e89b-12d3-a456-426614174111",
  "expiresAt": "2024-02-15T09:30:00Z",
  "metadata": {
    "author": "Jane Doe",
    "pageCount": 42,
    "tags": [
      "report",
      "finance",
      "Q1"
    ]
  },
  "runId": "987e6543-e21b-12d3-a456-426614174999",
  "runtimeId": "456e7890-e12b-12d3-a456-426614174888",
  "type": "document"
}

Get one file metadata record using the canonical file resource.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

fileIdstringRequired

Response

contentTypestring>=1 character

createdAtdatetime

downloadUrlstring>=1 character

idstringformat: "uuid"

namestring>=1 character

pathstring>=1 character

sizeBytesinteger0-9007199254740991

sourceenum

spaceIdstringformat: "uuid"

expiresAtdatetime

metadataobject or null

runIdstringformat: "uuid"

runtimeIdstringformat: "uuid"

typestring1-64 characters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error