REST API
Get a file
The file's upload and parse status. failure explains a failed or expired file.
Required scopes: files:view
AuthorizationBearer <token>
In: header
Path Parameters
fileId*string
Note file id, scoped to the key's user.
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/files/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a9f", "noteId": "3c2b1a09-8f7e-4d6c-9b5a-4f3e2d1c0b9a", "kind": "document", "name": "Cell biology lecture.pdf", "mimeType": "application/pdf", "sizeBytes": 482113, "url": "https://storage.example.com/workroad/note/3c2b1a09-8f7e-4d6c-9b5a-4f3e2d1c0b9a/3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a9f-cell-biology-lecture.pdf", "status": "ready", "failure": null, "chars": 18240, "imageCount": 3, "jobId": "7a6b5c4d-3e2f-4a1b-8c9d-0e1f2a3b4c5d", "createdAt": "2026-01-15T09:30:00.000Z" }}