Collect Runtime File

POST

/v1/runtimes/:runtimeId/files/collect

POST

/v1/runtimes/:runtimeId/files/collect

$ curl -X POST https://api.bctrl.ai/v1/runtimes/runtimeId/files/collect \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "runtimePath": "/workspace/output/results.csv"
> }'

1 {
2   "contentType": "text/csv",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "downloadUrl": "https://storage.bctrl.ai/files/123e4567-e89b-12d3-a456-426614174000/download",
5   "id": "123e4567-e89b-12d3-a456-426614174000",
6   "name": "results.csv",
7   "path": "/durable/storage/results.csv",
8   "sizeBytes": 2048,
9   "source": "runtime",
10   "spaceId": "321e6547-e21b-12d3-a456-426614174def",
11   "expiresAt": "2024-02-15T09:30:00Z",
12   "metadata": {},
13   "runId": "987e6543-e21b-12d3-a456-426614174999",
14   "runtimeId": "456e7890-e12b-12d3-a456-426614174abc",
15   "type": "file"
16 }

Copy a runtime-workspace file back into durable storage as a produced file for the active run.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired

Request

This endpoint expects an object.

runtimePathstringRequired1-4096 characters

destinationPathstringOptional1-4096 characters

metadataobjectOptional

namestringOptional1-255 characters

typestringOptional1-64 characters

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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error