跳到內容

API 概覽

Base URL

https://omnidoc.top/api/v1

JSON 請求發送 Content-Type: application/json。API Key 可放在 X-API-Key 請求標頭,也可作為 Bearer 憑證發送。

服務主要路徑說明
檔案上傳/upload/*上傳並確認文件
檔案庫/storage/files/*、/documents/*清單、讀取與下載
翻譯/jobs/*、/artifacts/*建立任務、查詢狀態與結果
文件工具/document-operations/*、/file-tools/*轉換、合併、拆分、壓縮等
即時翻譯/ai/*短文本與批量片段翻譯
音視頻/media-jobs/*、/media-voices/*任務和音色
術語表/glossaries/*術語與匯入匯出
用量與積分/usage/*、/billing/credits/*用量、餘額與結算憑證
通知/sse/*、/webhooks/*即時進度與回呼

可調用的服務與計費見 服務與權限 。

  • 資源 ID 是不透明字串。
  • 建立類別請求建議攜帶 Idempotency-Key,文件操作、音視訊任務和音色建立必須攜帶。
  • 列表介面的分頁參數以各介面說明為準。
  • 返回 429 時按 錯誤與重試 處理。
  • 下載的檔案名僅供展示,儲存到本機前請取得 basename 並依本機檔案系統限制進行處理。

請保存每次回應的 X-Request-Id。聯繫支援時提供該值、請求時間和介面路徑,不要傳送完整的 API Key 或檔案內容。