80 / 80 les opérations de développeur découvertes ont des schémas enregistrés. Les exemples sont générés à partir de ces schémas et sont des exemples de documentation. Le laboratoire API optionnel ci-dessous ne permet que les demandes GET en lecture seule sélectionnées avec une clé de projet en mémoire ; il n'effectue jamais d'opérations facturables.
Un contrat enregistré n'est pas la preuve d'une fonctionnalité déployée. Les opérations d'IA et de signature peuvent être limitées ou réservées au bac à sable. Consultez les guides du fournisseur et de la version.
Toutes les catégories 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 Choisir une langue · faites défiler horizontalement pour les 10 langages SDK
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
Opération API (80 correspondance)
GET /v1/ai/billing/balance — Consulter votre portefeuille partagé de crédits HQ GET /v1/ai/billing/models — Découvrez les modèles IA PDFHQ sélectionnés et la disponibilité tarifée GET /v1/ai/billing/prices — Lister les prix PDFHQ IA actifs POST /v1/ai/billing/quotes — Citer l'utilisation de l'IA PDFHQ dans les deux devises GET /v1/ai/billing/quotes/{quote_id} — Inspecter un devis IA détenu par le compte existant POST /v1/ai/edit-plans/from-job — Revalidez une suggestion de modification de page AI payante par rapport à son PDF scellé d'origine et émettez un jeton d'évaluation par l'utilisateur. POST /v1/ai/edit-plans/preview — Prévisualisez les modifications PDF déterministes en anglais simple sans débiter de crédits GET /v1/ai/jobs — Lister vos tâches de documents IA POST /v1/ai/jobs — Démarrer une opération documentaire IA avec devis en crédits HQ POST /v1/ai/jobs/invoices/batch.xlsx — Exportez jusqu'à dix tâches de facture déjà complétées dans un classeur de révision GET /v1/ai/jobs/usage — Utilisation des tâches IA au niveau du compte et décompte des jetons (aucun contenu de document) DELETE /v1/ai/jobs/{job_id} — Supprimer un résultat de document IA terminé GET /v1/ai/jobs/{job_id} — Interroger le statut et le résultat IA cité GET /v1/ai/jobs/{job_id}/comparison.csv — Exportez les modifications de contrat citées pour examen humain en tant que CSV sécurisé GET /v1/ai/jobs/{job_id}/comparison.xlsx — Télécharger un classeur d'examen des modifications de contrat lié à la source GET /v1/ai/jobs/{job_id}/conversation — Lisez les tours cités d'une conversation possédée et non expirée GET /v1/ai/jobs/{job_id}/evidence.csv — Exportez les extraits de source cités d'un résultat IA dont vous êtes propriétaire pour examen humain privé GET /v1/ai/jobs/{job_id}/export.{fmt} — Téléchargez un résultat d'examen IA privé et validé par citation (JSON, PDF, DOCX ou XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Exporter les postes de facture cités pour examen humain GET /v1/ai/jobs/{job_id}/invoice.csv — Exporter les champs de facture pour examen en tant que CSV sécurisé GET /v1/ai/jobs/{job_id}/invoice.xlsx — Télécharger un classeur d'examen de facture lié au compte et aux preuves GET /v1/document-jobs — Lister les tâches de document récentes limitées au compte et à la clé API POST /v1/document-jobs — Traiter les PDF importés de manière asynchrone GET /v1/document-jobs/{job_id}/download-url — Obtenir une URL de téléchargement direct temporaire POST /v1/documents/uploads — Créer un importation PDF directe DELETE /v1/documents/uploads/{upload_id} — Supprimer un document importé inutilisé GET /v1/documents/uploads/{upload_id} — Inspectez un document importé POST /v1/documents/uploads/{upload_id}/complete — Vérifier et sceller le PDF importé GET /v1/documents/uploads/{upload_id}/evidence — Extraire le texte cité par page d'un PDF vérifié (aperçu limité) GET /v1/documents/uploads/{upload_id}/form-fields — Découvrez les noms de champs AcroForm pris en charge, les types et les numéros de page GET /v1/esign/envelopes — Listez vos propres demandes de signature POST /v1/esign/envelopes — Créer un brouillon de demande de signature électronique DELETE /v1/esign/envelopes/{envelope_id} — Abandonnez un brouillon non envoyé sans contacter le fournisseur GET /v1/esign/envelopes/{envelope_id} — Obtenir le statut de la demande de signature PATCH /v1/esign/envelopes/{envelope_id} — Modifier un brouillon de signature non envoyé en utilisant une version de brouillon exacte POST /v1/esign/envelopes/{envelope_id}/archive — Enregistrez un PDF signé complété par le prestataire dans le stockage privé GET /v1/esign/envelopes/{envelope_id}/audit — Lire l'intégrité de la signature électronique au niveau du compte et la réception d'événement GET /v1/esign/envelopes/{envelope_id}/download-url — Émettre une URL de téléchargement de document signé privé à courte durée de vie POST /v1/esign/envelopes/{envelope_id}/remind — Envoyer un rappel signataire sandbox par 24 heures, sans nouvelles tentatives GET /v1/esign/envelopes/{envelope_id}/reminders — Lister les reçus de tentative de rappel privé sans adresses e-mail du signataire POST /v1/esign/envelopes/{envelope_id}/send — Envoyer une demande de signature sandbox explicitement approuvée POST /v1/esign/envelopes/{envelope_id}/sync — Actualiser une demande sandbox du fournisseur de signature sans renvoyer GET /v1/esign/envelopes/{envelope_id}/timeline — Lire la chronologie d'activité de la demande de signature sécurisée pour la confidentialité POST /v1/esign/envelopes/{envelope_id}/validate — Valider la mise en page du champ de brouillon par rapport au PDF source scellé POST /v1/esign/envelopes/{envelope_id}/void — Mettre en file d'attente l'annulation d'une demande de signature en sandbox ; vérifier l'état final séparément GET /v1/esign/providers — Lister les fournisseurs de signature électronique et leur disponibilité réelle GET /v1/esign/reports/export.csv — Exporter les métadonnées opérationnelles de demande de signature privée en CSV GET /v1/esign/reports/summary — Résumé d'activité des demandes de signature du bac à sable privé GET /v1/task-tools — Lister les opérations et paramètres de tâche PDF disponibles GET /v1/task-tools/{tool} — Décrire une opération de tâche et ses options acceptées GET /v1/tasks — Listez vos tâches de document POST /v1/tasks — Démarrer une tâche de document DELETE /v1/tasks/{task_id} — Abandonner une tâche en attente GET /v1/tasks/{task_id} — Récupérer le statut de la tâche GET /v1/tasks/{task_id}/download-url — Obtenir l'URL de téléchargement de sortie privée d'une tâche POST /v1/tasks/{task_id}/files — Joindre une importation vérifiée à une tâche en attente POST /v1/tasks/{task_id}/process — Mettre en file d'attente et mesurer une tâche de document GET /v1/tasks/{task_id}/quote — Estimer les crédits HQ pour une tâche en attente à partir d'importations vérifiées POST /v1/tasks/{task_id}/uploads — Créer un ticket d'importation pour une tâche POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Sceller un PDF importé et le joindre à la tâche GET /v1/webhooks — Lister uniquement les abonnements webhook de ce projet POST /v1/webhooks — Abonnez-vous aux événements client signés avec portée de projet GET /v1/webhooks/deliveries — Inspectez les statuts de livraison délimités sans charges utiles confidentielles POST /v1/webhooks/deliveries/{delivery_id}/replay — Relire la livraison morte après correction du destinataire DELETE /v1/webhooks/{subscription_id} — Révoquer un abonnement webhook limité au projet POST /v1/webhooks/{subscription_id}/rotate — Faire pivoter le secret ; révéler le remplacement une fois POST /v1/webhooks/{subscription_id}/test — Mettre en file d'attente un événement de test d'abonnement synthétique GET /v1/workspace/documents — Lister les documents POST /v1/workspace/documents — Enregistrer le document DELETE /v1/workspace/documents/{document_id} — Supprimer le document GET /v1/workspace/documents/{document_id} — Obtenir le document PATCH /v1/workspace/documents/{document_id} — Mettre à jour le document GET /v1/workspace/documents/{document_id}/activity — Activité du document GET /v1/workspace/documents/{document_id}/handoff — Options de transfert POST /v1/workspace/documents/{document_id}/handoff/ai — Transférer à l'IA POST /v1/workspace/documents/{document_id}/handoff/signing — Transfert à la signature POST /v1/workspace/documents/{document_id}/handoff/task — Transfert à la tâche GET /v1/workspace/documents/{document_id}/preview — Aperçu du document GET /v1/workspace/documents/{document_id}/preview-url — URL d'aperçu du document PUT /v1/workspace/documents/{document_id}/retention — Définir la rétention Schéma inclus Disponibilité restreinte Consulter votre portefeuille partagé de crédits HQ
Demander un contrat — snapshot OpenAPI archivé
Authentification : APIKeyHeader · Réponses documentées : 200, 422
Aucun corps de requête JSON déclaré.
Laboratoire API authentifié
Lecture seule · Aucune consommation de crédit Exécutez les demandes GET sécurisées sélectionnées contre l'API PDFHQ publiée. Une clé de projet est conservée uniquement dans la mémoire de cet onglet. Ne collez jamais les identifiants du fournisseur, les identifiants de paiement ou une clé de production sur un ordinateur partagé.
# 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. Les exemples nécessitent une édition avant utilisation et ne sont pas automatiquement testés par rapport à une API en cours d'exécution.
SDK et flux de travail vérifiés
Les kits SDK téléchargeables en dix langues couvrent actuellement le API de tâche uniquement , pas la surface complète d'IA, de signature ou d'espace de travail. La génération de service complet nécessite un contrat OpenAPI vérifié à l'exécution.