80 / 80 operações de desenvolvedor descobertas têm esquemas verificados. Exemplos são gerados a partir desses esquemas e são exemplos de documentação. O API Lab opcional abaixo permite apenas solicitações GET selecionadas somente leitura com uma chave de projeto em memória; nunca realiza operações com cobrança.
Um contrato registrado não é prova de um recurso implantado. Operações de IA e assinatura podem estar limitadas ou apenas em sandbox. Consulte os guias do provedor e de lançamento.
Todas as categorias de API AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Escolha um idioma · role horizontalmente para todos os 10 idiomas de SDK
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
Operação de API (80 correspondência)
GET /v1/ai/billing/balance — Ver a carteira partilhada de créditos HQ GET /v1/ai/billing/models — Descubra modelos de IA PDFHQ selecionados e disponibilidade de preços GET /v1/ai/billing/prices — Listar preços ativos de IA do PDFHQ POST /v1/ai/billing/quotes — Cite o uso de IA do PDFHQ em ambas as moedas GET /v1/ai/billing/quotes/{quote_id} — Inspecionar uma cotação de IA de propriedade da conta existente POST /v1/ai/edit-plans/from-job — Revalidar uma sugestão de edição de página de IA paga contra seu PDF selado original e emitir um token de revisão do usuário POST /v1/ai/edit-plans/preview — Visualize alterações determinísticas de página PDF em inglês simples sem cobrar créditos GET /v1/ai/jobs — Listar seus trabalhos de IA em documentos POST /v1/ai/jobs — Iniciar uma operação documental de IA com orçamento em créditos HQ POST /v1/ai/jobs/invoices/batch.xlsx — Exporte até dez trabalhos de fatura já concluídos para uma pasta de trabalho de revisão GET /v1/ai/jobs/usage — Uso de trabalho de IA com escopo de conta e contagens de tokens (sem conteúdo de documento) DELETE /v1/ai/jobs/{job_id} — Excluir um resultado de documento de IA concluído GET /v1/ai/jobs/{job_id} — Pesquise o status e o resultado de IA citado GET /v1/ai/jobs/{job_id}/comparison.csv — Exporte alterações de contrato citadas para revisão humana como um CSV seguro GET /v1/ai/jobs/{job_id}/comparison.xlsx — Baixar pasta de trabalho de revisão de alterações de contrato vinculada à fonte GET /v1/ai/jobs/{job_id}/conversation — Leia as conversas citadas de propriedade e não expiradas GET /v1/ai/jobs/{job_id}/evidence.csv — Exporte os trechos de fonte citados de um resultado de IA de sua propriedade para revisão humana privada GET /v1/ai/jobs/{job_id}/export.{fmt} — Baixe um resultado de revisão de IA privado e validado por citação (JSON, PDF, DOCX ou XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Exporte itens de linha de fatura citados para revisão humana GET /v1/ai/jobs/{job_id}/invoice.csv — Exporte campos de fatura para revisão como um CSV seguro GET /v1/ai/jobs/{job_id}/invoice.xlsx — Baixar uma pasta de trabalho de revisão de fatura vinculada ao escopo da conta e à evidência GET /v1/document-jobs — Listar trabalhos de documento recentes com escopo de conta e chave de API POST /v1/document-jobs — Processe PDFs enviados de forma assíncrona GET /v1/document-jobs/{job_id}/download-url — Obter uma URL de download direto temporária POST /v1/documents/uploads — Criar um upload direto de PDF DELETE /v1/documents/uploads/{upload_id} — Excluir um documento enviado não utilizado GET /v1/documents/uploads/{upload_id} — Inspecionar um documento enviado POST /v1/documents/uploads/{upload_id}/complete — Verificar e selar PDF enviado GET /v1/documents/uploads/{upload_id}/evidence — Extrair texto citado em página de um PDF verificado (visualização limitada) GET /v1/documents/uploads/{upload_id}/form-fields — Descubra nomes de campos AcroForm suportados, tipos e números de página GET /v1/esign/envelopes — Liste seus próprios pedidos de assinatura POST /v1/esign/envelopes — Criar um rascunho de pedido de assinatura eletrônica DELETE /v1/esign/envelopes/{envelope_id} — Descartar um rascunho não enviado sem contatar o provedor GET /v1/esign/envelopes/{envelope_id} — Obter status da solicitação de assinatura PATCH /v1/esign/envelopes/{envelope_id} — Editar um rascunho de assinatura não enviado usando uma versão exata do rascunho POST /v1/esign/envelopes/{envelope_id}/archive — Salve um PDF assinado concluído pelo provedor no armazenamento privado GET /v1/esign/envelopes/{envelope_id}/audit — Ler integridade de assinatura eletrônica com escopo de conta e recebimento de evento GET /v1/esign/envelopes/{envelope_id}/download-url — Emitir URL de download de documento assinado privado de curta duração POST /v1/esign/envelopes/{envelope_id}/remind — Envie um lembrete de signatário sandbox por 24 horas, sem tentativas GET /v1/esign/envelopes/{envelope_id}/reminders — Listar recibos de tentativa de lembrete privado sem endereços de email do signatário POST /v1/esign/envelopes/{envelope_id}/send — Enviar uma solicitação de assinatura sandbox explicitamente aprovada POST /v1/esign/envelopes/{envelope_id}/sync — Atualizar uma solicitação sandbox do fornecedor de assinatura sem reenviar GET /v1/esign/envelopes/{envelope_id}/timeline — Ler a linha do tempo de atividade de solicitação de assinatura segura em privacidade POST /v1/esign/envelopes/{envelope_id}/validate — Validar layout de campo de rascunho contra PDF de origem selado POST /v1/esign/envelopes/{envelope_id}/void — Fila uma cancelamento de solicitação de assinatura sandbox; verifique o estado final separadamente GET /v1/esign/providers — Listar fornecedores de eSignature e sua disponibilidade real GET /v1/esign/reports/export.csv — Exportar metadados operacionais de solicitação de assinatura privada como CSV GET /v1/esign/reports/summary — Resumo de atividade de solicitação de assinatura de sandbox privado GET /v1/task-tools — Listar operações e configurações de tarefas PDF disponíveis GET /v1/task-tools/{tool} — Descrever uma operação de tarefa e suas opções aceitas GET /v1/tasks — Listar suas tarefas de documento POST /v1/tasks — Iniciar uma tarefa de documento DELETE /v1/tasks/{task_id} — Descartar uma tarefa em espera GET /v1/tasks/{task_id} — Recuperar status da tarefa GET /v1/tasks/{task_id}/download-url — Obtenha o URL de download de saída privada de uma tarefa POST /v1/tasks/{task_id}/files — Anexe um upload verificado a uma tarefa em espera POST /v1/tasks/{task_id}/process — Enfileirar e medir uma tarefa de documento GET /v1/tasks/{task_id}/quote — Estimar HQ Credits para uma tarefa em espera a partir de envios verificados POST /v1/tasks/{task_id}/uploads — Criar um ticket de upload para uma tarefa POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Selar um PDF enviado e anexá-lo à tarefa GET /v1/webhooks — Listar apenas as subscrições de webhook deste projeto POST /v1/webhooks — Inscrever-se em eventos de clientes assinados com escopo de projeto GET /v1/webhooks/deliveries — Inspecionar status de entrega com escopo sem cargas confidenciais POST /v1/webhooks/deliveries/{delivery_id}/replay — Reproduzir entrega inativa após corrigir o receptor DELETE /v1/webhooks/{subscription_id} — Revogar uma assinatura de webhook com escopo de projeto POST /v1/webhooks/{subscription_id}/rotate — Girar segredo; revelar substituição uma vez POST /v1/webhooks/{subscription_id}/test — Enfileirar um evento de teste de assinatura sintética GET /v1/workspace/documents — Listar documentos POST /v1/workspace/documents — Registrar documento DELETE /v1/workspace/documents/{document_id} — Remover documento GET /v1/workspace/documents/{document_id} — Obter documento PATCH /v1/workspace/documents/{document_id} — Atualizar documento GET /v1/workspace/documents/{document_id}/activity — Atividade do documento GET /v1/workspace/documents/{document_id}/handoff — Opções de transferência POST /v1/workspace/documents/{document_id}/handoff/ai — Transferir para IA POST /v1/workspace/documents/{document_id}/handoff/signing — Transferência para assinatura POST /v1/workspace/documents/{document_id}/handoff/task — Transferência para tarefa GET /v1/workspace/documents/{document_id}/preview — Pré-visualizar documento GET /v1/workspace/documents/{document_id}/preview-url — URL de visualização do documento PUT /v1/workspace/documents/{document_id}/retention — Definir retenção Schema incluído Disponibilidade restrita Ver a carteira partilhada de créditos HQ
Solicitar contrato — snapshot OpenAPI verificado
Autenticação: APIKeyHeader · Respostas documentadas: 200, 422
Nenhum corpo de solicitação JSON declarado.
Laboratório de API Autenticada
Somente leitura · Sem consumo de crédito Execute solicitações GET seguras selecionadas contra a API PDFHQ publicada. Uma chave de projeto é mantida apenas na memória desta aba. Nunca cole credenciais de provedor, credenciais de pagamento ou uma chave de produção em um computador compartilhado.
# Fill placeholders with account-owned IDs and valid values; review the schema before sending.
# Server-side only. No API key is sent to signed storage hosts.
curl -q --fail-with-body --proto '=https' --max-redirs 0 \
-X GET 'https://api.pdfhq.io/v1/ai/billing/balance' \
-H "x-api-key: ${PDFHQ_API_KEY:?set PDFHQ_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. Os exemplos requerem edição antes do uso e não são testados automaticamente em uma API em execução.
SDKs e fluxos de trabalho verificados
Os SDKs para dez idiomas disponíveis para download cobrem atualmente apenas task API , não a superfície completa de IA, assinatura ou espaço de trabalho. A geração de serviço completo requer um contrato OpenAPI verificado em tempo de execução.