Skip to content

API overview

Base URL

https://omnidoc.top/api/v1

Send Content-Type: application/json with JSON requests. The API key goes in the X-API-Key header or as a Bearer credential.

ServiceMain pathsPurpose
File upload/upload/*Upload and confirm documents
File library/storage/files/*, /documents/*List, read and download
Translation/jobs/*, /artifacts/*Create jobs, check status and results
Document tools/document-operations/*, /file-tools/*Convert, merge, split, compress and more
Instant translation/ai/*Short text and batch segment translation
Audio and video/media-jobs/*, /media-voices/*Jobs and voices
Glossaries/glossaries/*Terms, import and export
Usage and credits/usage/*, /billing/credits/*Usage, balance and settlement records
Notifications/sse/*, /webhooks/*Live progress and callbacks

Which services you can call and what they cost: services and permissions.

  • Resource IDs are opaque strings.
  • Send an Idempotency-Key with create requests; document operations, media jobs and voice creation require one.
  • Pagination parameters are described on each endpoint’s page.
  • Handle 429 as described in errors and retries.
  • Downloaded file names are for display; take the basename and apply your file system’s limits before saving.

Keep the X-Request-Id of every response. When you contact support, give that value, the request time and the path; never send the full API key or file contents.