80 / 80 Entdeckte Entwicklervorgänge haben Schemas eingecheckt. Beispiele werden aus diesen Schemas generiert und sind Dokumentationsbeispiele. Das optionale API Lab unten erlaubt nur ausgewählte schreibgeschützte GET-Anfragen mit einem In-Memory-Projektschlüssel; es führt niemals kostenpflichtige Vorgänge durch.
Ein eingecheckter Vertrag ist kein Beweis für eine bereitgestellte Funktion. KI- und Signaturvorgänge können eingeschränkt oder nur im Sandbox-Modus verfügbar sein. Siehe die Anbieter- und Release-Handbücher.
Alle API-Kategorien AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Wähle eine Sprache · scrolle horizontal für alle 10 SDK-Sprachen
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
API-Operation (80 Übereinstimmung)
GET /v1/ai/billing/balance — Gemeinsames HQ-Guthabenkonto anzeigen GET /v1/ai/billing/models — Entdecke kuratierte PDFHQ-KI-Modelle und Preisverfügbarkeit GET /v1/ai/billing/prices — Liste aktive PDFHQ KI-Preise auf POST /v1/ai/billing/quotes — PDFHQ-AI-Nutzung in beiden Währungen anführen GET /v1/ai/billing/quotes/{quote_id} — Inspiziere ein bestehendes, kontogebundenes KI-Angebot POST /v1/ai/edit-plans/from-job — Validiere einen kostenpflichtigen KI-Seitenbearbeitungsvorschlag gegen sein ursprüngliches versiegeltes PDF erneut und stelle ein Benutzer-Review-Token aus POST /v1/ai/edit-plans/preview — Zeigen Sie deterministische PDF-Seitenänderungen in einfachem Englisch in der Vorschau an, ohne dass Credits berechnet werden müssen GET /v1/ai/jobs — Liste deine KI-Dokument-Jobs auf POST /v1/ai/jobs — KI-Dokumentvorgang mit HQ-Guthabenangebot starten POST /v1/ai/jobs/invoices/batch.xlsx — Exportiere bis zu zehn bereits abgeschlossene Rechnungsjobs in eine Überprüfungsarbeitsmappe GET /v1/ai/jobs/usage — Kontogebundene KI-Job-Nutzung und Token-Zählungen (kein Dokumentinhalt) DELETE /v1/ai/jobs/{job_id} — Lösche ein abgeschlossenes KI-Dokumentergebnis GET /v1/ai/jobs/{job_id} — Frage den Status ab und zitiere das KI-Ergebnis GET /v1/ai/jobs/{job_id}/comparison.csv — Zitierte Vertragsänderungen als sichere CSV für menschliche Überprüfung exportieren GET /v1/ai/jobs/{job_id}/comparison.xlsx — Lade eine quellenverknüpfte Vertragänderungsüberprüfungs-Arbeitsmappe herunter GET /v1/ai/jobs/{job_id}/conversation — Lese eine eigene, nicht abgelaufene Konversation mit zitierten Turns GET /v1/ai/jobs/{job_id}/evidence.csv — Exportiere die zitierten Quellauszüge eines eigenen KI-Ergebnisses zur privaten menschlichen Überprüfung GET /v1/ai/jobs/{job_id}/export.{fmt} — Laden Sie ein privates, durch Zitate validiertes KI-Überprüfungsergebnis herunter (JSON, PDF, DOCX oder XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Exportiere zitierte Rechnungspositionen zur manuellen Überprüfung GET /v1/ai/jobs/{job_id}/invoice.csv — Exportiere Rechnungsfelder zur Überprüfung als sichere CSV GET /v1/ai/jobs/{job_id}/invoice.xlsx — Lade eine kontoscoped, nachweisgebundene Rechnungsüberprüfungs-Arbeitsmappe herunter GET /v1/document-jobs — Liste der letzten Dokument-Jobs mit Konto- und API-Schlüssel-Bereich POST /v1/document-jobs — Hochgeladene PDFs asynchron verarbeiten GET /v1/document-jobs/{job_id}/download-url — Temporäre direkte Download-URL abrufen POST /v1/documents/uploads — Erstelle einen direkten PDF-Upload DELETE /v1/documents/uploads/{upload_id} — Lösche ein ungenutztes hochgeladenes Dokument GET /v1/documents/uploads/{upload_id} — Hochgeladenes Dokument inspizieren POST /v1/documents/uploads/{upload_id}/complete — Verifiziere und versiegle hochgeladene PDF GET /v1/documents/uploads/{upload_id}/evidence — Extrahiere seitenzitierter Text aus einer verifizierten PDF (begrenzte Vorschau) GET /v1/documents/uploads/{upload_id}/form-fields — Entdecke unterstützte AcroForm-Feldnamen, -typen und Seitennummern GET /v1/esign/envelopes — Deine eigenen Signaturanfragen auflisten POST /v1/esign/envelopes — Erstelle einen eSignature-Anfrage-Entwurf DELETE /v1/esign/envelopes/{envelope_id} — Verwerfe einen ungesendeten Entwurf, ohne den Anbieter zu kontaktieren GET /v1/esign/envelopes/{envelope_id} — Signaturanfrage-Status abrufen PATCH /v1/esign/envelopes/{envelope_id} — Bearbeite einen ungesendeten Signaturauszug mit einer exakten Auszugsversion POST /v1/esign/envelopes/{envelope_id}/archive — Speichere ein von einem Anbieter signiertes PDF im privaten Speicher GET /v1/esign/envelopes/{envelope_id}/audit — Lese die Integrität und den Ereignisbeleg der eSignatur im Kontobereich GET /v1/esign/envelopes/{envelope_id}/download-url — Gib eine kurzlebige private signierte Download-URL für Dokumente aus POST /v1/esign/envelopes/{envelope_id}/remind — Sende eine Sandbox-Unterzeichner-Erinnerung pro 24 Stunden, ohne Wiederholungen GET /v1/esign/envelopes/{envelope_id}/reminders — Liste private Erinnerungsversuch-Quittungen ohne E-Mail-Adressen des Unterzeichners auf POST /v1/esign/envelopes/{envelope_id}/send — Sende eine explizit genehmigt Sandbox-Signaturanfrage POST /v1/esign/envelopes/{envelope_id}/sync — Sandbox-Anfrage vom Signaturanbieter aktualisieren, ohne erneut zu senden GET /v1/esign/envelopes/{envelope_id}/timeline — Lese eine datenschutzsichere Aktivitätszeitachse für Signaturanfragen POST /v1/esign/envelopes/{envelope_id}/validate — Validiere das Entwurfs-Feldlayout gegen die versiegelte Quell-PDF POST /v1/esign/envelopes/{envelope_id}/void — Stelle eine Sandbox-Signaturanfrage-Stornierung in die Warteschlange; überprüfe den Endzustand separat GET /v1/esign/providers — eSignatur-Anbieter und deren tatsächliche Verfügbarkeit auflisten GET /v1/esign/reports/export.csv — Operationale Metadaten der privaten Signaturanfrage als CSV exportieren GET /v1/esign/reports/summary — Zusammenfassung der privaten Sandbox-Signaturanforderungsaktivität GET /v1/task-tools — Liste verfügbare PDF-Task-Operationen und Einstellungen auf GET /v1/task-tools/{tool} — Beschreibe einen Task-Vorgang und seine akzeptierten Optionen GET /v1/tasks — Deine Document-Tasks auflisten POST /v1/tasks — Dokumentaufgabe starten DELETE /v1/tasks/{task_id} — Verwerfe eine wartende Aufgabe GET /v1/tasks/{task_id} — Task-Status abrufen GET /v1/tasks/{task_id}/download-url — Rufe die private Download-URL der Task-Ausgabe ab POST /v1/tasks/{task_id}/files — Hänge einen verifizierten Upload an eine wartende Aufgabe an POST /v1/tasks/{task_id}/process — Stelle einen Dokumenttask in die Warteschlange und messe ihn GET /v1/tasks/{task_id}/quote — Schätze HQ Credits für einen wartenden Task aus verifizierten Uploads POST /v1/tasks/{task_id}/uploads — Erstelle ein Upload-Ticket für eine Aufgabe POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Versiegle ein hochgeladenes PDF und hänge es an die Task an GET /v1/webhooks — Nur die Webhook-Abos dieses Projekts auflisten POST /v1/webhooks — Abonniere projektgebundene signierte Kundenereignisse GET /v1/webhooks/deliveries — Inspiziere begrenzte Zustellungsstatus ohne vertrauliche Nutzlasten POST /v1/webhooks/deliveries/{delivery_id}/replay — Wiederhole tote Zustellung nach Korrektur des Empfängers DELETE /v1/webhooks/{subscription_id} — Widerrufe ein Project-gestütztes Webhook-Abonnement POST /v1/webhooks/{subscription_id}/rotate — Geheimnis rotieren; Ersatz einmalig anzeigen POST /v1/webhooks/{subscription_id}/test — Stelle ein synthetisches Abonnement-Testereignis in die Warteschlange GET /v1/workspace/documents — Dokumente auflisten POST /v1/workspace/documents — Dokument registrieren DELETE /v1/workspace/documents/{document_id} — Dokument entfernen GET /v1/workspace/documents/{document_id} — Dokument abrufen PATCH /v1/workspace/documents/{document_id} — Dokument aktualisieren GET /v1/workspace/documents/{document_id}/activity — Dokumentaktivität GET /v1/workspace/documents/{document_id}/handoff — Übergabeoptionen POST /v1/workspace/documents/{document_id}/handoff/ai — Übergabe an KI POST /v1/workspace/documents/{document_id}/handoff/signing — Übergabe zum Signieren POST /v1/workspace/documents/{document_id}/handoff/task — Übergabe an Task GET /v1/workspace/documents/{document_id}/preview — Dokument anzeigen GET /v1/workspace/documents/{document_id}/preview-url — Dokument-Vorschau-URL PUT /v1/workspace/documents/{document_id}/retention — Aufbewahrung festlegen Schema enthalten Verfügbarkeit eingeschränkt Gemeinsames HQ-Guthabenkonto anzeigen
Request contract — eingecheckter OpenAPI-Snapshot
Authentifizierung: APIKeyHeader · Dokumentierte Antworten: 200, 422
Kein JSON-Request-Body deklariert.
Authentifiziertes API-Labor
Schreibgeschützt · Keine Kreditnutzung Führen Sie ausgewählte sichere GET-Anfragen für die veröffentlichte PDFHQ-API aus. Ein Projektschlüssel wird nur im Speicher dieser Registerkarte gespeichert. Fügen Sie niemals Anbieteranmeldeinformationen, Zahlungsanmeldeinformationen oder einen Produktionsschlüssel auf einem gemeinsam genutzten Computer ein.
# 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. Beispiele erfordern Bearbeitung vor der Verwendung und werden nicht automatisch gegen eine laufende API getestet.
SDKs und verifizierte Workflows
Die herunterladbaren zehnsprachigen SDKs decken derzeit ab nur Task-API , nicht die vollständige KI-, Signatur- oder Workspace-Oberfläche. Die vollständige Diensterzeugung erfordert einen zur Laufzeit verifizierten OpenAPI-Vertrag.