PDFHQ logosu

Belgeler

BelgelerPDF işlemleri

PDF Açıklama API

Çıkarılabilir metin, renkli vurgular ve kesin koordinatlarla dikdörtgen kaplamaları ekleyin.

Sunucu tarafı API anahtarları İmzalı depolama yüklemeleri

Uç nokta ve görev semantiği#

İşlem kodu: annotate

Bu işlemi şununla başlatın POST /v1/tasks ve yukarıda gösterilen araç kodu. Kaynak PDF'lerini yükleyin ve ekleyin (veya görev kapsamlı yükleme uç noktalarını kullanın), ardından POST /v1/tasks/{task_id}/process işlem ayarları ile.

Bir raporu gözden geçirin, onay notları ekleyin veya temel metni düzenlemeden bölgeleri görsel olarak işaretleyin.

Girdiler: Bir doğrulanmış PDF; 500 döndürülmemiş sayfaya kadar 1–200 ek açıklama.

Yapılandırma ve ek parametreler#

AyarTürDavranış
annotationsgerekli object[]Her ek açıklama kind ('text', 'highlight' veya 'rectangle'), page (1 tabanlı), x0/y0/x1/y1 (PDF noktaları cinsinden) ve color (yellow, blue, red, green, black) gerektirir. Text için text ve font_size (6–48) gereklidir.

Seçenekler API tarafından doğrulanır. Bilinmeyen ayarlar ve desteklenmeyen değerler yok sayılmak yerine bir hata döndürür.

Çalışan istek sırası#

Programming language: cURL

Bir dil seçin · tüm 10 SDK dili için yatay kaydırın

API example · cURL
# 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.

All 10 SDKs ↓Tam Python kılavuzu ↓ Tam Bash/cURL kılavuzu ↓ Tüm uç noktalar → Doğrudan yüklemeler → Hata işleme →

Oluşturulan indirilebilir paketler yalnızca görev iş akışını kapsar. Tam hizmet SDK'ları doğrulanmış bir çalışma zamanı OpenAPI belirtimi gerektirir; Python, JavaScript ve TypeScript görev SDK'ları dosya yüklemelerini akışa alır; diğer diller, arayan tarafından uygulanan imzalı çok parçalı yüklemeler gerektirir.

Döndürülen görev kimliği hem durum yoklaması hem de alma için kullanılır. Görev başarılı olduktan sonra, bir indirme sırrı gömmek yerine imzalı bir çıktı URL'si isteyin.

Çıktı ve önemli ayrıntılar#

Gerçek görünür kaplama metni/şekilleri içeren yeni bir PDF. Bu güvenli bir redaksiyon değildir.

Bu görsel içerik ekler; mevcut metni değiştirmez veya temel bilgileri kalıcı olarak silmez. Gizlilik için Redact PDF kullanın; dijital imzalar reddedilir.

Hatalar, yeniden denemeler ve faturalandırma
PDFHQ logosu

PDF araçları ve belge zekası. Belgelerinizi hazırlayın, anlayın ve çalışın.

© 2026 PDFHQ. Tüm hakları saklıdır.