Export Run Files | BCTRL Docs

curl -X POST https://api.bctrl.ai/v2/runs/id/files/export \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "format": "zip",
  "name": "experiment-results-2024-06-01"
}'

{
  "contentType": "application/zip",
  "createdAt": "2024-06-01T12:00:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "experiment-results-2024-06-01.zip",
  "path": "/exports/experiment-results-2024-06-01.zip",
  "sizeBytes": 52428800,
  "source": "runtime",
  "type": "archive",
  "downloadUrl": "https://api.bctrl.ai/downloads/123e4567-e89b-12d3-a456-426614174000",
  "expiresAt": "2024-06-08T12:00:00Z",
  "metadata": {},
  "runId": "987f6543-e21b-45d3-b789-123456789abc",
  "runtimeId": "456a7890-b12c-34d5-e678-987654321def",
  "spaceId": "abc12345-def6-7890-ab12-cdef34567890"
}

Export run files as a ZIP file.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

format"zip"Required

namestringRequired1-255 characters

filterobjectOptional

Response

Default Response

contentTypestring>=1 character

createdAtstring

idstringformat: "uuid"

namestring>=1 character

pathstring>=1 character

sizeBytesinteger0-9007199254740991

sourceenum

Allowed values:

typestring>=1 character

downloadUrlstring

expiresAtstring or null

metadataobject or null

runIdstring or nullformat: "uuid"

runtimeIdstring or nullformat: "uuid"

spaceIdstringformat: "uuid"