API da Biblioteca de Documentos e transferências de fluxo de trabalho seguro
Registre uploads de PDF selados de propriedade, inspecione metadados privados e atividade, encurte a retenção e reutilize um upload existente em tarefas, trabalhos de IA cotados ou rascunhos de assinatura em sandbox.
Registrar um PDF selado existente#
Primeiro faça upload diretamente para armazenamento privado com POST /v1/documents/uploads e POST /v1/documents/uploads/{upload_id}/complete. Um upload só é utilizável após o servidor lacrar e verificá-lo. As chaves de API têm escopo para a conta HQTools original e projeto de API.
POST https://api.pdfhq.io/v1/workspace/documents
x-api-key: PROJECT_API_KEY
Content-Type: application/json
{"upload_id":"SEALED_UPLOAD_UUID","title":"Review draft"}GET /v1/workspace/documents lista apenas referências disponíveis. GET /v1/workspace/documents/{document_id} verifica novamente a propriedade do upload original e a expiração. DELETE remove a entrada da biblioteca, não o upload armazenado subjacente.
Visualização privada e retenção#
GET https://api.pdfhq.io/v1/workspace/documents/DOCUMENT_UUID/preview-url
x-api-key: PROJECT_API_KEY
GET https://api.pdfhq.io/v1/workspace/documents/DOCUMENT_UUID/activity
x-api-key: PROJECT_API_KEYO endpoint preview-url retorna uma URL autorizada para armazenamento privado com tempo de vida máximo de 60 segundos, limitado pela retenção de origem e biblioteca. Trate sua consulta assinada como um segredo e não a registre ou armazene em cache. O endpoint preview descontinuado é limitado a 4 MiB e verifica a origem selada antes de retornar bytes. Os registros de atividade GET são limitados à mesma conta e projeto de API. PUT /retention pode apenas encurtar a disponibilidade da biblioteca; não pode estender a retenção de upload selado.
Transferência para processamento de PDF, AI Studio ou assinatura#
POST https://api.pdfhq.io/v1/workspace/documents/DOCUMENT_UUID/handoff/task
x-api-key: PROJECT_API_KEY
Content-Type: application/json
{"task_id":"OWNED_TASK_UUID"}
POST https://api.pdfhq.io/v1/workspace/documents/DOCUMENT_UUID/handoff/ai
x-api-key: PROJECT_API_KEY
Idempotency-Key: NEW_IDEMPOTENCY_KEY
Content-Type: application/json
{"operation":"pdfhq.ai.summarize","quote_id":"OWNED_HQTOOLS_QUOTE","question":"Key risks?","allow_external_ai":true}
POST https://api.pdfhq.io/v1/workspace/documents/DOCUMENT_UUID/handoff/signing
x-api-key: PROJECT_API_KEY
Content-Type: application/json
{"provider":"managed","title":"Review agreement","subject":"Please review","signers":[{"name":"Sample Signer","email":"signer@example.com","order":0}]}A transferência de uma tarefa não gera uma cobrança. A transferência para IA exige o orçamento normal, o consentimento para IA externa, o isolamento do projeto e a admissão através de uma única carteira de créditos HQ. A assinatura cria apenas um rascunho: enviar um pedido de teste exige confirmação explícita independente. Documentos expirados ou pertencentes a terceiros nunca são aceites.
