Upload File | BCTRL Docs

Upload a file into a space and return the canonical v2 file resource.

AuthorizationBearer

Use Bearer <api-key>.

spaceIdstringRequiredformat: "uuid"

This endpoint expects a multipart form containing a file.

filefileRequired

File bytes to upload.

metadatastringOptional

Optional JSON object string with caller-owned file metadata.

namestringOptional<=255 characters

Optional display filename.

pathstringOptional<=4096 characters

Optional relative destination path. Must not be absolute or contain . or .. path segments.

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"

$	curl -X POST "https://api.bctrl.ai/v2/files?spaceId=spaceId" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: multipart/form-data" \
>	-F file=@iVBORw0KGgo=

1	{
2	"contentType": "image/png",
3	"createdAt": "2024-06-01T12:00:00Z",
4	"id": "123e4567-e89b-12d3-a456-426614174000",
5	"name": "avatar.png",
6	"path": "users/1234/images",
7	"sizeBytes": 204800,
8	"source": "upload",
9	"type": "file",
10	"downloadUrl": "https://cdn.bctrl.ai/files/123e4567-e89b-12d3-a456-426614174000/download",
11	"expiresAt": "2024-07-01T12:00:00Z",
12	"metadata": {},
13	"runId": "00000000-0000-0000-0000-000000000000",
14	"runtimeId": "00000000-0000-0000-0000-000000000000",
15	"spaceId": "9f8c7d6e-5b4a-3c2d-1e0f-123456789abc"
16	}