Update a file

PATCH

/projects/:projectId/files/:fileId

PATCH

/projects/:projectId/files/:fileId

1 curl -X PATCH https:/https://api/projects/projectId/files/fileId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "file": {
3     "_id": "f8a1c2d4-3b6e-4f9a-9d2e-7c3b5a1e8f9d",
4     "projectId": "proj_9a8b7c6d5e4f3a2b1c0d",
5     "filename": "Quarterly_Report_Q2_2024.pdf",
6     "mimeType": "application/pdf",
7     "sizeBytes": 245760,
8     "r2Key": "files/proj_9a8b7c6d5e4f3a2b1c0d/f8a1c2d4-3b6e-4f9a-9d2e-7c3b5a1e8f9d.pdf",
9     "thumbnailR2Key": "thumbnails/f8a1c2d4-3b6e-4f9a-9d2e-7c3b5a1e8f9d.png",
10     "uploadedBy": "user_1234567890abcdef",
11     "uploadedAt": "2024-05-20T10:15:30Z",
12     "usedInRunIds": [
13       "run_20240520_001",
14       "run_20240521_002"
15     ],
16     "uploadedInRunId": "run_20240520_001",
17     "derivedFromFileId": "f7b2c3d4-2a5e-4f8b-8c1d-6b2a4e9f7c8d",
18     "tags": [
19       "finance",
20       "quarterly",
21       "report"
22     ],
23     "archivedAt": "null",
24     "folderId": "folder_0987654321fedcba"
25   }
26 }

Renames, re-tags, archives, or moves a file between folders. Rename/re-tag/archive require project:manage; the folder move (folderId) requires file:write. The body carries any of filename, tags, archivedAt, folderId.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

fileIdstringRequired

Request

This endpoint expects an object.

filenamestringOptional

New display name (storage location is immutable).

tagslist of stringsOptional

Replacement tag labels (lowercased).

archivedAtstring or nullOptional

Archive (a timestamp) or restore (null) the file.

folderIdstring or nullOptional

Move the file to a folder (null = the Inbox).

Response

The updated file.

fileobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error