80 / 80 le operazioni di sviluppo scoperte hanno schemi registrati. Gli esempi sono generati da tali schemi e sono esempi di documentazione. Il laboratorio API facoltativo sottostante consente solo richieste GET selezionate di sola lettura con una chiave di progetto in memoria; non esegue mai operazioni a pagamento.
Un contratto registrato non è prova di una funzione distribuita. Le operazioni di IA e firma possono essere limitate o solo sandbox. Consulta le guide del provider e della release.
Tutte le categorie API AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Scegli una lingua · scorri orizzontalmente per tutti i 10 linguaggi SDK
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
Operazione API (80 corrispondenza)
GET /v1/ai/billing/balance — Visualizza il portafoglio condiviso di crediti HQ GET /v1/ai/billing/models — Scopri i modelli PDFHQ AI curati e la disponibilità dei prezzi GET /v1/ai/billing/prices — Elenca i prezzi PDFHQ AI attivi POST /v1/ai/billing/quotes — Cita l'utilizzo di PDFHQ AI in entrambe le valute GET /v1/ai/billing/quotes/{quote_id} — Ispeziona un preventivo AI di proprietà dell'account esistente POST /v1/ai/edit-plans/from-job — Convalida un suggerimento di modifica pagina AI a pagamento rispetto al PDF sigillato originale e rilascia un token di revisione utente POST /v1/ai/edit-plans/preview — Visualizza in anteprima le modifiche deterministiche alle pagine PDF in inglese semplice senza addebitare crediti GET /v1/ai/jobs — Elenca i tuoi job di documenti AI POST /v1/ai/jobs — Avvia un'operazione documentale AI con preventivo in crediti HQ POST /v1/ai/jobs/invoices/batch.xlsx — Esporta fino a dieci lavori di fattura già completati in una cartella di lavoro di revisione GET /v1/ai/jobs/usage — Utilizzo dei job AI con ambito account e conteggi dei token (nessun contenuto del documento) DELETE /v1/ai/jobs/{job_id} — Elimina un risultato di documento AI completato GET /v1/ai/jobs/{job_id} — Sonda lo stato e il risultato AI citato GET /v1/ai/jobs/{job_id}/comparison.csv — Esporta le modifiche contrattuali citate per la revisione umana come CSV sicuro GET /v1/ai/jobs/{job_id}/comparison.xlsx — Scarica una cartella di lavoro di revisione delle modifiche contrattuali collegata alla fonte GET /v1/ai/jobs/{job_id}/conversation — Leggi i turni citati di una conversazione posseduta e non scaduta GET /v1/ai/jobs/{job_id}/evidence.csv — Esporta gli estratti di fonte citati di un risultato AI di proprietà per revisione umana privata GET /v1/ai/jobs/{job_id}/export.{fmt} — Scarica un risultato di revisione AI privato e convalidato per citazione (JSON, PDF, DOCX o XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Esporta le voci di fattura citate per la revisione umana GET /v1/ai/jobs/{job_id}/invoice.csv — Esporta campi fattura per revisione come CSV sicuro GET /v1/ai/jobs/{job_id}/invoice.xlsx — Scarica una cartella di revisione delle fatture collegata all'account e alle prove GET /v1/document-jobs — Elenca i lavori documentali recenti con ambito account e chiave API POST /v1/document-jobs — Elabora i PDF caricati in modo asincrono GET /v1/document-jobs/{job_id}/download-url — Ottieni un URL di download diretto temporaneo POST /v1/documents/uploads — Crea un caricamento PDF diretto DELETE /v1/documents/uploads/{upload_id} — Elimina un documento caricato non utilizzato GET /v1/documents/uploads/{upload_id} — Ispeziona un documento caricato POST /v1/documents/uploads/{upload_id}/complete — Verifica e sigilla il PDF caricato GET /v1/documents/uploads/{upload_id}/evidence — Estrai il testo citato dalla pagina da un PDF verificato (anteprima limitata) GET /v1/documents/uploads/{upload_id}/form-fields — Scopri i nomi dei campi AcroForm supportati, i tipi e i numeri di pagina GET /v1/esign/envelopes — Elenca le tue richieste di firma POST /v1/esign/envelopes — Crea una bozza di richiesta di firma elettronica DELETE /v1/esign/envelopes/{envelope_id} — Scarta una bozza non inviata senza contattare il provider GET /v1/esign/envelopes/{envelope_id} — Ottieni lo stato della richiesta di firma PATCH /v1/esign/envelopes/{envelope_id} — Modifica una bozza di firma non inviata utilizzando una versione esatta della bozza POST /v1/esign/envelopes/{envelope_id}/archive — Salva un PDF firmato completato dal provider nell'archivio privato GET /v1/esign/envelopes/{envelope_id}/audit — Leggi l'integrità della firma elettronica con ambito account e la ricevuta dell'evento GET /v1/esign/envelopes/{envelope_id}/download-url — Emetti URL di download di documento firmato privato a breve durata POST /v1/esign/envelopes/{envelope_id}/remind — Invia un promemoria firmatario sandbox per ogni 24 ore, senza tentativi GET /v1/esign/envelopes/{envelope_id}/reminders — Elenca i tentativi di promemoria privati senza indirizzi email del firmatario POST /v1/esign/envelopes/{envelope_id}/send — Invia una richiesta di firma sandbox esplicitamente approvata POST /v1/esign/envelopes/{envelope_id}/sync — Aggiorna una richiesta sandbox dal provider di firma senza rinviare GET /v1/esign/envelopes/{envelope_id}/timeline — Leggi la cronologia dell'attività della richiesta di firma privacy-safe POST /v1/esign/envelopes/{envelope_id}/validate — Convalida il layout del campo bozza rispetto al PDF di origine sigillato POST /v1/esign/envelopes/{envelope_id}/void — Accoda l'annullamento di una richiesta di firma sandbox; verifica lo stato finale separatamente GET /v1/esign/providers — Elenca i provider di eSignature e la loro disponibilità effettiva GET /v1/esign/reports/export.csv — Esporta i metadati operativi della richiesta di firma privata come CSV GET /v1/esign/reports/summary — Riepilogo attività richiesta firma sandbox privato GET /v1/task-tools — Elenca le operazioni e le impostazioni dei task PDF disponibili GET /v1/task-tools/{tool} — Descrivi un'operazione di attività e le sue opzioni accettate GET /v1/tasks — Elenca le tue attività di documento POST /v1/tasks — Avvia un'attività documento DELETE /v1/tasks/{task_id} — Scarta un'attività in sospeso GET /v1/tasks/{task_id} — Recupera lo stato dell'attività GET /v1/tasks/{task_id}/download-url — Ottieni l'URL di download dell'output privato di un'attività POST /v1/tasks/{task_id}/files — Allega un caricamento verificato a un'attività in sospeso POST /v1/tasks/{task_id}/process — Accoda e misura un'attività di documento GET /v1/tasks/{task_id}/quote — Stima HQ Credits per un'attività in sospeso da caricamenti verificati POST /v1/tasks/{task_id}/uploads — Crea un ticket di caricamento per un compito POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Sigilla un PDF caricato e allegalo all'attività GET /v1/webhooks — Elenca solo gli abbonamenti webhook di questo progetto POST /v1/webhooks — Iscriviti agli eventi cliente firmati con ambito progetto GET /v1/webhooks/deliveries — Ispeziona gli stati di consegna con ambito senza payload confidenziali POST /v1/webhooks/deliveries/{delivery_id}/replay — Riprova consegna non riuscita dopo aver corretto il destinatario DELETE /v1/webhooks/{subscription_id} — Revoca un abbonamento webhook con ambito progetto POST /v1/webhooks/{subscription_id}/rotate — Ruota il segreto; rivela la sostituzione una volta POST /v1/webhooks/{subscription_id}/test — Accoda un evento di test di sottoscrizione sintetica GET /v1/workspace/documents — Elenca documenti POST /v1/workspace/documents — Registra documento DELETE /v1/workspace/documents/{document_id} — Rimuovi documento GET /v1/workspace/documents/{document_id} — Ottieni documento PATCH /v1/workspace/documents/{document_id} — Aggiorna documento GET /v1/workspace/documents/{document_id}/activity — Attività documento GET /v1/workspace/documents/{document_id}/handoff — Opzioni di passaggio POST /v1/workspace/documents/{document_id}/handoff/ai — Passaggio a AI POST /v1/workspace/documents/{document_id}/handoff/signing — Passaggio alla firma POST /v1/workspace/documents/{document_id}/handoff/task — Passaggio all'attività GET /v1/workspace/documents/{document_id}/preview — Anteprima documento GET /v1/workspace/documents/{document_id}/preview-url — URL anteprima documento PUT /v1/workspace/documents/{document_id}/retention — Imposta conservazione Schema incluso Disponibilità limitata Visualizza il portafoglio condiviso di crediti HQ
Richiedi contratto — snapshot OpenAPI archiviato
Autenticazione: APIKeyHeader · Risposte documentate: 200, 422
Nessun corpo della richiesta JSON dichiarato.
Lab API autenticato
Sola lettura · Nessun consumo di crediti Esegui le richieste GET sicure selezionate rispetto all'API PDFHQ pubblicata. Una chiave di progetto è mantenuta solo nella memoria di questa scheda. Non incollare mai credenziali del provider, credenziali di pagamento o una chiave di produzione su un computer condiviso.
# 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. Gli esempi richiedono modifiche prima dell'uso e non vengono testati automaticamente rispetto a un'API in esecuzione.
SDK e flussi di lavoro verificati
Gli SDK scaricabili in dieci lingue attualmente coprono solo task API , non la superficie completa di AI, firma o workspace. La generazione full-service richiede un contratto OpenAPI verificato in runtime.