Collect File

POST

/v1/spaces/:id/runtimes/:runtimeId/files/collect

POST

/v1/spaces/:id/runtimes/:runtimeId/files/collect

1 curl -X POST https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/files/collect \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "path": "/tmp/runtime/output/results.json"
6 }'

200Successful

1 {
2   "artifact": {
3     "createdAt": "2024-06-10T09:15:30Z",
4     "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5     "id": "1c9d4f2e-8b3a-4d7a-9f2e-3a1b2c4d5e6f",
6     "kind": "log",
7     "name": "runtime-output-log",
8     "runId": "7e4a1b2c-3d4f-5e6a-7b8c-9d0e1f2a3b4c",
9     "runtimeId": "5f6a7b8c-9d0e-1f2a-3b4c-7e4a1b2c3d4f",
10     "sizeBytes": 2048
11   },
12   "file": {
13     "contentType": "application/json",
14     "createdAt": "2024-06-10T09:15:00Z",
15     "id": "2b4c7e4a-1b2c-3d4f-5e6a-7b8c9d0e1f2a",
16     "name": "results.json",
17     "path": "/storage/spaces/space123/runtimes/runtime456/results.json",
18     "sizeBytes": 2048
19   }
20 }

Copy a runtime-local file back into durable space storage. Use this to preserve files produced by runtime work, optionally as an artifact.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

runtimeIdstringRequired

Request

This endpoint expects an object.

pathstringRequired1-4096 characters

artifactobjectOptional

namestringOptional1-255 characters

storagePathstringOptional1-4096 characters

Response

Default Response

artifactobject or null

fileobject