文書を保護
テキスト、PDF、DOCXファイルをアップロードし、処理ジョブを追跡して保護済み成果物を取得します。
文書ジョブの流れ
- UTF-8テキスト、PDF、DOCXの生バイトを次へ送信します
POST /v1/documents/jobs. - 返されたジョブIDを保持し、次をポーリングします
GET /v1/documents/jobs/{id}. - ジョブが成功したら、一覧にあるテキスト、PDF、および任意のマッピング成果物を取得します。
- アプリケーションが必要な結果を保存した後、ジョブの一時データを削除するか期限切れにします。
コンテンツタイプが重要です
ファイルのバイト列を次の形式で直接送信します text/plain, application/pdfまたはDOCXメディアタイプを使用します。アップロード上限は10 MBです。
ファイルを送信
curl 'https://api.shinrai.innovius.io/v1/documents/jobs?mode=replace&include_mapping=true' \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H 'Content-Type: application/pdf' \
-H 'Idempotency-Key: customer-case-4815' \
--data-binary @case.pdf
状態を確認して成果物をダウンロード
curl "https://api.shinrai.innovius.io/v1/documents/jobs/$JOB_ID" \
-H "Authorization: Bearer $SHINRAI_API_KEY"ステータスレスポンスで返された成果物URLを使用します。ジョブと成果物には、ジョブを作成したアカウントだけがアクセスできます。
失敗を安全に処理
保護に失敗した場合は元のファイルを転送しないでください。 415 は未対応のメディアタイプ、 422 は無効な文書内容、 503 は一時的なワーカー障害として扱います。