API de caviardage de PDF — Caviardez les PII par programmation | Redact PDF AI

Développeurs

API de caviardage

Caviardez des PDFs de manière programmatique avec le même pipeline sécurisé que l’application: OCR Azure + détection PII + caviardage irréversible par rasterisation.

Obtenir une clé API Télécharger l’OpenAPI Essayer (sans clé)

Docs Developers (Markdown)llms.txt

Jobs asynchrones

Téléversez un ou plusieurs PDFs, suivez le statut, puis téléchargez les sorties caviardées.

Contrôles PII

Choisissez les catégories PII par job, épinglez des termes à toujours masquer ou toujours garder visibles, et gardez vos préférences par défaut dans le tableau de bord.

Modes de rétention

No-retention par défaut pour l’API, avec un mode “ouvrir dans le Studio” quand une relecture est nécessaire.

En bref

Oui — Redact PDF AI propose une API REST pour caviarder PDFs et images par programmation. Vous envoyez un document, l’API détecte les PII grâce à l’IA (noms, e-mails, IBAN, et bien plus) ainsi que l’OCR pour les numérisations, et vous pouvez fournir des termes à toujours caviarder ou à garder visibles. Elle renvoie ensuite un fichier caviardé irréversible et aplati. L’API est disponible avec chaque offre et utilise le même quota de pages que votre abonnement web ou votre solde de crédits.

Concepts

L’essentiel: auth, quota, retries, rétention et catégories PII supportées.

Auth: envoyez votre clé dans X-API-Key (gardez les clés côté serveur).
Offres et quota: l’API est disponible avec chaque offre et consomme le même quota de pages que les téléversements web.
Idempotence: utilisez X-Idempotency-Key lors des retries de POST /v1/jobs.
Rétention: ephemeral supprime les originaux après traitement; studio conserve originaux + masques pour relecture Studio.
Statuts: uploaded → analyzing → redacted (ou error).
Catégories 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.

Démarrage rapide

Exemples minimaux pour démarrer rapidement.

Créer un job

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'

L’API renvoie immédiatement un identifiant de job. Le traitement est asynchrone.

Exemple de réponse

{
  "job_id": "b3f2b2e0-6f30-4f3e-8a7b-2f2a20a7d91c",
  "status": "analyzing",
  "documents": [
    { "id": "7f4f4f85-6b7a-4f88-9a8a-7b9a6a2d2fd0", "status": "uploaded" }
  ]
}

Sondez le job jusqu’au statut “redacted”, puis téléchargez les sorties par document.

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.

Category	What it targets
Person	People names
Email	Email addresses
PhoneNumber	Phone numbers (validated patterns)
Address	Postal addresses
Organization	Company / organization names
Date	Dates and date-times
IBAN	International bank account numbers
CreditCard	Credit card numbers

Tip: if you need a term to never be redacted, set excluded terms in the dashboard preferences.

Référence API (v1)

Exemples pratiques pour les endpoints principaux. Téléchargez le fichier OpenAPI pour le schéma complet.

Sonder un job

curl -X GET \
  'https://www.redact-pdf.ai/v1/jobs/b3f2b2e0-6f30-4f3e-8a7b-2f2a20a7d91c' \
  -H 'X-API-Key: YOUR_API_KEY'

Sondez jusqu’à ce que le job atteigne un état terminal (redacted ou error).

Télécharger la sortie

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

Téléchargez le PDF caviardé une fois que le statut du document est redacted.

Supprimer un job

curl -X DELETE \
  -H 'X-API-Key: YOUR_API_KEY' \
  'https://www.redact-pdf.ai/v1/jobs/b3f2b2e0-6f30-4f3e-8a7b-2f2a20a7d91c'

Supprime le job et les fichiers associés (selon la rétention).

Bonnes pratiques

Utilisez X-Idempotency-Key pour les retries (les timeouts réseau arrivent).
N’intégrez pas de clés API dans un navigateur ou une app mobile. Appelez depuis votre backend.
Utilisez un backoff exponentiel pour le polling; 1–2s convient pour les jobs courts.
Traitez 402 et 429 comme des signaux actionnables (quota / rate limit).

Obtenir une clé API Télécharger l’OpenAPI Essayer (sans clé)

FAQ sur l’API de caviardage de PDF

Existe-t-il une API pour caviarder des PDFs ?

Oui. Redact PDF AI fournit une API REST qui caviarde PDFs et images par programmation, en utilisant le même pipeline de détection PII par IA et d’OCR que l’application web, et renvoie un fichier irréversible et aplati.

Comment caviarder un PDF via l’API ?

Envoyez votre fichier en POST sur l’endpoint /v1/jobs avec votre clé API et les catégories de PII choisies, interrogez le job jusqu’à ce qu’il soit terminé, puis téléchargez la sortie caviardée. Voir les exemples curl ci-dessus.

L’API de caviardage prend-elle en charge le traitement par lots ou en masse ?

Oui. Un seul job peut inclure plusieurs documents, et vous pouvez exécuter des jobs en parallèle pour les charges de travail à fort volume.

L’API de caviardage est-elle conforme au RGPD, et où les données sont-elles traitées ?

Le traitement s’effectue sur Microsoft Azure dans l’UE (Francfort) et en Suisse, avec chiffrement en transit et au repos, et les documents ne sont jamais utilisés pour entraîner des modèles d’IA.

L’API peut-elle supprimer les fichiers immédiatement après le traitement ?

Oui. Utilisez la rétention "ephemeral" pour que les fichiers soient supprimés dès que le job est terminé ; sinon la rétention par défaut s’applique et vous pouvez supprimer n’importe quel job via l’API.

Combien coûte l’API de caviardage ?

L’API est incluse dans chaque offre. Les jobs API utilisent le même quota de pages que votre abonnement et vos packs de crédits, sans palier API ou add-on séparé.