Upload and stage a runtime file

curl -X POST https://api.bctrl.ai/v2/runtimes/runtimeId/files/upload \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F file=@SGVsbG8gV29ybGQ=

{
  "file": {
    "contentType": "application/pdf",
    "createdAt": "2024-06-01T10:15:30Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Project_Proposal.pdf",
    "path": "/runtime/files/123e4567-e89b-12d3-a456-426614174000",
    "sizeBytes": 245760,
    "source": "upload",
    "type": "pdf",
    "downloadUrl": "https://api.bctrl.ai/downloads/123e4567-e89b-12d3-a456-426614174000",
    "expiresAt": "2024-06-08T10:15:30Z",
    "metadata": {},
    "runId": "987e6543-e21b-12d3-a456-426614174999",
    "runtimeId": "456e7890-e12b-12d3-a456-426614174abc",
    "spaceId": "789e1234-e56b-12d3-a456-426614174def"
  },
  "staged": {
    "expiresAt": "2024-06-08T10:15:30Z",
    "id": "staged-123e4567-e89b-12d3-a456-426614174000",
    "name": "Project_Proposal.pdf",
    "runtimeId": "456e7890-e12b-12d3-a456-426614174abc",
    "runtimePath": "/staged/runtime/files/Project_Proposal.pdf",
    "sizeBytes": 245760
  }
}

Upload a local file into the runtime space and materialize it into the live runtime in one request.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired

Request

This endpoint expects a multipart form containing a file.

filefileRequired

File bytes to upload to the runtime space and materialize in the runtime.

metadatastringOptional

Optional JSON object string with caller-owned file metadata.

namestringOptional<=255 characters

Optional display filename and staged runtime filename.

storagePathstringOptional<=4096 characters

Optional durable storage destination path before staging into the runtime. When omitted, the server generates a managed path.

Response

Default Response

fileobject

stagedobject