Move files to a folder

POST

/projects/:projectId/files/batch/move

POST

/projects/:projectId/files/batch/move

1 curl -X POST https:/https://api/projects/projectId/files/batch/move \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "fileIds": [
6     "f8a1c2d4e5b67890a1b2c3d4"
7   ],
8   "folderId": "folder12345abcde"
9 }'

1 {
2   "files": [
3     {
4       "_id": "f8a1c2d4e5b67890a1b2c3d4",
5       "projectId": "proj98765zyxwv",
6       "filename": "project_plan_v2.pdf",
7       "mimeType": "application/pdf",
8       "sizeBytes": 245760,
9       "r2Key": "r2/project_files/f8a1c2d4e5b67890a1b2c3d4.pdf",
10       "thumbnailR2Key": "r2/thumbnails/f8a1c2d4e5b67890a1b2c3d4.png",
11       "uploadedBy": "user_123456",
12       "uploadedAt": "2024-05-20T10:15:30Z",
13       "usedInRunIds": [
14         "run_20240520_001"
15       ],
16       "uploadedInRunId": "run_20240519_045",
17       "derivedFromFileId": "f7b2c3d4e5a67890b1c2d3e4",
18       "tags": [
19         "project-plan",
20         "pdf"
21       ],
22       "archivedAt": "null",
23       "folderId": "folder12345abcde"
24     }
25   ]
26 }

Moves a batch of files into a folder (folderId: null returns them to the Inbox). The body carries fileIds and the target folderId. Requires file:write on the project.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

Request

This endpoint expects an object.

fileIdslist of stringsRequired

The file ids to move.

folderIdstring or nullRequired

Target folder id (null = the Inbox).

Response

The moved files.

fileslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error