Skip to content

Projects, tags and sharing

The file library is the source of truth for resources; projects, tags and search are views that organise them. Keep file or document IDs; do not use names in place of stable identifiers.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /api/v1/projects/{project_id}/documents/{document_id}

Adding a document to a project only changes how it is organised: the file is not copied and its owner does not change.

GET /api/v1/tags
POST /api/v1/tags
DELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}
DELETE /api/v1/tags/documents/{document_id}/{tag_id}

A tag name is for display; deleting, detaching and querying use the tag ID.

GET /api/v1/search?q={query}&limit=20

Search returns only documents and jobs the current account may read. Search is a read and costs no credits.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /api/v1/shares/{token}

POST /shares creates a read-only link to a translation result; the body has artifact_id and an optional expires_in_days (1–365; without it the link does not expire). Anyone holding the link can download, so keep it out of logs and analytics parameters, and delete it when it is no longer needed.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

These endpoints are for building a unified workspace for an OmniDoc account. Clients should follow the entries and capabilities in the responses and not build app URLs themselves.