List Files | BCTRL Docs

curl -G https://api.bctrl.ai/v1/files \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d spaceId=3fa85f64-5717-4562-b3fc-2c963f66afa6 \
     -d source=runtime \
     --data-urlencode path=/outputs/results.json \
     --data-urlencode prefix=logs/2024/06/ \
     -d q=error \
     -d runId=d290f1ee-6c54-4b01-90e6-d701748f0851 \
     -d runtimeId=7c9e6679-7425-40de-944b-e07fc1f90ae7 \
     -d type=json \
     -d type=log \
     --data-urlencode createdAfter=2024-06-01T00:00:00Z \
     -d include=folders \
     -d cursor=eyJwYWdlIjoyfQ \
     -d limit=100

1	{
2	"data": [
3	{
4	"contentType": "application/json",
5	"createdAt": "2024-06-10T14:22:00Z",
6	"downloadUrl": "https://storage.bctrl.ai/files/3fa85f64-5717-4562-b3fc-2c963f66afa6/outputs/results.json",
7	"id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
8	"name": "results.json",
9	"path": "/outputs/results.json",
10	"sizeBytes": 2048,
11	"source": "runtime",
12	"spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
13	"expiresAt": "2024-07-10T14:22:00Z",
14	"metadata": {
15	"checksum": "e3b0c44298fc1c149afbf4c8996fb924",
16	"uploadedBy": "[email protected]"
17	},
18	"runId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
19	"runtimeId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
20	"type": "json"
21	}
22	],
23	"nextCursor": "eyJwYWdlIjoyfQ==",
24	"folders": [
25	{
26	"fileCount": 12,
27	"lastCreatedAt": "2024-06-10T14:22:00Z",
28	"name": "2024",
29	"path": "/logs/2024",
30	"totalBytes": 10485760
31	}
32	]
33	}

List durable files in a space using the canonical file resource. Use source, type, runId, runtimeId, path, prefix, and createdAfter filters to find uploaded inputs or produced run/runtime outputs. Pass include=folders with a prefix for an S3-style directory view: direct files plus rolled-up immediate subfolders.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Query parameters

spaceIdstring or "default"Optional

sourceenumOptional

Allowed values:

pathstringOptional1-4096 characters

prefixstringOptional1-4096 characters

qstringOptional>=1 character

runIdstringOptionalformat: "uuid"

runtimeIdstringOptionalformat: "uuid"

typestring or list of stringsOptional

createdAfterdatetimeOptional

includeenumOptional

Allowed values:

cursorstringOptional>=1 character

limitintegerOptional<=200Defaults to 50

Response

datalist of objects

nextCursorstring or null

folderslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error