Siirry sisältöön
Yleiskuva Yleiskuva Uutiset Uutiset
Jaa

Cookbook

Kopioitavat ohjeet. Valmiit API-esimerkit.

28 ohjetta Document AI, Data APIs ja IDE-työvirroille — kopioi, liitä, saa koodia.

PaperOffice llms.txt lukee jokainen moderni LLM: Claude, Cursor ja IDE kirjoittavat loput.

28 valmista ohjetta Aidot päätepisteet REST ja MCP

Integraatio

llms.txt:stä jatkuvaksi integraatioksi

Kolme vaihetta: linkitä dokumentaatio, määritä tarkoitus, ota koodi käyttöön.

  1. Lisää llms.txt

    Liittäkää Claude, Cursor tai IDEenne.

  2. Ilmoita tarkoitus

    Mitä rakennetaan — tai syöte tältä sivulta.

  3. Anna koodin kirjoittaminen

    IDE tarjoaa jatkuvan integroinnin.

Document AI

Lue, tarkista ja lähetä asiakirjat

Kopioi syöte, liitä se Claude tai Cursor — valmista.

IDP-lasku + AI-OCR + rajauslaatikot

Ota laskun kentät irti mukaan lukien sijainti asiakirjassa.

Kehote
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 — teksti kuvasta/PDF

Täysteksti POST /job/add/paperoffice_aiocr___generate (ocr_mode=complete).

Kehote
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 Split — Yhdistetyn PDF:n jakaminen

Tunnista asiakirjarajat ja nimeä yksittäiset tiedostot.

Kehote
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

Document Anonymize — PII-pikiminen

Tunnista nimet, IBAN-tilinumerot ja osoitteet sekä piilota ne.

Kehote
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

Voice TTS — Tekstistä ääneen

Synkroninen MP3 voice=Nadja (m. m.).

Kehote
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-sopimus + AI-OCR + rajauslaatikot

Pura sopimuskentät mukaan lukien sijainti asiakirjassa.

Kehote
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-signaatio — Luo signaatioruutu

Kutske allekirjoittajat ja hallitse tilaa/muistutuksia.

Kehote
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

Digitaalinen suositeltu kirje — Lähetä sähköpostitse

Turvallinen toimitus PDF-salasanan (sähköposti tai SMS) ja lähetysraportin avulla.

Kehote
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

Data & Security APIs

Tarkista sijainti, riski ja perustiedot

Geokoodaus, sää, sormenjälki, ALV-tunnus ja muuta — promptina.

Geokoodaus — Eteenpäin / Taaksepäin / Autocomplete

Osoite ↔ Koordinaatit.

Kehote
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

Sää — Nykyinen + Ilmanlaatu

Nykyinen sää mukaan lukien laskutus.

Kehote
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 → Sijainti

Sijainti IP:stä, valinnainen sää.

Kehote
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

Laitteen sormenjälki — Vierailija-ID

Vierailija-ID ja luottamusarvo.

Kehote
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

Väärä sähköpostiosoite -tunnistin — Hävitysosoitteen tarkistus

Hävitys-sähköposti ja riskiarvio.

Kehote
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 / Anonymiteetin tarkistus

VPN, välityspalvelin, Tor, datakeskus.

Kehote
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

ALV-tarkistin — EU:n ALV-numero

Voimassaolo ja yritystiedot.

Kehote
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

Valuutanvaihto — Live-kurssit

Muunnos nykyisellä kurssilla.

Kehote
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- ja tekoälytyökalut

Claude, Cursor ja IDE:lle

IDE:ssä toimivat promptit — mukaan lukien MCP-palvelin.

IDP-laskuputki + rajauslaatikot + CSV

Joukkotuonti vahvistuskoordinaateilla.

Kehote
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-palvelin — Document AI IDE:ssä

Yhdistä MCP ja käsittele asiakirjat työpöydältä.

Kehote
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

Puheagentti — STT + TTS

Käsittele puhe syöte ja anna äänivastauksia.

Kehote
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

Petosten tunnistus — Sormenjälki + IP

Tarkista laitteen sormenjälki ja Geo/IP-signaalit.

Kehote
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

Batch AI PDF-jako

Jaa suuria PDF-kansioita asynkronisesti.

Kehote
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

Dokumenttiluokitin — OCR + kansio

OCR, luokittele ja järjestä alikansioihin.

Kehote
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.

Loppupäästä loppupäähän

Kokonaiset putket

Sisääntulosta vientiin — jokainen vaihe samassa kehotteessa.

IDP-laskut → kirjanvienti

PDF-lataus → AI-IDP + rajauslaatikot → validointi → CSV-vienti

Kehote
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-sopimukset + määräaikamuistutukset

sopimuksen lataus → avainsanat → Knowledge Graph → hälytykset

Kehote
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-muunnin — Word / PowerPoint / PDF/A

PDF-lataus → Valitse muoto → Muunnos → Lataus

Kehote
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

Webhookit — käsittele job.completed-tapahtuma

Rekisteröi webhook → Asiakirjan lähetys → Vastaanota tapahtuma → Käsittely

Kehote
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 — Dokumentista äänitiedostoon

Dokumentin OCR → Tekstin käsittely → TTS-generointi → Äänen tallennus

Kehote
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

Batch-OCR → CSV-vienti

Kansion skannaus → Erä-OCR → Tekstin kerääminen → CSV-vienti

Kehote
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

Seuraava vaihe

Jatka API:lla

llms.txt ja Playground — ilman välikäsiä.

Token REST:lle ja MCP:lle Vastaus credits_billed -kentällä Oma EU-infrastruktuuri
Video

Cookbook toiminnassa

Katsokaa, miten PaperOffice API toimii käytännössä — videolla.

Cookbook toiminnassa

Usein kysytyt kysymykset

Kaikki tärkeimmät yhteenvetona

Tarvinko SDK:n?

Ei. PaperOffice API on puhdasta RESTiä: yksi päätepiste, yksi Bearer-token, multipart/form-data. IDEille ja agenteille on lisäksi tarjolla MCP-palvelin.

Miksi llms.txt näkyy jokaisessa promptissa?

llms.txt on API-dokumentaation koneellisesti luettavassa muodossa. Mallinne lukee siitä päätepisteet, parametrit ja vastausmuodot — se ei keksi kenttiä.

Minkä avun syötän?

Käyttäjätoken, jonka etuliite on po_ut_. Löydätte sen PaperOffice-sovelluksesta kohdasta Tili → API. Korvatkaa promptin po_ut_YOUR_API_KEY omalla avaimellanne.

Saako tuloksen välittömästi vai täytyykö pollata?

Käytettäessä processing_lane=instant API vastaa synkronisesti (HTTP 200 vastauksella result). Ilman tätä parametria saatte HTTP 202:n job_id:n; tuloksen hankit GET /job/get/{job_id}:lla tai webhookilla.

Toimivatko promptit kaikissa ympäristöissä?

Promptit eivät sisällä työkalukohtaisia ohjeita. Testattu Claude:n, Claude-koodin ja Cursor:n kanssa — mikä tahansa ympäristö, joka osaa lukea URL-osoitteen, selviää tästä.

Mikä on pyynnön hinta?

Jokainen vastaus sisältää tiedon Credits. Pipelinen kohtaiset Credit-hinnat löytyvät hinnastosta; laskutetaan vain todellisuudessa käsitelty määrä.

Missä haluatte kokeilla PaperOfficea?

Tietokone ja älypuhelin yhdistetty: työtila tietokoneella, kerääminen puhelimella.

Testiversio on valmis

Mistä haluatte aloittaa?

Täysi työtila on optimoitu tietokoneelle. Mobiiliversio soveltuu dokumenttien keräämiseen, tarkistamiseen ja hyväksymiseen.

app.paperoffice.ai

Aloittakaa tietokoneella

Henkilökohtainen kirjautumislinkki lähetetään ilmoitettuun sähköpostiosoitteeseen.

Avatkaa PaperOffice Mobile

Kerätkää ja käsitelkää dokumentteja suoraan älypuhelimella.

Avatkaa mobiiliversio
Rekisteröitykää veloituksetta Avaa sovellus PaperOffice-sovellus Koko tuote: selain, työpöytä ja mobiili. Tallentakaa, järjestäkää, hakekaa ja käsittekää asiakirjoja tiimin kanssa. Ilmainen tili vaaditaan Avaa Playground Playground Kokeilkaa valittuja toimintoja heti — ilman rekisteröitymistä, rajoitetulla demo-API-avaimella. Ei rekisteröitymistä, mutta rajoitettu demo-API-avain