API Anotar PDF
Adicione texto extraível, destaques coloridos e sobreposições de retângulo com coordenadas precisas.
Semântica de endpoint e tarefa#
Código de operação: annotate
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.
Revise um relatório, adicione notas de aprovação ou marque visualmente regiões sem editar o texto subjacente.
Entradas: Um PDF verificado; 1–200 anotações em até 500 páginas não rotacionadas.
Configuração e parâmetros extras#
| Configuração | Tipo | Comportamento |
|---|---|---|
| annotationsobrigatório | object[] | Cada anotação requer tipo ('text', 'highlight' ou 'rectangle'), página (baseada em 1), x0/y0/x1/y1 em pontos PDF e cor (yellow, blue, red, green, black). Texto requer text e font_size (6–48). |
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
# 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":"annotate"}'
# 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":{"annotations":[{"kind":"text","page":1,"x0":50,"y0":100,"x1":420,"y1":175,"color":"blue","text":"Reviewed","font_size":16}]}}'
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.
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#
Um novo PDF com texto/formas de sobreposição visível real. Não é uma redação segura.
Isso adiciona conteúdo visual; não modifica texto existente ou apaga permanentemente informações subjacentes. Use Redact PDF para confidencialidade; assinaturas digitais são rejeitadas.
Erros, tentativas e faturamento