80 / 80 operasi pengembang yang ditemukan memiliki skema yang diperiksa. Contoh dihasilkan dari skema tersebut dan merupakan contoh dokumentasi. API Lab opsional di bawah hanya memungkinkan permintaan GET baca-saja yang dipilih dengan kunci proyek dalam memori; itu tidak pernah melakukan operasi yang dapat dikenakan biaya.
Kontrak yang tercatat bukan bukti fitur yang diterapkan. Operasi AI dan penandatanganan mungkin dibatasi atau hanya sandbox. Lihat panduan penyedia dan rilis.
Semua kategori 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 Pilih bahasa · gulir secara horizontal untuk semua 10 bahasa SDK
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
Operasi API (80 cocok)
GET /v1/ai/billing/balance — Lihat dompet kredit HQ bersama Anda GET /v1/ai/billing/models — Temukan model AI PDFHQ yang dikurasi dan ketersediaan harga GET /v1/ai/billing/prices — Daftar harga AI PDFHQ aktif POST /v1/ai/billing/quotes — Kutip penggunaan AI PDFHQ dalam kedua mata uang GET /v1/ai/billing/quotes/{quote_id} — Periksa kutipan AI milik akun yang ada POST /v1/ai/edit-plans/from-job — Validasi ulang saran edit halaman AI berbayar terhadap PDF tersegel aslinya dan terbitkan token tinjauan pengguna POST /v1/ai/edit-plans/preview — Pratinjau perubahan halaman PDF dalam bahasa Inggris yang deterministik tanpa mengenakan kredit GET /v1/ai/jobs — Daftar pekerjaan dokumen AI Anda POST /v1/ai/jobs — Mulai operasi dokumen AI dengan penawaran kredit HQ POST /v1/ai/jobs/invoices/batch.xlsx — Ekspor hingga sepuluh pekerjaan faktur yang sudah selesai ke satu buku kerja tinjauan GET /v1/ai/jobs/usage — Penggunaan job AI dan penghitungan token yang dibatasi akun (tanpa konten dokumen) DELETE /v1/ai/jobs/{job_id} — Hapus hasil dokumen AI yang selesai GET /v1/ai/jobs/{job_id} — Polling status dan hasil AI yang dikutip GET /v1/ai/jobs/{job_id}/comparison.csv — Ekspor perubahan kontrak yang dikutip untuk tinjauan manusia sebagai CSV yang aman GET /v1/ai/jobs/{job_id}/comparison.xlsx — Unduh buku kerja tinjauan perubahan kontrak yang tertaut ke sumber GET /v1/ai/jobs/{job_id}/conversation — Baca percakapan milik Anda yang belum kadaluarsa dan putaran yang dirujuk GET /v1/ai/jobs/{job_id}/evidence.csv — Ekspor kutipan sumber yang dikutip dari hasil AI milik Anda untuk tinjauan pribadi manusia GET /v1/ai/jobs/{job_id}/export.{fmt} — Unduh hasil tinjauan AI pribadi yang divalidasi kutipan (JSON, PDF, DOCX atau XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Ekspor item baris faktur yang dikutip untuk tinjauan manusia GET /v1/ai/jobs/{job_id}/invoice.csv — Ekspor bidang faktur untuk ditinjau sebagai CSV aman GET /v1/ai/jobs/{job_id}/invoice.xlsx — Unduh buku kerja tinjauan faktur yang terikat bukti dan berskala akun GET /v1/document-jobs — Daftar pekerjaan dokumen terbaru yang dibatasi akun dan kunci API POST /v1/document-jobs — Proses PDF yang diunggah secara asinkron GET /v1/document-jobs/{job_id}/download-url — Dapatkan URL unduhan langsung sementara POST /v1/documents/uploads — Buat unggahan PDF langsung DELETE /v1/documents/uploads/{upload_id} — Hapus dokumen yang diunggah yang tidak digunakan GET /v1/documents/uploads/{upload_id} — Periksa dokumen yang diunggah POST /v1/documents/uploads/{upload_id}/complete — Verifikasi dan segel PDF yang diunggah GET /v1/documents/uploads/{upload_id}/evidence — Ekstrak teks yang dikutip halaman dari PDF terverifikasi (pratinjau terbatas) GET /v1/documents/uploads/{upload_id}/form-fields — Temukan nama bidang AcroForm, jenis dan nomor halaman yang didukung GET /v1/esign/envelopes — Daftar permintaan tanda tangan Anda sendiri POST /v1/esign/envelopes — Buat draf permintaan eSignature DELETE /v1/esign/envelopes/{envelope_id} — Buang draf yang belum dikirim tanpa menghubungi penyedia GET /v1/esign/envelopes/{envelope_id} — Dapatkan status permintaan tanda tangan PATCH /v1/esign/envelopes/{envelope_id} — Edit draf tanda tangan yang belum dikirim menggunakan versi draf yang tepat POST /v1/esign/envelopes/{envelope_id}/archive — Simpan PDF yang ditandatangani penyedia ke penyimpanan pribadi GET /v1/esign/envelopes/{envelope_id}/audit — Baca integritas eSignature dan penerimaan acara dalam cakupan akun GET /v1/esign/envelopes/{envelope_id}/download-url — Keluarkan URL unduhan dokumen yang ditandatangani pribadi berumur pendek POST /v1/esign/envelopes/{envelope_id}/remind — Kirim satu pengingat penandatangan sandbox per 24 jam, tanpa percobaan ulang GET /v1/esign/envelopes/{envelope_id}/reminders — Daftar penerimaan pengingat pribadi tanpa alamat email penandatangan POST /v1/esign/envelopes/{envelope_id}/send — Kirim permintaan tanda tangan sandbox yang disetujui secara eksplisit POST /v1/esign/envelopes/{envelope_id}/sync — Segarkan permintaan sandbox dari penyedia penandatanganan tanpa mengirim ulang GET /v1/esign/envelopes/{envelope_id}/timeline — Baca linimasa aktivitas permintaan tanda tangan yang aman privasi POST /v1/esign/envelopes/{envelope_id}/validate — Validasi tata letak bidang draf terhadap PDF sumber yang disegel POST /v1/esign/envelopes/{envelope_id}/void — Antrekan pembatalan permintaan penandatanganan sandbox; verifikasi status akhir secara terpisah GET /v1/esign/providers — Daftar penyedia eSignature dan ketersediaan aktual mereka GET /v1/esign/reports/export.csv — Ekspor metadata operasional permintaan tanda tangan pribadi sebagai CSV GET /v1/esign/reports/summary — Ringkasan aktivitas permintaan tanda tangan sandbox pribadi GET /v1/task-tools — Daftar operasi dan pengaturan tugas PDF yang tersedia GET /v1/task-tools/{tool} — Jelaskan operasi tugas dan opsi yang diterima GET /v1/tasks — Daftar tugas dokumen Anda POST /v1/tasks — Mulai tugas dokumen DELETE /v1/tasks/{task_id} — Buang tugas yang menunggu GET /v1/tasks/{task_id} — Ambil status tugas GET /v1/tasks/{task_id}/download-url — Dapatkan URL unduhan output pribadi tugas POST /v1/tasks/{task_id}/files — Lampirkan unggahan terverifikasi ke tugas yang menunggu POST /v1/tasks/{task_id}/process — Antrekan dan meter tugas dokumen GET /v1/tasks/{task_id}/quote — Perkirakan HQ Credits untuk tugas yang menunggu dari unggahan terverifikasi POST /v1/tasks/{task_id}/uploads — Buat tiket unggah untuk tugas POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Segel PDF yang diunggah dan lampirkan ke tugas GET /v1/webhooks — Daftar hanya langganan webhook proyek ini POST /v1/webhooks — Berlangganan acara pelanggan yang ditandatangani dengan cakupan proyek GET /v1/webhooks/deliveries — Periksa status pengiriman berskop tanpa muatan rahasia POST /v1/webhooks/deliveries/{delivery_id}/replay — Putar ulang pengiriman mati setelah memperbaiki penerima DELETE /v1/webhooks/{subscription_id} — Cabut langganan webhook yang dibatasi proyek POST /v1/webhooks/{subscription_id}/rotate — Putar rahasia; ungkapkan penggantian sekali POST /v1/webhooks/{subscription_id}/test — Antrekan satu acara uji langganan sintetis GET /v1/workspace/documents — Daftar dokumen POST /v1/workspace/documents — Daftarkan dokumen DELETE /v1/workspace/documents/{document_id} — Hapus dokumen GET /v1/workspace/documents/{document_id} — Dapatkan dokumen PATCH /v1/workspace/documents/{document_id} — Perbarui dokumen GET /v1/workspace/documents/{document_id}/activity — Aktivitas dokumen GET /v1/workspace/documents/{document_id}/handoff — Opsi penyerahan POST /v1/workspace/documents/{document_id}/handoff/ai — Serahkan ke ai POST /v1/workspace/documents/{document_id}/handoff/signing — Serah terima untuk penandatanganan POST /v1/workspace/documents/{document_id}/handoff/task — Serahkan ke tugas GET /v1/workspace/documents/{document_id}/preview — Pratinjau dokumen GET /v1/workspace/documents/{document_id}/preview-url — URL pratinjau dokumen PUT /v1/workspace/documents/{document_id}/retention — Tetapkan retensi Skema disertakan Ketersediaan terbatas Lihat dompet kredit HQ bersama Anda
Permintaan kontrak — snapshot OpenAPI yang diperiksa
Autentikasi: APIKeyHeader · Respons terdokumentasi: 200, 422
Tidak ada badan permintaan JSON yang dideklarasikan.
Lab API Terautentikasi
Baca-saja · Tanpa konsumsi kredit Jalankan permintaan GET aman yang dipilih terhadap API PDFHQ yang dipublikasikan. Kunci proyek hanya disimpan dalam memori tab ini. Jangan pernah tempel kredensial penyedia, kredensial pembayaran, atau kunci produksi di komputer bersama.
# 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. Contoh memerlukan pengeditan sebelum digunakan, dan tidak diuji secara otomatis terhadap API yang berjalan.
SDK dan alur kerja terverifikasi
SDK sepuluh bahasa yang dapat diunduh saat ini mencakup task API saja , bukan permukaan AI, penandatanganan, atau ruang kerja lengkap. Pembuatan layanan penuh memerlukan kontrak OpenAPI yang diverifikasi runtime.