ファイルをアップロード
アップロードは3つのステップで行います:アップロードアドレスの取得、ファイルの送信、ドキュメントの確認。アップロードアドレスは一度取得すれば最大1時間有効です。
1. アップロードアドレスをリクエストする
Section titled “1. アップロードアドレスをリクエストする”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
filename | 文字列 | ✅ | ファイル名;サーバーは拡張子からファイルタイプを判定します |
file_size | 整数 | ✅ | バイト単位の正確なサイズ(0より大きい) |
mime_type | 文字列 | — | オプション;サーバーはこれを使用しません |
レスポンス:
{ "document_id": "4q8mx2q9z1k7p6ra", "upload_url": "https://upload.example/...", "upload_headers": { "Content-Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "If-None-Match": "*" }, "finalize_token": "short_lived_token", "expires_in": 3600}2. ファイルを送信する
Section titled “2. ファイルを送信する”生ファイルのバイトを本文としてPUTをupload_urlに送信し、upload_headersに含まれるすべてのヘッダーをそのまま送信してください。
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous responsecurl --fail-with-body -X PUT "$UPLOAD_URL" \ -H "Content-Type: $UPLOAD_CONTENT_TYPE" \ -H "If-None-Match: *" \ --upload-file "report.docx"この手順では OmniDoc API キーを送信しないでください。アドレスが期限切れになった場合や転送に失敗した場合は、新しいキーを取得してください。
3. ドキュメントを確認する
Section titled “3. ドキュメントを確認する”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}成功した場合、ドキュメントが返されます。
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}確認が完了して初めて、ドキュメントはファイルライブラリに登録され、ジョブで使用可能になります。
filenameは表示専用であり、パスや固有識別子として使用しないでください。サーバーは不正な文字を置き換え、長すぎる名前に対して安全なダウンロード名を生成します。
| ステータス | 原因 |
|---|---|
400 | 無効なファイル名またはサイズ、またはアップロードされたサイズが要求されたサイズと異なる |
401 | 認証情報または finalize_token が無効または期限切れです |
403 | finalize_tokenは別のアカウントに属しています |
410 | アップロードされたファイルが見つかりませんでした(転送が完了していないか、アドレスの有効期限が切れております)。新しいアドレスを取得してください。 |
413 | ファイルごとのサイズ制限を超えています |
415 | サポートされていない形式、またはコンテンツが拡張子と一致しません |
422 | Officeファイルが破損しているか、構造上安全ではありません |
429 | アップロードの数が多すぎます |
503 | アップロードサービスは一時的に利用できません。後ほど再度お試しください。 |