API Anotasi PDF
Tambahkan teks yang dapat diekstrak, sorotan berwarna dan overlay persegi panjang dengan koordinat presisi.
Semantik endpoint dan tugas#
Kode operasi: annotate
Mulai operasi ini dengan POST /v1/tasks dan kode alat yang ditampilkan di atas. Unggah dan lampirkan PDF sumber (atau gunakan titik akhir unggahan berskop tugas), lalu panggil POST /v1/tasks/{task_id}/process dengan pengaturan operasi.
Tinjau laporan, tambahkan catatan persetujuan atau tandai wilayah secara visual tanpa mengedit teks yang mendasar.
Input: Satu PDF terverifikasi; 1–200 anotasi pada hingga 500 halaman tidak diputar.
Konfigurasi dan parameter tambahan#
| Pengaturan | Jenis | Perilaku |
|---|---|---|
| annotationswajib | object[] | Setiap anotasi memerlukan kind ('text', 'highlight' atau 'rectangle'), page (berbasis 1), x0/y0/x1/y1 dalam poin PDF, dan color (yellow, blue, red, green, black). Text memerlukan text dan font_size (6–48). |
Opsi divalidasi oleh API. Pengaturan yang tidak dikenal dan nilai yang tidak didukung mengembalikan kesalahan alih-alih diabaikan.
Urutan permintaan yang sedang berjalan#
Programming language: cURL
Pilih bahasa · gulir secara horizontal untuk semua 10 bahasa SDK
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"tool":"annotate"}'
# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'
# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"options":{"annotations":[{"kind":"text","page":1,"x0":50,"y0":100,"x1":420,"y1":175,"color":"blue","text":"Reviewed","font_size":16}]}}'
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_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.
Paket yang dapat diunduh yang dihasilkan mencakup alur kerja tugas saja. SDK layanan penuh memerlukan spesifikasi OpenAPI runtime yang terverifikasi; SDK tugas Python, JavaScript, dan TypeScript melakukan streaming unggahan file; bahasa lain memerlukan unggahan multipart yang ditandatangani yang diimplementasikan oleh pemanggil.
ID tugas yang dikembalikan digunakan untuk polling status dan pengambilan. Setelah tugas berhasil, minta URL output yang ditandatangani daripada menyematkan rahasia unduhan.
Output dan detail penting#
PDF baru dengan teks/bentuk overlay yang terlihat nyata. Ini bukan redaksi yang aman.
Ini menambahkan konten visual; tidak mengubah teks yang ada atau menghapus informasi dasar secara permanen. Gunakan Redact PDF untuk kerahasiaan; tanda tangan digital ditolak.
Kesalahan, percobaan ulang, dan penagihan