コンテンツにスキップ

APIの概要

Base URL

https://omnidoc.top/api/v1

JSON リクエストとともに Content-Type: application/json を送信してください。API キーは 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を送信してください。操作、メディアジョブ、および音声作成の各処理には、それぞれ1つのIdempotency-Keyが必要です。
  • ページネーションパラメータは、各エンドポイントのページで説明されています。
  • ハンドル 429 は、 エラーと再試行 で説明されているとおりです。
  • ダウンロードされたファイル名は表示用であり、保存する前にベース名を取得し、ファイルシステムの制限を適用してください。

すべてのレスポンスの X-Request-Id を保持してください。サポートに問い合わせる際は、その値、リクエスト時刻、およびパスを伝えてください。API キー全体やファイル内容を送信しないでください。