Logo PDFHQ

Documentos

DocumentaçãoOperações PDF

API Redact PDF

Remova permanentemente texto, pixels de imagem e conteúdo de vetor sobreposto de retângulos de página explicitamente selecionados.

Chaves de API do lado do servidor Uploads de armazenamento assinado

Semântica de endpoint e tarefa#

Código de operação: redact

Inicie esta operação com POST /v1/tasks e o código da ferramenta mostrado acima. Envie e anexe PDFs de origem (ou use endpoints de upload com escopo de tarefa), depois chame POST /v1/tasks/{task_id}/process com configurações de operação.

Prepare documentos revisados para divulgação com áreas de conteúdo sensível conhecido.

Entradas: Exatamente um PDF lacrado; 1–200 retângulos explícitos, cada um dentro de sua página de destino.

Configuração e parâmetros extras#

ConfiguraçãoTipoComportamento
regionsobrigatório object[]Cada região: {page,x0,y0,x1,y1}, página começa em 1 e as coordenadas do retângulo usam pontos PDF do canto superior esquerdo da página. Todos os retângulos devem estar dentro dos limites da página.
strip_metadatabooleanTambém remova metadados, anexos e scripts. Padrão: true.

As opções são validadas pela API. Configurações desconhecidas e valores não suportados retornam um erro em vez de serem ignorados.

Sequência de pedido em funcionamento#

Programming language: cURL

Escolha um idioma · role horizontalmente para todos os 10 idiomas de SDK

API example · cURL
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"tool":"redact"}'

# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'

# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"options":{"regions":[{"page":1,"x0":72,"y0":100,"x1":300,"y1":132}],"strip_metadata":true}}'

curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_API_KEY'

After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads.

All 10 SDKs ↓Passo a passo completo em Python ↓ Passo a passo completo em Bash/cURL ↓ Todos os endpoints → Envios diretos → Tratamento de erros →

Pacotes baixáveis gerados cobrem apenas o fluxo de trabalho da tarefa. SDKs de serviço completo requerem uma especificação OpenAPI de tempo de execução verificada; os SDKs de tarefa Python, JavaScript e TypeScript transmitem uploads de arquivo; os outros idiomas requerem uploads multipart assinados implementados pelo chamador.

O ID da tarefa retornado é usado tanto para sondagem de status quanto para recuperação. Após a tarefa ter sucesso, solicite uma URL de saída assinada em vez de incorporar um segredo de download.

Saída e detalhes importantes#

Novo PDF com conteúdo fisicamente removido em regiões marcadas e preenchimento preto aplicado.

Requer revisão visual e verificação em relação ao original. Não é um detector de redação semântica; não garante que todas as instâncias de um nome em outro lugar em um arquivo sejam encontradas. Objetos vetoriais que se cruzam podem ser removidos completamente. As páginas de destino devem estar não rotacionadas e PDFs com campos de formulário devem ser nivelados primeiro. Assinaturas digitais existentes são invalidadas.

Erros, tentativas e faturamento
Logo PDFHQ

Ferramentas PDF e inteligência de documentos. Prepare, compreenda e trabalhe com seus documentos.

© 2026 PDFHQ. Todos os direitos reservados.