Document Library API en veilige workflowoverdrachten
Registreer eigenaar verzegelde PDF-uploads, inspecteer privémetagegevens en activiteit, verkort retentie en hergebruik een bestaande upload in taken, aangeboden AI-taken of sandbox-ondertekeningsconcepten.
Registreer een bestaande, verzegelde PDF#
Upload eerst rechtstreeks naar privéopslag met POST /v1/documents/uploads en POST /v1/documents/uploads/{upload_id}/complete. Een upload is alleen bruikbaar nadat de server deze heeft verzegeld en geverifieerd. API-sleutels zijn gekoppeld aan het oorspronkelijke HQTools-account en API-project.
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 geeft alleen beschikbare referenties weer. GET /v1/workspace/documents/{document_id} controleert opnieuw het eigenaarschap van de originele upload en vervaldatum. DELETE verwijdert de bibliotheekvermelding, niet de onderliggende opgeslagen upload.
Privévoorbeeld en retentie#
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_KEYHet preview-url-eindpunt retourneert een geautoriseerde URL voor privéopslag met een maximale levensduur van 60 seconden, begrensd door bron- en bibliotheekretentie. Behandel de ondertekende query als een geheim en log of cache het niet. Het verouderde preview-eindpunt is beperkt tot 4 MiB en verifieert de verzegelde bron voordat bytes worden geretourneerd. GET-activiteitenrecords zijn beperkt tot dezelfde account en API-project. PUT /retention kan alleen bibliotheekbeschikbaarheid verkorten; het kan verzegelde-upload-retentie niet verlengen.
Overdracht naar PDF-verwerking, AI Studio of ondertekening#
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}]}Het overdragen van een taak brengt geen kosten in rekening. Voor AI-overdracht gelden de normale prijsopgave, toestemming voor externe AI, projectisolatie en toelating via één HQ-tegoedportemonnee. Ondertekenen maakt alleen een concept: voor het verzenden van een sandboxverzoek is afzonderlijke uitdrukkelijke bevestiging nodig. Verlopen documenten of documenten van anderen worden nooit geaccepteerd.
