File library
The file library shows the source files, job results and app files the current account can reach. Each item has a stable file_id and returns the actions the caller can currently perform.
Documents used as translation input also have /api/v1/documents list, detail, update and delete endpoints. document_id is for creating processing jobs; file_id is for library-wide permissions and downloads. Do not assume the two IDs are interchangeable.
List and detail
Section titled “List and detail”GET /api/v1/storage/files?offset=0&limit=50GET /api/v1/storage/files/{file_id}List response:
{ "items": [ { "id": "x7m4q2k9n6c1v8pa", "name": "report.docx", "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "size_bytes": 45678, "status": "ready", "publication_status": "draft", "origin": { "product_code": "omnidoc-main", "display_name": "OmniDoc" }, "capabilities": { "can_view": true, "can_download": true, "can_update": true, "can_delete": true, "can_share": true }, "created_at": "2026-10-01T12:00:00Z", "updated_at": "2026-10-01T12:00:00Z" } ], "has_more": true, "next_offset": 50}To get the next page, pass next_offset as offset; stop when has_more is false.
Always use each item’s capabilities to decide whether it can be downloaded, shared or granted to an app; do not infer permissions from the origin fields.
Download
Section titled “Download”GET /api/v1/storage/files/{file_id}/contentPOST /api/v1/storage/files/{file_id}/download-ticket/content redirects (302) to a short-lived download address; do not send the API key when following the redirect. Requesting a download-ticket first is recommended. Request a new address after one expires; do not store it.
Permissions and links
Section titled “Permissions and links”GET /api/v1/storage/files/{file_id}/permissionsPOST /api/v1/storage/files/{file_id}/permissionsDELETE /api/v1/storage/files/{file_id}/permissions/{grant_id}
GET /api/v1/storage/files/{file_id}/linksPOST /api/v1/storage/files/{file_id}/linksDELETE /api/v1/storage/files/{file_id}/links/{link_id}Permission changes and public links are separate capabilities. When you create a link, set its audience, download permission, expiry and an optional download count explicitly; revoke it as soon as it is no longer needed.
Workspace views
Section titled “Workspace views”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsThe workspace endpoints suit a file center; /storage/files suits permission and download actions on a single file.