80 / 80 keşfedilen geliştirici işlemleri kontrol edilmiş şemaları içerir. Örnekler bu şemalardan oluşturulur ve belgeleme örnekleridir. Aşağıdaki iste ğe bağlı API Lab yalnızca bellek içi proje anahtarıyla seçili salt okunur GET isteklerine izin verir; hiçbir zaman ücretli işlemler gerçekleştirmez.
İşaretlenmiş bir sözleşme, dağıtılan bir özelliğin kanıtı değildir. AI ve imzalama işlemleri sınırlandırılmış veya sandbox-only olabilir. Sağlayıcı ve yayın kılavuzlarına bakın.
Tüm API kategorileri AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Bir dil seçin · tüm 10 SDK dili için yatay kaydırın
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
API işlemi (80 eşleşme)
GET /v1/ai/billing/balance — Paylaşılan HQ kredisi cüzdanınızı görüntüleyin GET /v1/ai/billing/models — Seçilmiş PDFHQ AI modellerini ve fiyatlandırılmış kullanılabilirliği keşfedin GET /v1/ai/billing/prices — Etkin PDFHQ AI fiyatlarını listele POST /v1/ai/billing/quotes — PDFHQ AI kullanımını her iki para biriminde alıntılayın GET /v1/ai/billing/quotes/{quote_id} — Mevcut hesaba ait AI teklifini incele POST /v1/ai/edit-plans/from-job — Ödenen bir AI sayfa düzenleme önerisini orijinal mühürlü PDF'ye karşı yeniden doğrulayın ve kullanıcı incelemesi jetonu verin POST /v1/ai/edit-plans/preview — Belirleyici düz İngilizce PDF sayfa değişikliklerini kredi harcamadan önizleyin GET /v1/ai/jobs — AI belge işlerinizi listeleyin POST /v1/ai/jobs — HQ kredisi teklifiyle yapay zekâ belge işlemi başlatın POST /v1/ai/jobs/invoices/batch.xlsx — En fazla on tamamlanmış fatura işini bir inceleme çalışma kitabına aktarın GET /v1/ai/jobs/usage — Hesap kapsamlı AI iş kullanımı ve token sayıları (belge içeriği yok) DELETE /v1/ai/jobs/{job_id} — Tamamlanan bir AI belge sonucunu silin GET /v1/ai/jobs/{job_id} — Durumu ve alıntı yapılan AI sonucunu yokla GET /v1/ai/jobs/{job_id}/comparison.csv — İnsan incelemesi için alıntılı sözleşme değişikliklerini güvenli CSV olarak dışa aktarın GET /v1/ai/jobs/{job_id}/comparison.xlsx — Kaynak bağlantılı sözleşme değişikliği inceleme çalışma kitabını indirin GET /v1/ai/jobs/{job_id}/conversation — Sahip olunan, süresi dolmamış bir konuşmanın alıntılı turlarını oku GET /v1/ai/jobs/{job_id}/evidence.csv — Sahip olunan bir AI sonucunun alıntı yapılan kaynak alıntılarını özel insan incelemesi için dışa aktarın GET /v1/ai/jobs/{job_id}/export.{fmt} — Özel, alıntı doğrulanmış AI inceleme sonucunu indirin (JSON, PDF, DOCX veya XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Alıntı yapılan fatura satır öğelerini insan incelemesi için dışa aktarın GET /v1/ai/jobs/{job_id}/invoice.csv — İnceleme için fatura alanlarını güvenli CSV olarak dışa aktarın GET /v1/ai/jobs/{job_id}/invoice.xlsx — Hesap kapsamlı, kanıt bağlantılı fatura inceleme çalışma kitabını indir GET /v1/document-jobs — Son hesap ve API anahtarı kapsamlı belge işlerini listele POST /v1/document-jobs — Yüklenen PDF'leri eşzamansız olarak işleyin GET /v1/document-jobs/{job_id}/download-url — Geçici doğrudan indirme URL'si al POST /v1/documents/uploads — Doğrudan PDF yüklemesi oluştur DELETE /v1/documents/uploads/{upload_id} — Kullanılmayan yüklenen belgeyi sil GET /v1/documents/uploads/{upload_id} — Yüklenen bir belgeyi inceleyin POST /v1/documents/uploads/{upload_id}/complete — Yüklenen PDF'yi doğrula ve mühürle GET /v1/documents/uploads/{upload_id}/evidence — Doğrulanmış bir PDF'den sayfa alıntılı metni çıkar (sınırlı önizleme) GET /v1/documents/uploads/{upload_id}/form-fields — Desteklenen AcroForm alan adlarını, türlerini ve sayfa numaralarını keşfedin GET /v1/esign/envelopes — Kendi imza taleplerini listeleyin POST /v1/esign/envelopes — E-imza isteği taslağı oluştur DELETE /v1/esign/envelopes/{envelope_id} — Sağlayıcıyla iletişim kurmadan gönderilmemiş taslağı at GET /v1/esign/envelopes/{envelope_id} — İmza isteği durumunu al PATCH /v1/esign/envelopes/{envelope_id} — Gönderilmemiş imza taslağını tam taslak sürümü kullanarak düzenleyin POST /v1/esign/envelopes/{envelope_id}/archive — Sağlayıcı tarafından tamamlanan imzalı PDF'yi özel depolamaya kaydedin GET /v1/esign/envelopes/{envelope_id}/audit — Hesap kapsamlı eSignature bütünlüğünü ve olay makbuzunu oku GET /v1/esign/envelopes/{envelope_id}/download-url — Kısa ömürlü özel imzalı belge indirme URL'si yayınla POST /v1/esign/envelopes/{envelope_id}/remind — 24 saatte bir sandbox imzacısına hatırlatma gönderin, yeniden denemeler olmadan GET /v1/esign/envelopes/{envelope_id}/reminders — İmzalayan e-posta adresleri olmadan özel hatırlatma denemesi makbuzlarını listele POST /v1/esign/envelopes/{envelope_id}/send — Açıkça onaylanmış bir sandbox imza isteği gönderin POST /v1/esign/envelopes/{envelope_id}/sync — İmza sağlayıcısından bir sandbox isteğini yeniden göndermeden yenile GET /v1/esign/envelopes/{envelope_id}/timeline — Gizlilik açısından güvenli bir imza isteği etkinlik zaman çizelgesini okuyun POST /v1/esign/envelopes/{envelope_id}/validate — Taslak alan düzenini mühürlü kaynak PDF'ye karşı doğrula POST /v1/esign/envelopes/{envelope_id}/void — Sandbox imzalama isteği iptalini kuyruğa alın; son durumu ayrı olarak doğrulayın GET /v1/esign/providers — eİmza sağlayıcılarını ve gerçek kullanılabilirliklerini listele GET /v1/esign/reports/export.csv — Özel imza isteği işletim meta verilerini CSV olarak dışa aktar GET /v1/esign/reports/summary — Özel korumalı alan imza isteği etkinlik özeti GET /v1/task-tools — Mevcut PDF görev işlemlerini ve ayarlarını listele GET /v1/task-tools/{tool} — Bir görev işlemini ve kabul edilen seçeneklerini açıklayın GET /v1/tasks — Belge görevlerinizi listeleyin POST /v1/tasks — Belge görevini başlatın DELETE /v1/tasks/{task_id} — Bekleyen görevi iptal et GET /v1/tasks/{task_id} — Görev durumunu al GET /v1/tasks/{task_id}/download-url — Bir görevin özel çıktı indirme URL'sini al POST /v1/tasks/{task_id}/files — Doğrulanmış bir yüklemeyi bekleyen bir göreve ekleyin POST /v1/tasks/{task_id}/process — Belge görevini kuyruğa alın ve ölçün GET /v1/tasks/{task_id}/quote — Doğrulanmış yüklemelerden bekleme görevinin HQ Kredilerini tahmin edin POST /v1/tasks/{task_id}/uploads — Bir görev için yükleme bileti oluştur POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Yüklenen bir PDF'yi mühürleyin ve göreve ekleyin GET /v1/webhooks — Yalnızca bu projenin webhook aboneliklerini listele POST /v1/webhooks — Proje kapsamlı imzalı müşteri etkinliklerine abone olun GET /v1/webhooks/deliveries — Kapsamlı teslim durumlarını gizli yüklemeler olmadan inceleyin POST /v1/webhooks/deliveries/{delivery_id}/replay — Alıcıyı düzelttikten sonra başarısız teslimatı yeniden oynatın DELETE /v1/webhooks/{subscription_id} — Proje kapsamlı webhook aboneliğini iptal et POST /v1/webhooks/{subscription_id}/rotate — Sırrı döndürün; değiştirmeyi bir kez ortaya çıkarın POST /v1/webhooks/{subscription_id}/test — Bir sentetik abonelik test olayını kuyruğa al GET /v1/workspace/documents — Belgeleri listele POST /v1/workspace/documents — Belgeyi kaydet DELETE /v1/workspace/documents/{document_id} — Belgeyi kaldır GET /v1/workspace/documents/{document_id} — Belge al PATCH /v1/workspace/documents/{document_id} — Belgeyi güncelle GET /v1/workspace/documents/{document_id}/activity — Belge etkinliği GET /v1/workspace/documents/{document_id}/handoff — Devir seçenekleri POST /v1/workspace/documents/{document_id}/handoff/ai — AI'ye devret POST /v1/workspace/documents/{document_id}/handoff/signing — İmzalamaya devret POST /v1/workspace/documents/{document_id}/handoff/task — Göreve devret GET /v1/workspace/documents/{document_id}/preview — Belgeyi önizle GET /v1/workspace/documents/{document_id}/preview-url — Belge önizleme URL'si PUT /v1/workspace/documents/{document_id}/retention — Saklama süresini ayarla Şema dahil Kullanılabilirlik kısıtlı Paylaşılan HQ kredisi cüzdanınızı görüntüleyin
Sözleşme talep et — kontrol edilmiş OpenAPI anlık görüntüsü
Kimlik doğrulama: APIKeyHeader · Belgelenen yanıtlar: 200, 422
JSON istek gövdesi bildirilmedi.
Kimliği Doğrulanmış API Laboratuvarı
Salt okunur · Kredi tüketimi yok Yayınlanan PDFHQ API'sine karşı seçilen güvenli GET isteklerini yürütün. Proje anahtarı yalnızca bu sekmenin belleğinde tutulur. Sağlayıcı kimlik bilgilerini, ödeme kimlik bilgilerini veya üretim anahtarını paylaşılan bir bilgisayara yapıştırmayın.
# 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. Örnekler kullanımdan önce düzenlenmesi gerekir ve çalışan bir API'ye karşı otomatik olarak test edilmez.
SDK'lar ve doğrulanmış iş akışları
İndirilebilir on dilli SDK'lar şu anda şunları kapsamaktadır: yalnızca task API , tam AI, imzalama veya çalışma alanı yüzeyini değil. Tam hizmet oluşturma, çalışma zamanında doğrulanmış bir OpenAPI sözleşmesi gerektirir.