Document Library API und sichere Workflow-Übergaben
Registriere versiegelte PDF-Uploads, inspiziere private Metadaten und Aktivitäten, verkürze die Aufbewahrung und verwende einen bestehenden Upload in Aufgaben, angebotenen KI-Jobs oder Sandbox-Signaturen wieder.
Vorhandenes, versiegeltes PDF registrieren#
Lade zuerst direkt in privaten Speicher mit POST /v1/documents/uploads und POST /v1/documents/uploads/{upload_id}/complete hoch. Ein Upload ist erst nach dem Versiegeln und Überprüfen durch den Server verwendbar. API-Schlüssel sind auf das ursprüngliche HQTools-Konto und das API-Projekt beschränkt.
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 listet nur verfügbare Referenzen auf. GET /v1/workspace/documents/{document_id} prüft erneut die ursprüngliche Upload-Berechtigung und das Ablaufdatum. DELETE entfernt den Bibliothekseintrag, nicht den zugrunde liegenden gespeicherten Upload.
Private Vorschau und Aufbewahrung#
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_KEYDer preview-url-Endpunkt gibt eine autorisierte URL für privaten Speicher mit einer maximalen Lebensdauer von 60 Sekunden zurück, begrenzt durch Quellen- und Bibliotheksaufbewahrung. Behandle seine signierte Abfrage als Geheimnis und protokolliere oder speichere sie nicht. Der veraltete preview-Endpunkt ist auf 4 MiB begrenzt und überprüft die versiegelte Quelle vor der Rückgabe von Bytes. GET-Aktivitätsdatensätze sind auf dasselbe Konto und API-Projekt begrenzt. PUT /retention kann nur die Bibliotheksverfügbarkeit verkürzen; es kann die Aufbewahrung versiegelter Uploads nicht verlängern.
Übergabe an PDF-Verarbeitung, AI Studio oder Signierung#
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}]}Die Aufgabenübergabe löst keine Belastung aus. Bei der KI-Übergabe gelten das reguläre Preisangebot, die Zustimmung zu externer KI, die Projektisolierung und die Zulassung über ein einziges HQ-Guthabenkonto. Beim Signieren wird nur ein Entwurf erstellt: Das Senden einer Sandbox-Anfrage erfordert eine weitere ausdrückliche Bestätigung. Abgelaufene oder fremde Dokumente werden immer abgelehnt.
