דלג לתוכן
סקירה סקירה חדשות חדשות
שיתוף

Cookbook

פקודות להעתקה. דוגמאות מוכנות ל-API.

28 פקודות ל-Documents AI, Data APIs ו-IDE-Workflows — העתק, הדבק, קבל קוד.

ה-kובץ llms.txt של PaperOffice נקרא על ידי כל LLM מודרני: Claude, Cursor וה-ID שלך כותבים את השאר.

28 פקודות מוכנות נקודות קצה אמיתיות REST ו-MCP

אינטגרציה

מ-llms.txt לאינטגרציה מתמשכת

שלושה שלבים: קישור תיעוד, הצהרת כוונות, אימוץ קוד.

  1. הוסף את llms.txt

    הדבק ב-Claude, Cursor או ב-IDE שלך.

  2. ציין כוונה

    מה לבנות — או הזן הנחיה מהדף הזה.

  3. בקש כתיבת קוד

    סביבת הפיתוח מספקת אינטגרציה רציפה.

Document AI

קרא, בדוק ושלח מסמכים

העתק את ההנחיה, הדבק ב-Claude או Cursor — וזהו.

חשבונית IDP + AI-OCR + תיבות גבול

חילוץ שדות מהחשבונית כולל מיקומם במסמך.

הנחיה
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 — חילוץ טקסט מתמונה/PDF

טקסט מלא באמצעות POST /job/add/paperoffice_aiocr___generate (ocr_mode=complete).

הנחיה
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

פירוק PDF מבוסס AI — הפרדת מסמכים משולבים

זיהוי גבולות מסמך וקריאת שמות לקבצים בודדים.

הנחיה
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

אנונימיזציה של מסמכים — הטשטוש מידע אישי (PII)

זיהוי ועריכת שמות, מספרי IBAN וכתובות.

הנחיה
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

יצירת קול TTS — המרת טקסט לאודיו

סינכרון MP3 באמצעות voice=Nadja (ובעוד).

הנחיה
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 חוזה + AI-OCR + תיבות גבול (Bounding Boxes)

חילוץ שדות מהחוזה כולל מיקומם במסמך.

הנחיה
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

חתימה אלקטרונית — יצירת בקשת חתימה

להזמין חותמים ולשלוט בסטטוס/תזכורות.

הנחיה
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

המכתב המומלץ הדיגיטלי — לשלוח במייל

אספקה בטוחה עם סיסמת PDF (מייל או SMS) ופרוטוקול משלוח.

הנחיה
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

נתונים ואבטחה APIs

לבדוק מיקום, סיכון ונתונים ראשוניים

גיאוקודינג, מזג אוויר, טביעת אצבע, מספר מע"מ ועוד — כפקודה.

גיאוקודינג — קדימה / אחורה / השלמה אוטומטית

כתובת ↔ קואורדינטות.

הנחיה
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

מזג אוויר — נוכחי + איכות האוויר

מזג אוויר נוכחי כולל חיוב.

הנחיה
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 → מיקום

מיקום לפי IP, אופציונלי מזג אוויר.

הנחיה
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

טביעת אצבע של מכשיר — מזהה מבקר

מזהה מבקר ורמת ביטחון.

הנחיה
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

גלאי דוא"ל מזויף — בדיקת דוא"ל חד-פעמי

דוא"ל זמני וציון סיכון.

הנחיה
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 / אנונימיות

VPN, פרוקסי, Tor, מרכז נתונים.

הנחיה
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

בודק מע

תוקף ופרטי חברה.

הנחיה
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

המרת מטבעות — שיעורים חיים

המרה עם שיעור עדכני.

הנחיה
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 ו-AI

ל-Claude, Cursor ול-IDE שלך

Prompts הפועלים ב-IDE — כולל שרת MCP.

צינור IDP לחשבוניות + תיבות גבול + CSV

חילוץ אצווה עם קואורדינטות אימות.

הנחיה
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 — Document AI ב-IDE

חיבור MCP ועיבוד מסמכים מהעבודה.

הנחיה
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

סוכן קול — STT + TTS

עיבוד קלט קולי ותגובות אודיו.

הנחיה
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

זיהוי הונאות — טביעת אצבע + IP

בדיקת אותות טביעת אצבע של התקן וגיאוגרפיה/IP.

הנחיה
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

פיצול PDF באימון המוני

פיצול סינכרוני של תיקיות עם קבצי PDF גדולים.

הנחיה
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

מסווג מסמכים — OCR + תיקיה

OCR, סיווג וסידור בתיקיות משנה.

הנחיה
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.

קצה-אל-קצה

פייפליינים מלאים

מהכניסה ועד הייצוא — כל תחנה באותו פרומפט.

זיהוי תמונות מתקדם (IDP חשבוניות → ייצוא לחשבונאות)

העלאת קובץ PDF → זיהוי תמונות מתקדם (AI-IDP) + תיבות גבול → אימות → ייצוא CSV

הנחיה
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 חוזים + התראות למועדי סיום)

העלאת חוזה → מילות מפתח → Knowledge Graph → התראות

הנחיה
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 — Word / PowerPoint / PDF/A

העלאת קובץ PDF → בחירת פורמט → המרה → הורדה

הנחיה
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

Webhooks — עיבוד job.completed

רישום Webhook → שליחת מסמך → קבלת אירוע → עיבוד

הנחיה
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 — תיעוד מסמך לאודיו

זיהוי תווים אופטי (OCR) → עיבוד טקסט → יצירת קול ממוחשב (TTS) → שמירת אודיו

הנחיה
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

סריקת תיקייה → זיהוי תווים אופטי בכמות גדולה (Batch OCR) → איסוף טקסט → ייצוא ל-CSV

הנחיה
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

השלב הבא

המשך עם API

llms.txt ו-Playground — ללא דרכים עקיפות.

אסימון ל-REST ו-MCP תשובה עם credits_billed תשתית EU משלך
וידאו

Cookbook בפעולה

צפו ב-API של PaperOffice בפעולה — בסרטון.

Cookbook בפעולה

שאלות נפוצות

הכל חשוב במבט על

האם אני צריך SDK?

לא. ה-API של PaperOffice הוא REST טהור: נקודת קצה אחת, אסימון Bearer, multipart/form-data. בנוסף, זמין שרת MCP עבור IDEs וסוכנים.

למה קובץ llms.txt מופיע בכל פקודה?

קובץ llms.txt הוא הגרסה הקריאה למכונה של התיעוד API. המודל שלך קורא ממנו נקודות קצה, פרמטרים ופורמטים של תשובות — והוא לא ממציא שדות.

איזה מפתח אני מכניס?

משתמש טוקן עם הקידומת po_ut_. ניתן למצוא אותו באפליקציית PaperOffice תחת חשבון → API. החלף את po_ut_YOUR_API_KEY בפקודה במפתח שלך.

התוצאה מגיעה מיד או שאני צריך לבצע polling?

עם processing_lane=instant, API מחזיר תשובה סינכרונית (HTTP 200 עם result). ללא הפרמטר הזה, תקבל HTTP 202 עם job_id; את התוצאה ניתן לקבל באמצעות GET /job/get/{job_id} או באמצעות Webhook.

הפקודות עובדות בכל סביבה?

הפקודות אינן מכילות הוראות ספציפיות לכלי. נבדקו עם Claude, Claude Code ו-Cursor — כל סביבה שיכולה לקרוא כתובת URL תסתדר איתן.

כמה עולה קריאה?

כל תשובה מציינת credits_billed. מחירי ה-Credits לפי פייפליין מופיעים בטבלת המחירים; נגבה רק עבור מה שעובד בפועל.

היכן תרצו לנסות את PaperOffice?

המחשב והסמארטפון מחוברים: מרחב עבודה במחשב, תפיסה בטלפון.

גרסת הניסיון מוכנה

מאיפה ברצונכם להתחיל?

המרחב העבודה המלא מותאם למחשב. הגרסה לנייד מתאימה לתפיסה, בדיקה ואישור מסמכים.

app.paperoffice.ai

להתחיל במחשב

קישור הכניסה האישי יישלח לכתובת הדוא"ל שצוינה.

להירשם בחינם פתיחת היישום יישום PaperOffice המוצר המלא: ווב, שולחן עבודה ונייד. לכידה, ארגון, חיפוש ועבודה על מסמכים עם הצוות. נדרש חשבון חינם פתיחת Playground Playground נסו פונקציות נבחרות מיד — ללא רישום, עם מפתח API להדגמה מוגבל. ללא הרשמה, אך עם מפתח API להדגמה מוגבל