Get file metadata

GET

/projects/:projectId/files/:fileId

GET

/projects/:projectId/files/:fileId

1 curl https:/https://api/projects/projectId/files/fileId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "file": {
3     "_id": "64b8f9e2a1c4d23f9b7e4d12",
4     "projectId": "proj_9f8e7d6c5b4a3210",
5     "filename": "marketing_strategy_q3.pdf",
6     "mimeType": "application/pdf",
7     "sizeBytes": 245760,
8     "r2Key": "files/proj_9f8e7d6c5b4a3210/marketing_strategy_q3.pdf",
9     "thumbnailR2Key": null,
10     "uploadedBy": "user_12345",
11     "uploadedAt": "2024-06-10T15:22:30Z",
12     "usedInRunIds": [
13       "run_20240610_001",
14       "run_20240611_002"
15     ],
16     "uploadedInRunId": "run_20240610_001",
17     "derivedFromFileId": null,
18     "tags": [
19       "marketing",
20       "Q3",
21       "strategy"
22     ],
23     "archivedAt": null,
24     "folderId": "folder_98765"
25   }
26 }

Returns the ProjectFile metadata for a single file.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

fileIdstringRequired

Response

The file metadata.

fileobject

Errors

401

Unauthorized Error

404

Not Found Error