開発者向け
墨消しAPI
Webアプリと同じ安全なパイプライン（Azure OCR + PII検出 + 復元不可能なラスタライズ墨消し）を使って、プログラムでPDFを墨消しします。
APIキーを取得OpenAPIをダウンロード試す（キー不要）
DocsDevelopers (Markdown)llms.txt
非同期ジョブ
1つまたは複数のPDFをアップロードし、ジョブのステータスをポーリングして、墨消し済みの出力をダウンロードします。
PII制御
ジョブごとにPIIカテゴリを選択し、常に墨消しする語句や常に表示のまま残す語句を固定して、既定値をダッシュボードに保存できます。
リテンションモード
APIワークフローではデフォルトで保持なし。レビューが必要なときは任意で「Studioで開く」モードを利用できます。

要約

はい — Redact PDF AI は、PDFや画像をプログラムで墨消しするREST APIを提供します。書類をPOSTすると、APIがAIでPII（氏名、メール、IBANなど）を検出し、スキャン文書にはOCRも実行します。常に墨消しする語句や表示のまま残す語句を指定することもできます。処理後は復元不可能なフラット化された墨消し済みファイルが返されます。APIはすべてのプランで利用でき、Webアプリのサブスクリプションやクレジット残高と同じページ枠を消費します。

概念
基本事項: 認証、クォータ、リトライ、リテンション、対応PIIカテゴリ。
  • 認証: キーを X-API-Key で送信します（キーはサーバー側で保管）。
  • プランとクォータ: APIはすべてのプランで利用でき、Webアップロードと同じページ枠を消費します。
  • 冪等性: POST /v1/jobs を再試行する際は X-Idempotency-Key を使用します。
  • リテンション: ephemeral は処理後に原本を削除します。studio はStudioレビュー用に原本とマスクを保持します。
  • ステータス: uploaded → analyzing → redacted（またはerror）。
  • PIIカテゴリ: Person、Email、PhoneNumber、Address、Organization、Date、IBAN、CreditCard。
Authentication
Use an API key for server-to-server calls. Do not put API keys in browsers or mobile apps.
Validate your key
curl -X GET \
  'https://www.redact-pdf.ai/v1/me' \
  -H 'X-API-Key: YOUR_API_KEY'
Header: X-API-Key: YOUR_API_KEY
Security checklist
  • Store keys in your server environment (not in client code).
  • Use one key per environment (dev/staging/prod) to reduce blast radius.
  • Prefer short-lived workers and job queues for large batches.
  • Log request IDs (from error responses) for support/debugging.
クイックスタート
すぐに始められる最小限の例。
ジョブを作成
curl -X POST \
  'https://www.redact-pdf.ai/v1/jobs' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -F 'files=@contract.pdf;type=application/pdf' \
  -F 'pii_categories=["Person","Email","PhoneNumber"]' \
  -F 'pii_included_terms=["Project Titan"]' \
  -F 'pii_excluded_terms=["Acme Corp"]' \
  -F 'retention=ephemeral'
APIはすぐにジョブIDを返します。処理は非同期で行われます。
レスポンス例
{
  "job_id": "b3f2b2e0-6f30-4f3e-8a7b-2f2a20a7d91c",
  "status": "analyzing",
  "documents": [
    { "id": "7f4f4f85-6b7a-4f88-9a8a-7b9a6a2d2fd0", "status": "uploaded" }
  ]
}
ステータスが「redacted」になるまでジョブをポーリングし、書類ごとに出力をダウンロードします。
Error handling
Errors are JSON with a stable code. Treat quota and rate limits as actionable signals.
Common codes
  • quota_exceeded (HTTP 402): buy credits or upgrade.
  • rate_limited (HTTP 429): backoff and retry.
  • invalid_request (HTTP 400): fix parameters.
  • unauthorized (HTTP 401): key missing/invalid.
Example error response
{
  "error": "Insufficient quota",
  "code": "quota_exceeded",
  "request_id": "req_123"
}
The request_id helps correlate logs and support requests.
PII categories
Choose which PII types to redact per job. If you omit categories, your dashboard defaults apply.
CategoryWhat it targets
PersonPeople names
EmailEmail addresses
PhoneNumberPhone numbers (validated patterns)
AddressPostal addresses
OrganizationCompany / organization names
DateDates and date-times
IBANInternational bank account numbers
CreditCardCredit card numbers
Tip: if you need a term to never be redacted, set excluded terms in the dashboard preferences.
APIリファレンス（v1）
主要エンドポイントの実用的なリクエスト例です。完全なスキーマはOpenAPIファイルをダウンロードしてください。
ジョブをポーリング
curl -X GET \
  'https://www.redact-pdf.ai/v1/jobs/b3f2b2e0-6f30-4f3e-8a7b-2f2a20a7d91c' \
  -H 'X-API-Key: YOUR_API_KEY'
ジョブが終了状態（redacted または error）に達するまでポーリングします。
出力をダウンロード
curl -L \
  -H 'X-API-Key: YOUR_API_KEY' \
  'https://www.redact-pdf.ai/v1/documents/7f4f4f85-6b7a-4f88-9a8a-7b9a6a2d2fd0/output' \
  -o contract-redacted.pdf
書類のステータスが redacted になったら、墨消し済みPDFをダウンロードします。
ジョブを削除
curl -X DELETE \
  -H 'X-API-Key: YOUR_API_KEY' \
  'https://www.redact-pdf.ai/v1/jobs/b3f2b2e0-6f30-4f3e-8a7b-2f2a20a7d91c'
ジョブと関連ファイルを削除します（リテンションの設定に従います）。
ベストプラクティス
  • 再試行には X-Idempotency-Key を使用してください（ネットワークタイムアウトは発生します）。
  • APIキーをブラウザやモバイルアプリに埋め込まないでください。バックエンドから呼び出してください。
  • ポーリング時は指数バックオフを使用し、短いジョブでは1〜2秒間隔を推奨します。
  • 402 と 429 は対処が必要なシグナル（クォータ／レート制限）として扱ってください。
APIキーを取得OpenAPIをダウンロード試す（キー不要）
PDF墨消しAPIに関するよくある質問

PDFを墨消しするAPIはありますか？

はい。Redact PDF AI は、Webアプリと同じAIによるPII検出およびOCRパイプラインを用いてPDFや画像をプログラムで墨消しし、復元不可能なフラット化されたファイルを返すREST APIを提供します。

APIでPDFを墨消しするにはどうすればよいですか？

APIキーと選択したPIIカテゴリを付けて /v1/jobs エンドポイントにファイルをPOSTし、ジョブが完了するまでポーリングしてから、墨消し済みの出力をダウンロードします。上記の curl の例をご覧ください。

墨消しAPIはバッチ処理や大量処理に対応していますか？

はい。1つのジョブに複数の書類を含めることができ、大量処理のためにジョブを同時に実行することもできます。

墨消しAPIはGDPRに準拠していますか。データはどこで処理されますか？

処理はEU（フランクフルト）とスイスのMicrosoft Azure上で行われ、通信時および保存時に暗号化されます。書類がAIモデルの学習に使われることは決してありません。

APIは処理後すぐにファイルを削除できますか？

はい。「ephemeral（一時保持）」リテンションを使うと、ジョブ完了直後にファイルが削除されます。それ以外の場合はデフォルトのリテンションが適用され、APIから任意のジョブを削除できます。

墨消しAPIの費用はいくらですか？

APIはすべてのプランに含まれています。APIジョブはサブスクリプションおよびクレジットパックと同じページ枠を消費するため、API専用の料金プランやアドオンはありません。

© Copyright 2026 Redact PDF AI. © 2025 Redact PDF AI.