コンテンツにスキップ

ファイルをアップロード

アップロードは3つのステップで行います:アップロードアドレスの取得、ファイルの送信、ドキュメントの確認。アップロードアドレスは一度取得すれば最大1時間有効です。

1. アップロードアドレスをリクエストする

Section titled “1. アップロードアドレスをリクエストする”
POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-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
}

生ファイルのバイトを本文としてPUTをupload_urlに送信し、upload_headersに含まれるすべてのヘッダーをそのまま送信してください。

Terminal window
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous response
curl --fail-with-body -X PUT "$UPLOAD_URL" \
-H "Content-Type: $UPLOAD_CONTENT_TYPE" \
-H "If-None-Match: *" \
--upload-file "report.docx"

この手順では OmniDoc API キーを送信しないでください。アドレスが期限切れになった場合や転送に失敗した場合は、新しいキーを取得してください。

POST /api/v1/upload/finalize
X-API-Key: sk_your_key
Content-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 が無効または期限切れです
403finalize_tokenは別のアカウントに属しています
410アップロードされたファイルが見つかりませんでした(転送が完了していないか、アドレスの有効期限が切れております)。新しいアドレスを取得してください。
413ファイルごとのサイズ制限を超えています
415サポートされていない形式、またはコンテンツが拡張子と一致しません
422Officeファイルが破損しているか、構造上安全ではありません
429アップロードの数が多すぎます
503アップロードサービスは一時的に利用できません。後ほど再度お試しください。