80 / 80 ontdekte ontwikkelaarsoperaties hebben ingecheckte schema's. Voorbeelden worden gegenereerd op basis van die schema's en zijn documentatievoorbeelden. Het optionele API Lab hieronder staat alleen geselecteerde alleen-lezen GET-aanvragen toe met een in-memory projectsleutel; het voert nooit betaalde operaties uit.
Een ingecheckte overeenkomst is geen bewijs van een geïmplementeerde functie. AI- en ondertekeningstransacties kunnen beperkt of alleen in sandbox zijn. Zie de provider- en releasehandleidingen.
Alle API-categorieën AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Kies een taal · scroll horizontaal voor alle 10 SDK-talen
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
API-bewerking (80 overeenkomend)
GET /v1/ai/billing/balance — Je gedeelde HQ-tegoedportemonnee bekijken GET /v1/ai/billing/models — Ontdek gecureerde PDFHQ AI-modellen en beschikbaarheid met prijzen GET /v1/ai/billing/prices — Lijst actieve PDFHQ AI-prijzen POST /v1/ai/billing/quotes — Citeer PDFHQ AI-gebruik in beide valuta's GET /v1/ai/billing/quotes/{quote_id} — Een bestaande account-eigendom AI-offerte inspecteren POST /v1/ai/edit-plans/from-job — Valideer een betaalde AI-paginabewerkingsvoorstel opnieuw tegen de originele verzegelde PDF en geef een gebruikersbeoordelingstoken uit POST /v1/ai/edit-plans/preview — Bekijk deterministische duidelijke PDF-paginawijzigingen zonder credits in te zetten GET /v1/ai/jobs — Uw AI-documenttaken weergeven POST /v1/ai/jobs — Een AI-documentbewerking met HQ-tegoedofferte starten POST /v1/ai/jobs/invoices/batch.xlsx — Tot tien voltooide factuurtaken in één beoordelingswerkboek exporteren GET /v1/ai/jobs/usage — Accountgerelateerd AI-taakgebruik en tokentelling (geen documentinhoud) DELETE /v1/ai/jobs/{job_id} — Verwijder een voltooid AI-documentresultaat GET /v1/ai/jobs/{job_id} — Poll status en aangehaald AI-resultaat GET /v1/ai/jobs/{job_id}/comparison.csv — Exporteer aangehaalde contractwijzigingen voor menselijke beoordeling als veilige CSV GET /v1/ai/jobs/{job_id}/comparison.xlsx — Download een werkmap voor contractwijzigingscontrole met bronkoppeling GET /v1/ai/jobs/{job_id}/conversation — Een eigendom gelezen, onvervallen gesprek's aangehaalde beurten GET /v1/ai/jobs/{job_id}/evidence.csv — Exporteer de geciteerde bronfragmenten van een eigen AI-resultaat voor privé menselijke beoordeling GET /v1/ai/jobs/{job_id}/export.{fmt} — Download een privé, citatiegevalideerd AI-beoordelingsresultaat (JSON, PDF, DOCX of XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Exporteer aangehaalde factuurregelitems voor menselijke beoordeling GET /v1/ai/jobs/{job_id}/invoice.csv — Factuurvelden voor beoordeling als veilige CSV exporteren GET /v1/ai/jobs/{job_id}/invoice.xlsx — Download een accountbereik, bewijs-gekoppelde factuurbeoordelingswerkmap GET /v1/document-jobs — Lijst met recente document-jobs met account- en API-sleutelbereik POST /v1/document-jobs — Geüploade PDF's asynchroon verwerken GET /v1/document-jobs/{job_id}/download-url — Verkrijg een tijdelijke directe download-URL POST /v1/documents/uploads — Maak een directe PDF-upload DELETE /v1/documents/uploads/{upload_id} — Een ongebruikt geüpload document verwijderen GET /v1/documents/uploads/{upload_id} — Een geüpload document inspecteren POST /v1/documents/uploads/{upload_id}/complete — Verifieer en zegel geüploade PDF GET /v1/documents/uploads/{upload_id}/evidence — Extraheer paginageciteerde tekst uit een geverifieerde PDF (beperkte preview) GET /v1/documents/uploads/{upload_id}/form-fields — Ontdek ondersteunde AcroForm-veldnamen, -typen en paginanummers GET /v1/esign/envelopes — Geef uw eigen ondertekeningsverzoeken weer POST /v1/esign/envelopes — Concept voor e-handtekeningverzoek maken DELETE /v1/esign/envelopes/{envelope_id} — Verwijder een onverzonden concept zonder contact met provider GET /v1/esign/envelopes/{envelope_id} — Handtekeningaanvraagstatus ophalen PATCH /v1/esign/envelopes/{envelope_id} — Een niet-verzonden handtekeningconcept bewerken met een exacte conceptversie POST /v1/esign/envelopes/{envelope_id}/archive — Sla een door de provider voltooide ondertekende PDF op in privéopslag GET /v1/esign/envelopes/{envelope_id}/audit — Lees integriteit en ontvangstbewijzen van e-handtekeningen met accountbereik GET /v1/esign/envelopes/{envelope_id}/download-url — Kortstondige privé ondertekende document-download-URL uitgeven POST /v1/esign/envelopes/{envelope_id}/remind — Stuur één sandbox-ondertekenaar herinnering per 24 uur, zonder pogingen GET /v1/esign/envelopes/{envelope_id}/reminders — Lijst met privéherinneringspoging-ontvangstbewijzen zonder e-mailadressen van ondertekenaars POST /v1/esign/envelopes/{envelope_id}/send — Verzend een expliciet goedgekeurd sandbox-handtekeningverzoek POST /v1/esign/envelopes/{envelope_id}/sync — Een sandboxaanvraag van de ondertekeningsprovider vernieuwen zonder opnieuw in te dienen GET /v1/esign/envelopes/{envelope_id}/timeline — Lees een privacyveilige tijdlijn van ondertekeningsverzoekactiviteiten POST /v1/esign/envelopes/{envelope_id}/validate — Controleer de conceptveldindeling tegen de verzegelde bron-PDF POST /v1/esign/envelopes/{envelope_id}/void — Wachtrij een sandbox signing-request annulering; controleer de eindstatus afzonderlijk GET /v1/esign/providers — eSignature-providers en hun werkelijke beschikbaarheid weergeven GET /v1/esign/reports/export.csv — Exporteer operationele metagegevens van privéhandtekeningverzoeken als CSV GET /v1/esign/reports/summary — Activiteitenoverzicht privé-sandbox handtekeningaanvraag GET /v1/task-tools — Lijst beschikbare PDF-taakbewerkingen en instellingen GET /v1/task-tools/{tool} — Beschrijf een taakbewerking en de geaccepteerde opties GET /v1/tasks — Geef een overzicht van uw documenttaken POST /v1/tasks — Een documenttaak starten DELETE /v1/tasks/{task_id} — Een wachtende taak verwijderen GET /v1/tasks/{task_id} — Taakstatus ophalen GET /v1/tasks/{task_id}/download-url — Download-URL voor privéuitvoer van een taak ophalen POST /v1/tasks/{task_id}/files — Voeg een geverifieerde upload toe aan een wachtende taak POST /v1/tasks/{task_id}/process — Een documenttaak in de wachtrij plaatsen en meten GET /v1/tasks/{task_id}/quote — Schat HQ-tegoeden voor een wachtende taak van geverifieerde uploads POST /v1/tasks/{task_id}/uploads — Maak een uploadticket voor een taak POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Zegel een geüploade PDF en koppel deze aan de taak GET /v1/webhooks — Alleen de webhook-abonnementen van dit project weergeven POST /v1/webhooks — Abonneer u op project-scoped ondertekende klantengebeurtenissen GET /v1/webhooks/deliveries — Inspecteer scoped leveringsstatussen zonder vertrouwelijke payloads POST /v1/webhooks/deliveries/{delivery_id}/replay — Speel mislukte aflevering opnieuw af na correctie van ontvanger DELETE /v1/webhooks/{subscription_id} — Intrekken van een projectscoped webhookabonnement POST /v1/webhooks/{subscription_id}/rotate — Geheim roteren; vervangingspunt eenmaal weergeven POST /v1/webhooks/{subscription_id}/test — Plaats één synthetische abonnementtestgebeurtenis in de wachtrij GET /v1/workspace/documents — Documenten weergeven POST /v1/workspace/documents — Document registreren DELETE /v1/workspace/documents/{document_id} — Document verwijderen GET /v1/workspace/documents/{document_id} — Document ophalen PATCH /v1/workspace/documents/{document_id} — Document bijwerken GET /v1/workspace/documents/{document_id}/activity — Documentactiviteit GET /v1/workspace/documents/{document_id}/handoff — Overdrachtsopties POST /v1/workspace/documents/{document_id}/handoff/ai — Overdracht naar AI POST /v1/workspace/documents/{document_id}/handoff/signing — Overdracht naar ondertekening POST /v1/workspace/documents/{document_id}/handoff/task — Overdracht naar taak GET /v1/workspace/documents/{document_id}/preview — Document voorvertonen GET /v1/workspace/documents/{document_id}/preview-url — Documentvoorbeeldurl PUT /v1/workspace/documents/{document_id}/retention — Retentie instellen Schema inbegrepen Beschikbaarheid beperkt Je gedeelde HQ-tegoedportemonnee bekijken
Contractaanvraag — ingecheckte OpenAPI-snapshot
Verificatie: APIKeyHeader · Gedocumenteerde reacties: 200, 422
Geen JSON-aanvraagtekst gedeclareerd.
Geverifieerd API Lab
Alleen-lezen · Geen kredietverbruik Voer geselecteerde veilige GET-verzoeken uit tegen de gepubliceerde PDFHQ-API. Een projectsleutel wordt alleen in dit tabbladgeheugen opgeslagen. Plak nooit providercredentials, betalingscredentials of een productiesleutel op een gedeelde computer.
# 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. Voorbeelden vereisen bewerking voordat ze worden gebruikt en worden niet automatisch getest tegen een actieve API.
SDK's en geverifieerde workflows
De downloadbare tientalige SDK's dekken momenteel de alleen task API , niet het volledige AI-, ondertekenings- of werkruimteoppervlak. Volledige servicegeneratie vereist een runtime-geverifieerd OpenAPI-contract.