Platform overview
The OmniDoc API serves file and content workflows within one account. A caller creates resources with an API key, then uses the stable IDs it gets back to query, combine, process or download them.
Resource model
Section titled “Resource model”| Resource | Purpose |
|---|---|
| Document / File | Source files and file library entries owned by the account |
| Job / Operation | Asynchronous translation, document processing or audio and video jobs |
| Artifact | Results a job delivers for preview or download |
| Credit operation | The record of what one billable action charged and refunded |
Every resource is checked against the owning account. Clients only need to keep public IDs, and should not infer implementation details from IDs, file names or download addresses.
Common call flow
Section titled “Common call flow”- Create or choose an input resource.
- Make sure the account has credits: the balance is checked against a threshold before the job starts, and actual usage is charged when it finishes.
- Create the job with an
Idempotency-Key. - Check the job status; file translation jobs can also use SSE or webhooks.
- Read the results and the credit record for this job.
Identity
Section titled “Identity”External integrations always use API keys, with the same permissions as the account that created the key. See authentication.
Quick start → Upload a file, create a job, check its status and download the results