Upload file into workspace and register catalog metadata

POST

/v1/storage/objects

POST

/v1/storage/objects

1 import requests
2 
3 url = "https://api.bctrl.ai/v1/storage/objects"
4 
5 payload = {
6     "workspace": "project-alpha",
7     "logicalPath": "documents/reports/2024/financial-summary.pdf",
8     "objectKey": "proj-alpha-2024-financial-summary-001",
9     "filename": "financial-summary.pdf",
10     "sizeBytes": 245760,
11     "contentType": "application/pdf",
12     "expiresAt": "2025-06-30T23:59:59Z"
13 }
14 headers = {
15     "Authorization": "Bearer <token>",
16     "Content-Type": "application/json"
17 }
18 
19 response = requests.post(url, json=payload, headers=headers)
20 
21 print(response.json())

200Successful

1 {
2   "contentType": "application/pdf",
3   "expiresAt": "2025-06-30T23:59:59Z",
4   "filename": "financial-summary.pdf",
5   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6   "logicalPath": "documents/reports/2024/financial-summary.pdf",
7   "objectKey": "proj-alpha-2024-financial-summary-001",
8   "sizeBytes": 245760,
9   "workspace": "project-alpha"
10 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Response

Default Response

contentTypestring

expiresAtstring or null

filenamestring

idstringformat: "uuid"

logicalPathstring

objectKeystring

sizeBytesinteger0-9007199254740991

workspacestringformat: "^[\w.:-]+$"1-128 characters