POST
/api/v1/documents/{documentId}/processドキュメントを処理
アカウント内のドキュメントのバージョンに対して、非同期の処理ジョブを作成します。
認証
API キーまたはアカウント認証
スコープ
documents:read, jobs:create
契約
API v1
リクエスト
curl -X POST 'https://api.maxscanner.app/api/v1/documents/{documentId}/process' \
-H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: unique-request-id' \
-d '{ "operation": "convert", "format": "pdf" }'リクエスト本文
{ "operation": "convert", "format": "pdf" }レスポンス
{ "jobId": "job_123", "documentId": "doc_123", "versionId": "ver_4", "status": "queued" }実装上の注意
- サーバーはキューに入れる前にドキュメントの所有権を確認します。
- 返された jobId で状態を追跡してください。
このエンドポイントを試す
エンドポイントをアプリに組み込む前に、API プレイグラウンドで認証して安全にテストしましょう。
プレイグラウンドを開く →