メインコンテンツへ移動

次に使うツールを探す

API/リファレンス/処理ジョブを作成
POST/api/v1/jobs

処理ジョブを作成

非同期の処理操作を送信し、安定したジョブ ID を受け取ります。

認証

API キー

スコープ

jobs:create

契約

API v1

リクエスト

curl -X POST 'https://api.maxscanner.app/api/v1/jobs' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "filename": "invoice.docx", "inputFormat": "docx", "format": "pdf", "sourceKey": "users/USER/uploads/invoice.docx" }'

リクエスト本文

{ "filename": "invoice.docx", "inputFormat": "docx", "format": "pdf", "sourceKey": "users/USER/uploads/invoice.docx" }

レスポンス

{ "jobId": "job_123", "status": "queued", "statusUrl": "/api/v1/jobs/job_123" }

実装上の注意

  • 安全に再試行するには Idempotency-Key を使ってください。
  • ワーカーが処理能力の上限にある間、ジョブはキューに残ることがあります。

このエンドポイントを試す

エンドポイントをアプリに組み込む前に、API プレイグラウンドで認証して安全にテストしましょう。

プレイグラウンドを開く →