プラットフォームの概要
OmniDoc APIは、1つのアカウント内でファイルおよびコンテンツのワークフローを提供します。呼び出し元はAPIキーを使用してリソースを作成し、その後、返される安定したIDを用いてそれらを照会、結合、処理、またはダウンロードします。
リソースモデル
Section titled “リソースモデル”| リソース | 目的 |
|---|---|
| ドキュメント / ファイル | アカウントが所有するソースファイルおよびファイルライブラリエントリ |
| ジョブ / オペレーション | 非同期翻訳、ドキュメント処理、またはオーディオ・ビデオジョブ |
| アーティファクト | ジョブがプレビューまたはダウンロード用に提供する結果 |
| クレジット操作 | 請求対象となる1つの処理について、請求額および返金額の記録 |
すべてのリソースは所有アカウントに対して確認されます。クライアントは公開IDのみを保持すればよく、IDやファイル名、ダウンロードアドレスから実装詳細を推測してはなりません。
一般的なコールフロー
Section titled “一般的なコールフロー”- 入力リソースを作成するか、選択してください。
- アカウントにクレジットがあることを確認してください。ジョブ開始前に残高がしきい値と比較され、終了時には実際の使用量が請求されます。
Idempotency-Keyを使用してジョブを作成してください。- ジョブのステータスを確認してください。ファイル翻訳ジョブでは、SSE や Webhook も使用できます。
- このジョブの結果とクレジット記録を確認してください。
外部連携では常にAPIキーが使用され、その権限はキーを作成したアカウントと同じです。 認証 を参照してください。
クイックスタート → ファイルをアップロードし、ジョブを作成してステータスを確認し、結果をダウンロードします。