Archive a file

POST

/projects/:projectId/files/:fileId/archive

POST

/projects/:projectId/files/:fileId/archive

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

1 {
2   "file": {
3     "_id": "a3f1c9d2-4b7e-4f3a-9d2e-8b7c6f1a2d3e",
4     "projectId": "proj_9876543210",
5     "filename": "design_specifications_v2.pdf",
6     "mimeType": "application/pdf",
7     "sizeBytes": 245760,
8     "r2Key": "files/proj_9876543210/a3f1c9d2-4b7e-4f3a-9d2e-8b7c6f1a2d3e.pdf",
9     "thumbnailR2Key": null,
10     "uploadedBy": "user_1234567890",
11     "uploadedAt": "2024-05-20T15:45:00Z",
12     "usedInRunIds": [
13       "run_20240520_001"
14     ],
15     "uploadedInRunId": "run_20240519_007",
16     "derivedFromFileId": null,
17     "tags": [
18       "specifications",
19       "design",
20       "v2"
21     ],
22     "archivedAt": "2024-06-01T10:00:00Z",
23     "folderId": "folder_4567891230"
24   }
25 }

Soft-archives a file (recoverable). Requires project:manage on the project.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

fileIdstringRequired

Response

The archived file.

fileobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error