Desenvolvedores

API de tarja

Tarje PDFs via código usando o mesmo pipeline seguro do app web: OCR do Azure + detecção de dados pessoais + tarja rasterizada irreversível.

Obter chave de API Baixar OpenAPI Testar (sem chave)

Docs Developers (Markdown)llms.txt Compare redaction APIs

Jobs assíncronos

Envie um ou vários PDFs, consulte o status do job e baixe os resultados tarjados.

Controles de PII

Escolha as categorias de PII por job, fixe termos para sempre tarjar e sempre manter visíveis, e salve seus padrões no painel.

Modos de retenção

Sem retenção por padrão nos fluxos de API, com um modo opcional “abrir no Studio” quando você precisar revisar.

Em resumo

Sim. O Tarjar PDF AI oferece uma API REST para tarjar PDFs e imagens via código. Você envia um documento por POST, a API detecta dados pessoais (PII) com IA (nomes, e-mails, IBANs e mais), com OCR para digitalizações, e você pode informar termos para sempre tarjar ou manter visíveis. Em seguida, ela retorna um arquivo tarjado, achatado e irreversível. A API está disponível em todos os planos e usa a mesma cota de páginas da sua assinatura do app web ou do seu saldo de créditos.

For AI agents & LLM tools

Building an agent that needs to redact PDFs? You can verify this API works in one call — no key, no signup.

Try it right now (keyless)

# No API key needed — real redaction of a synthetic-PII sample
curl https://www.redact-pdf.ai/v1/demo
# → detected PII categories + a link to the redacted PDF

Then get a key and POST your own files — the full async flow is three calls: upload, poll, download.

Why this API is agent-ready

Machine-readable everything: llms.txt, Markdown docs and an OpenAPI spec.
Idempotent retries via X-Idempotency-Key — safe for autonomous loops.
ephemeral retention by default: originals are deleted after processing.
Output is rasterized — redacted content is unrecoverable, so agents can safely pass results downstream.
Official MCP server: redact-pdf-mcp on npm (source). Add it to Claude Code with claude mcp add redact-pdf -- npx -y redact-pdf-mcp, or use the REST API above directly. Documents it sends are processed in the EU and Switzerland, encrypted in transit and at rest, and never used to train AI models.
The MCP server ships a try_demo tool that needs no API key: give it a file and it redacts the first page for real, so an agent can show you output on your own document before you configure anything. A free account then gets the first document (up to 5 pages) redacted in full, no card.

Conceitos

O essencial: autenticação, cota, novas tentativas, retenção e categorias de PII compatíveis.

Autenticação: envie sua chave em X-API-Key (mantenha as chaves no servidor).
Planos e cota: a API está disponível em todos os planos e consome a mesma cota de páginas dos envios pela web.
Idempotência: use X-Idempotency-Key ao repetir POST /v1/jobs.
Retenção: ephemeral exclui os originais após o processamento; studio mantém os originais + máscaras para revisão no Studio.
Status: uploaded → analyzing → redacted (ou error).
Categorias de 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.

Início rápido

Exemplos mínimos para começar rapidamente.

Criar um 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'

A API retorna um id de job imediatamente. O processamento acontece de forma assíncrona.

Exemplo de resposta

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

Consulte o job até o status mudar para “redacted” e baixe os resultados de cada documento.

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.

Referência da API (v1)

Exemplos práticos de requisições para os endpoints principais. Baixe o arquivo OpenAPI para ver o esquema completo.

Consultar um job

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

Consulte até o job atingir um estado final (redacted ou error).

Baixar resultado

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

Baixe o PDF tarjado quando o status do documento for redacted.

Excluir um job

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

Exclui o job e os arquivos associados (de acordo com a retenção).

Boas práticas

Use X-Idempotency-Key nas novas tentativas (timeouts de rede acontecem).
Não coloque chaves de API em navegadores ou apps de celular. Faça as chamadas a partir do seu back-end.
Use backoff exponencial durante a consulta; prefira intervalos de 1 a 2 s para jobs curtos.
Trate 402 e 429 como sinais que exigem ação (cota / limite de requisições).

Obter chave de API Baixar OpenAPI Testar (sem chave)

Perguntas frequentes sobre a API para tarjar PDF

Existe uma API para tarjar PDFs?

Sim. O Tarjar PDF AI oferece uma API REST que tarja PDFs e imagens via código, usando a mesma detecção de dados pessoais (PII) com IA e o mesmo pipeline de OCR do app web, e retorna um arquivo achatado e irreversível.

Como tarjar um PDF pela API?

Envie seu arquivo por POST para o endpoint /v1/jobs com sua chave de API e as categorias de PII escolhidas, consulte o job até que ele seja concluído e baixe o resultado tarjado. Veja os exemplos de curl acima.

A API de tarja permite processamento em lote ou em massa?

Sim. Um único job pode incluir vários documentos, e você pode executar jobs em paralelo para grandes volumes.

A API de tarja está em conformidade com a LGPD e o GDPR, e onde os dados são processados?

O processamento roda no Microsoft Azure na UE (Frankfurt) e na Suíça, com criptografia em trânsito e em repouso, e os documentos nunca são usados para treinar modelos de IA.

A API pode excluir os arquivos logo após o processamento?

Sim. Use a retenção "ephemeral" para que os arquivos sejam excluídos assim que o job for concluído; caso contrário, aplica-se a retenção padrão, e você pode excluir qualquer job pela API.

Quanto custa a API de tarja?

A API está incluída em todos os planos. Os jobs da API usam a mesma cota de páginas da sua assinatura e dos seus pacotes de créditos, então não existe um plano ou complemento separado para a API.

Existe um SDK para tarjar PDF?

Você não precisa de um. O Tarjar PDF AI é uma API REST simples, então qualquer linguagem capaz de enviar uma requisição HTTP pode chamá-la, sem SDK para instalar ou empacotar. Se quiser um cliente tipado, gere um a partir da especificação OpenAPI com uma ferramenta como o openapi-generator. Para agentes de IA, existe um servidor MCP oficial. Diferente dos SDKs de visualizador web executados no navegador, a tarja é feita no servidor e retorna um PDF achatado, então nada vai para o seu front-end.