Šokti į turinį
Apžvalga Apžvalga Naujienos Naujienos
Bendrinti

Cookbook

Užklausos tekstai kopijavimui. Paruošti API pavyzdžiai.

28 užklausos tekstai Document AI, Data APIs ir IDE darbo srautams — nukopijuokite, įklijuokite, gaukite kodą.

PaperOffice llms.txt skaitoma bet kokio šiuolaikinio LLM: Claude, Cursor ir jūsų IDE parašo likusią dalį.

28 paruošti užklausos tekstai Tikri galai REST ir MCP

Integracija

Nuo llms.txt iki nuolatinės integracijos

Trys žingsniai: susieti dokumentaciją, nurodyti tikslą, perimti kodą.

  1. Įterpti llms.txt

    Įterpti į Claude, Cursor arba savo IDE.

  2. Nurodyti tikslą

    Ką reikia sukurti arba užklausą iš šio puslapio.

  3. Leisti rašyti kodą

    IDE pateikia vykdomą integraciją.

Document AI

Skaityti, tikrinti ir siųsti dokumentus

Nukopijuokite užklausą, įklijuokite į Claude arba Cursor — viskas paruošta.

IDP sąskaita + AI-OCR + ribojančios dėžutės

Ištraukite sąskaitos laukus, įskaitant poziciją dokumente.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build me an invoice extractor that:
1. Uploads a PDF via POST /job/add/workflow (multipart, field file_1)
2. Uses idp_collection=invoice, processing_lane=instant (sync)
3. Reads every field from result.pages_idp[0].suggested_fields
   (keys like _supplier_name, _total_amount, _invoice_date)
   and the boxes from result.pages_aiocr.pages
4. Renders a verification view highlighting each value
   at its bounding box position

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

AI-OCR — tekstas iš vaizdo/PDF

Visuotinis tekstas per POST /job/add/paperoffice_aiocr___generate (ocr_mode=complete).

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Write a minimal script that:
1. Sends an image or PDF to POST /job/add/paperoffice_aiocr___generate
   (multipart, field file_1)
2. Uses ocr_mode=complete and processing_lane=instant (sync)
3. Prints the extracted text from result ?? job_result (pages)

Modes: complete (+tables), grid (+bounding boxes), text (plain).
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

AI PDF skaidymas — sujungto PDF failo skaidymas

Rasti dokumento ribas ir pavadinti atskirus failus.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a splitter for large batch PDFs (up to 3000 pages):
1. POST /job/add/workflow with template=pdf_ai_split (multipart, field file)
2. naming_instruction=Dokumenttyp_Datum_Absender,
   locale=de_DE, processing_lane=instant
3. List every created document from the result
   (suggested filename + page range)

The AI detects document boundaries automatically.
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Dokumento anonimizavimas — PII duomenų užtemimas

Aptikti ir redaguoti vardus, IBAN sąskaitas, adresus.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt
Also use llms-full.txt for anonymize parameters (scenario, apply).

Build a GDPR anonymizer (preview → apply):
1. POST /job/add/workflow template=document_anonymize_preview (field file)
2. Set scenario=gdpr_auskunft (or externe_weitergabe / finanzdaten),
   redact_categories=all, optional whitelist / custom_redact
3. client_wait=false then poll GET /job/get/{job_id}
4. Show detected_pii.redact_box_ids + simplified_boxes
5. Apply: POST /job/add/paperoffice_dataripper___redact_image
   with files + bounding_boxes + redact_boxes from the preview
   (or MCP: po_anonymization_pii_detect → po_anonymization_redaction_apply
   with preview_job_id)
Optional one-shot: REST template=document_anonymize OR MCP po_anonymization_anonymize
  (no HITL; pass scenario/whitelist).
Redact Agent: POST /documents/redact-agent-run or MCP po_documents_redact_agent_run.

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Balso TTS — tekstas į audio

Sinchroninis MP3 per voice=Nadja (ir kt.).

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a text-to-speech generator:
1. POST /job/add/paperoffice_voice___tts with text=..., voice=Nadja,
   output_format=mp3
2. output=url and processing_lane=instant for a synchronous audio link
3. Play or download the audio URL from result ?? job_result

Voices: Nadja, Thomas, Anna, Hans (DE) + 100+ more.
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

IDP sutartis + AI-OCR + ribos dėžutės

Išgauti sutarties laukus, įskaitant poziciją dokumente.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a contract extractor that:
1. Uploads a PDF via POST /job/add/workflow (multipart, field file_1)
2. Uses idp_collection=contract, processing_lane=instant (sync)
3. Reads parties, dates and notice period from
   result.pages_idp[0].suggested_fields (value + bounding box)
4. Renders a verification view with bounding boxes

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

E-pasirašymas — pasirašymo užklausos kūrimas

Pakviesti pasirašytojus ir valdyti būseną/priminimus.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build an e-signature request flow:
1. Ensure the document has a pofid in PaperOffice
2. POST /signatures/create with document_pofid (or pofid)
   and a signers array (name + email per signer)
3. Return the signature request id and status
4. Optionally POST /signatures/remind for pending signers

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Skaitmeninis registruotas laiškas — siųsti el. paštu

Saugus pristatymas naudojant PDF slaptažodį (el. paštas arba SMS) ir siuntimo protokolą.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a secure document delivery (digital registered mail):
1. POST /document_delivery/create_and_send with:
   pofids: ["POFID_HERE"],
   recipient_email, optional recipient_name,
   subject, optional message
2. security_mode=link → PDF password in the same email
   security_mode=secure_sms → link by email, password by SMS
   (requires recipient_phone in E.164, e.g. +49170…)
3. Show delivery_id and that access events are logged
   (Versandhistorie / delivery log)

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Duomenys ir saugumas APIs

Tikrinti vietą, riziką ir pagrindinius duomenis

Geokodavimas, orai, pirštų atspaudas, PVM ID ir kt. — kaip užklausa.

Geokodavimas — tiesioginis / atvirkštinis / automatinis užpildymas

Adresas ↔ Koordinatės.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a geocoding helper that:
1. Forward: GET /geocoding/forward?q=...&lang=de
2. Reverse: GET /geocoding/reverse?lat=...&lon=...
3. Autocomplete: GET /geocoding/autocomplete?q=...
4. Prints display_name, lat, lon and credits_billed

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Oras — dabartiniai + oro kokybė

Dabartiniai orai įskaitant apmokestinimą.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a weather lookup that:
1. Calls GET /weather/current?lat=...&lon=...&lang=de
2. Shows temperature, condition text and air quality if present
3. Displays credits_billed from the response

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

IP2Location — IP → Vieta

Vieta pagal IP, neprivalomai oras.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build an IP intelligence client that:
1. Calls GET /ip2location/full (empty ip = visitor IP)
2. Extracts country, city, geo_lat/lon, ISP
3. Optionally chains weather from the same response

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Įrenginio piršto atspaudas — Lankytojo ID

Lankytojo ID ir pasitikėjimo lygis.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a device fingerprint check that:
1. Collects client signals in the browser
2. POSTs to /fingerprint/identify
3. Returns visitor_id / confidence for fraud checks

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Netikros el. pašto aptikimas — Laikino el. pašto tikrinimas

Laikinas el. paštas ir rizikos balas.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build an email risk checker that:
1. Validates an address via the Fake Email Detector endpoint
2. Flags disposable / role / invalid domains
3. Returns a clear allow/deny recommendation

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

VPN / Anonimiškumo tikrinimas

VPN, proxy, Tor, duomenų centras.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a VPN/proxy detector that:
1. Calls GET /ip2location/vpn?ip=...
2. Normalizes is_vpn, is_proxy, is_tor, is_datacenter flags
3. Shows a clear risk badge for the visitor

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

PVM patikrintuvas — ES PVM ID

Galiojimas ir įmonės duomenys.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a VAT ID validator that:
1. Checks an EU VAT number via the VAT validator endpoint
2. Returns company name and address when valid
3. Handles invalid / not-found responses cleanly

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Valiutų keitimas — Gyvi kursai

Konversija naudojant dabartinį kursą.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a currency converter that:
1. Calls the currency exchange endpoint (from, to, amount)
2. Shows rate and converted amount
3. Caches the last rate for the UI

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

IDE ir AI įrankiai

Skirta Claude, Cursor ir jūsų IDE

Promptai, veikiantys IDE — įskaitant MCP serverį.

IDP sąskaitų faktūrų valdymas + ribojančios dėžutės + CSV

Partinė ekstrakcija su patvirtinimo koordinatėmis.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Create a Python script that:
1. Takes a folder of invoice PDFs
2. Extracts all fields using POST /job/add/workflow with idp_collection=invoice
3. Returns bounding boxes for verification (result.pages_aiocr)
4. Exports to CSV

Important: Use file_1 for uploads; fields live in result.pages_idp[0].suggested_fields.
Handle sync (HTTP 200 with result) and async (HTTP 202 → poll GET /job/get/{job_id}).
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

MCP serveris — Dokumentų AI IDE aplinkoje

Prijunkite MCP ir apdorokite dokumentus iš darbo erdvės.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Help me set up the MCP Server for PaperOffice in Cursor.
I want to use Document AI directly in my IDE.

Show me:
1. How to configure the MCP connection (URL https://mcp.paperoffice.ai/cursor)
2. Available tools via tools/list
3. How to process documents from my workspace

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Balso agentas — STT + TTS

Apdoroti balso įvestį ir pateikti audio atsakymus.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Create a voice agent that:
1. Takes audio input (Speech-to-Text)
2. Processes the text
3. Generates audio response (Text-to-Speech)

Use these pipelines:
- STT: POST /job/add/paperoffice_voice___stt (audio_file)
- TTS: POST /job/add/paperoffice_voice___tts (text, voice=Nadja,
  output_format=mp3, output=url)
- Use processing_lane=instant for a synchronous response.
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Sukčiavimo aptikimas — pirštų atspaudas + IP

Patikrinti įrenginio piršto atspaudo ir geo/IP signalus.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a fraud detection system that:
1. Checks device fingerprints
2. Validates IP geolocation
3. Detects suspicious patterns

Use the Security & Data AI endpoints.
These are instant APIs (no polling needed).
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Partinis AI PDF skaidymas

Asinchroniškai skaidyti didelių PDF failų aplanką.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Create a batch processor that:
1. Takes a folder of large PDFs (up to 3000 pages each)
2. Uses POST /job/add/workflow with template=pdf_ai_split
3. Uses naming_instruction for smart filenames
4. Handles async jobs (HTTP 202) by polling GET /job/get/{job_id}

Use locale=de_DE for German document types.
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Dokumentų klasifikatorius — OCR + aplankas

OCR, klasifikuoti, rūšiuoti į poaplankius.

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a document classifier that:
1. Watches a folder for new PDFs
2. Uses OCR (POST /job/add/paperoffice_aiocr___generate, ocr_mode=complete)
   to extract text
3. Classifies into: invoice, contract, receipt, correspondence
4. Moves files to category subfolders
5. Logs results to classification_log.csv

Authenticate with: Authorization: Bearer po_ut_YOUR_API_KEY.
processing_lane=instant for a synchronous response.

Nuo pradžios iki galo

Visos apdorojimo grandinės

Nuo įėjimo iki eksporto — kiekvienas etapas tame pačiame užklausime.

IDP sąskaitos faktūros → buhalterinė išvestis

PDF įkėlimas → AI-IDP + ribojantys stačiakampiai → Validavimas → CSV išvestis

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build an accounts-payable pipeline:
1. Watch a folder for incoming invoice PDFs
2. Extract fields via POST /job/add/workflow (file_1,
   idp_collection=invoice, processing_lane=instant)
3. Flag every field with confidence < 0.9 for manual review,
   including its bounding box for the verification UI
   (result.pages_idp[0].suggested_fields + result.pages_aiocr)
4. Export supplier, total, date and IBAN as CSV for the accounting import

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

IDP sutartys + terminų įspėjimai

Sutarties įkėlimas → Raktiniai žodžiai → Knowledge Graph → Įspėjimai

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a contract analyzer:
1. Upload contracts via POST /job/add/workflow (file_1,
   idp_collection=contract, processing_lane=instant)
2. Extract parties, start date, end date and notice period
   from result.pages_idp[0].suggested_fields (each with a bounding box)
3. Store the key terms in a knowledge graph
4. Alert me 90 days before a notice period expires

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

PDF konvertavimas — „Word“ / „PowerPoint“ / „PDF/A“

Įkelkite PDF → Pasirinkite formatą → Konvertavimas → Atsisiuntimas

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a PDF converter service:
1. One pipeline per target format (field file_1):
   POST /job/add/pdfstudio___pdf_to_word | pdfstudio___pdf_to_powerpoint |
   pdfstudio___pdf_to_pdfa | pdfstudio___pdf_to_webp
2. processing_lane=instant for a synchronous response
3. Return the download URL from result ?? job_result

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Webhook'ai — apdorokite „job.completed“ įvykį

Užregistruokite webhook'ą → Išsiųskite dokumentą → Gaukite įvykį → Apdorokite

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a webhook event handler:
1. Register a webhook via POST /webhooks/subscribe
   (url, events: ["job.completed", "job.failed"], secret)
2. Verify the HMAC-SHA256 signature of every delivery
   with the subscription secret (see llms-full.txt, webhooks)
3. Process the payload whenever job.completed arrives

Note: webhooks always require a token (account binding).
Auth: Authorization: Bearer po_ut_YOUR_API_KEY

OCR → TTS — Dokumentas į audio

Dokumento OCR → Teksto paruošimas → TTS generavimas → Audio įrašymas

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a document-to-audio pipeline:
1. OCR via POST /job/add/paperoffice_aiocr___generate
   (file_1, ocr_mode=complete, processing_lane=instant)
2. Split the extracted text (result ?? job_result, pages) into 5000-character chunks
3. TTS per chunk: POST /job/add/paperoffice_voice___tts (text, voice=Nadja,
   output_format=mp3, output=url, processing_lane=instant)
4. Save all returned audio URLs as a playlist

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Partinis OCR → CSV eksportas

Aplankų skenavimas → Partinis OCR → Teksto rinkimas → CSV eksportas

Užklausa
Read this llms.txt (AI-optimized API docs):
https://api.paperoffice.ai/latest/docs/llms.txt

Build a batch OCR-to-CSV exporter:
1. Scan a folder for PDF/PNG/JPG/TIFF/WEBP files
2. For each file: POST /job/add/paperoffice_aiocr___generate
   (file_1, ocr_mode=complete, processing_lane=instant)
3. Collect filename, page_count, text preview and confidence
4. Write everything to ocr_results.csv

Auth: Authorization: Bearer po_ut_YOUR_API_KEY

Kitas žingsnis

Tęsti su API

llms.txt ir „Playground“ — be jokių tarpinių žingsnių.

Tokenas REST ir MCP Atsakymas su credits_billed Savo ES infrastruktūra
Vaizdo įrašas

Cookbook veiksmas

Pamatykite, kaip PaperOffice AI Receptai veikia praktiškai – vaizdo įraše.

Cookbook veiksmas

Dažnai užduodami klausimai

Viskas svarbiausia peržiūroje

Ar man reikia SDK?

Nei. PaperOffice API yra grynas REST: vienas galinis taškas, „Bearer“ žetonas, multipart/form-data. IDE ir agentams taip pat prieinamas MCP serveris.

Kodėl llms.txt yra kiekviename užklausos lauke?

llms.txt yra API dokumentacijos mašinai skaitoma versija. Jūsų modelis iš jos nuskaityja galinius taškus, parametrus ir atsakymų formatus – jis nekuria jokių laukų.

Kokį raktą turiu įvesti?

Vartotojo token su priešdėliu po_ut_. Jį rasite „PaperOffice“ programėlėje: Paskyra → API. Užklausos lauke pakeiskite po_ut_YOUR_API_KEY savo asmeniniu raktu.

Ar rezultatas gaunamas iškart, ar reikia naudoti polinimą?

Naudojant processing_lane=instant, API atsako sinchroniškai (HTTP 200 su rezultatu). Be šio parametro grąžinama HTTP 202 su job_id; rezultatą galite gauti per GET /job/get/{job_id} arba naudojant webhook.

Ar užklausos veikia bet kurioje aplinkoje?

Užklausose nėra specifinių įrankių instrukcijų. Patikrinta su Claude, Claude kodu ir Cursor – bet kuri aplinka, kuri gali perskaityti URL, su jomis susitvarkys.

Kiek kainuoja viena užklausą?

Kiekvienas atsakymas nurodo credits_billed. Credits kainos pagal kiekvieną pipeline pateiktos kainų apžvalgoje; apskaičiuojama tik tai, kas buvo faktiškai apdorota.

Kur norite išbandyti PaperOffice?

Kompiuteris ir išmanusis telefonas sujungti: darbalaučio funkcijos kompiuteryje, fiksavimas telefone.

Jūsų bandomoji versija paruošta

Kur norite pradėti?

Pilna darbalaučio versija optimizuota kompiuteriui. Mobilioji versija tinka dokumentams fiksuoti, tikrinti ir tvirtinti.

app.paperoffice.ai

Pradėti kompiuteryje

Asmeninį prisijungimo nuorodą atsiųsime į jūsų el. pašto adresą.

Registruotis nemokamai Atidaryti programą PaperOffice programa Visas produktas: žiniatinklis, kompiuteris ir mobilusis. Fiksuokite, tvarkykite, ieškokite dokumentų ir dirbkite su komanda. Reikalinga nemokama paskyra Atidaryti Playground Playground Pasirinktas funkcijas išbandykite iškart — be registracijos, su apribotu demonstraciniu API raktu. Be registracijos, bet su apribotu demonstraciniu API raktu