Logo PDFHQ

Dokumenty

DokumentacjaOperacje w formacie PDF

Adnotuj PDF API

Dodaj wyodrębniany tekst, kolorowe podkreślenia i prostokątne nakładki z dokładnymi współrzędnymi.

Klucze API po stronie serwera Podpisane przesyłanie danych do magazynu

Semantyka punktów końcowych i zadań#

Kod operacji: annotate

Rozpocznij tę operację za pomocą POST /v1/tasks oraz kod narzędzia pokazany powyżej. Prześlij i dołącz źródłowe pliki PDF (lub użyj punktów końcowych przesyłania o zakresie zadań), a następnie zadzwoń POST /v1/tasks/{task_id}/process z ustawieniami operacyjnymi.

Przejrzyj raport, dodaj notatki zatwierdzające lub wizualnie zaznacz regiony bez edytowania tekstu bazowego.

Wejścia: Jeden zweryfikowany plik PDF; 1–200 adnotacji na maksymalnie 500 nieobróconych stronach.

Konfiguracja i dodatkowe parametry#

UstawienieTypZachowanie
annotationswymagane object[]Każda adnotacja wymaga rodzaju („tekst”, „podświetlenie” lub „prostokąt”), strony (opartej na 1), x0/y0/x1/y1 w punktach PDF i koloru (żółty, niebieski, czerwony, zielony, czarny). Tekst wymaga tekstu i font_size (6–48).

Opcje są sprawdzane przez API. Nieznane ustawienia i nieobsługiwane wartości zwracają błąd zamiast być ignorowane.

Robocza sekwencja żądań#

Programming language: cURL

Wybierz język · przewiń w poziomie, aby zobaczyć wszystkie 10 języków SDK

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 ↓Ukończ przewodnik po Pythonie ↓ Ukończ instruktaż Bash/cURL ↓ Wszystkie punkty końcowe → Przesyłanie bezpośrednie → Obsługa błędów →

Wygenerowane pakiety do pobrania obejmują wyłącznie przebieg zadania. Zestawy SDK z pełną obsługą wymagają zweryfikowanej specyfikacji OpenAPI środowiska wykonawczego; przesyłanie strumieniowych plików SDK zadań Python, JavaScript i TypeScript; inne języki wymagają podpisanego przesyłania wieloczęściowego realizowanego przez osobę wywołującą.

Zwrócony identyfikator zadania jest używany zarówno do odpytywania stanu, jak i pobierania. Po pomyślnym wykonaniu zadania poproś o podpisany wyjściowy adres URL, zamiast osadzać klucz tajny pobierania.

Dane wyjściowe i ważne szczegóły#

Nowy plik PDF z naprawdę widocznym tekstem/kształtami nakładki. To nie jest bezpieczna redakcja.

To dodaje treść wizualną; nie modyfikuje istniejącego tekstu ani trwale nie usuwa podstawowych informacji. Użyj opcji Redaguj PDF, aby zachować poufność; podpisy cyfrowe są odrzucane.

Błędy, ponowne próby i rozliczenia
Logo PDFHQ

Narzędzia PDF i inteligencja dokumentów. Przygotuj, zrozum i pracuj ze swoimi dokumentami.

© 2026 PDFHQ. Wszystkie prawa zastrzeżone.