Update File | BCTRL Docs

curl -X PATCH "https://api.bctrl.ai/v2/files/fileId?spaceId=spaceId" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "contentType": "application/pdf",
  "createdAt": "2024-06-01T12:00:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Project Proposal.pdf",
  "path": "/documents/proposals/Project Proposal.pdf",
  "sizeBytes": 245760,
  "source": "upload",
  "type": "document",
  "downloadUrl": "https://cdn.bctrl.ai/files/123e4567-e89b-12d3-a456-426614174000/download",
  "expiresAt": "2024-06-08T12:00:00Z",
  "metadata": {},
  "runId": "987e6543-e21b-12d3-a456-426614174999",
  "runtimeId": "456e7890-e12b-12d3-a456-426614174abc",
  "spaceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Update one file display name or caller-owned metadata.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

fileIdstringRequired

Query parameters

spaceIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

metadataobject or nullOptional

namestringOptional1-255 characters

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"