コンテンツにスキップ

ドキュメントおよびファイルツール

OmniDocは同期ファイルツールと追跡可能な非同期ドキュメント操作を提供します。まず機能エンドポイントを呼び出し、クライアントにサポート形式や制限をハードコーディングしないでください。

GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

これらは、現在有効な操作、その入力形式、課金および技術的制限を返します。unavailable にリストされている機能は作成できません。

POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

このエンドポイントには Idempotency-Key が必要です。kind には現在、以下が含まれています:

  • extract:構造化抽出、無料。
  • pdf_to_html:PDFからオンラインHTMLへ、無料。
  • visual_extract:視覚的構造抽出はページ単位で課金されます(1ページあたり1クレジット)。処理開始前に、残高から処理可能なページ数が設定されます(最大20ページ);残高が1ページ分に満たない場合は 402 が返されます。処理完了時には実際に処理されたページ数が課金され、残高がマイナスになる場合があります。

クエリとキャンセル:

GET /api/v1/document-operations/{operation_id}
GET /api/v1/document-operations?limit=25
POST /api/v1/document-operations/{operation_id}/cancel

完了すると、レスポンスのoutput_document_idはファイルライブラリまたは別のジョブに移動でき、credit_operation_idには決済記録が含まれます。

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

マージの例:

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

分割例:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

これらのツールは、現在のアカウントが所有し、タイプが一致するドキュメントのみを受け付けます。バイナリ応答をストリーム処理し、ファイル名とタイプは応答ヘッダーから取得してください。