انتقل إلى المحتوى
نظرة عامة نظرة عامة أخبار أخبار
مشاركة

Cookbook

موجهات جاهزة للنسخ. أمثلة جاهزة لـ API.

28 موجهًا لـ Document AI، وبيانات APIs، وسير عمل IDE — انسخ، الصق، واحصل على الكود.

تقرأ ملفات llms.txt الخاصة بـ PaperOffice كل نموذج لغوي حديث: Claude، Cursor وبيئتك التطويرية (IDE) تكتب الباقي.

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

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 بالذكاء الاصطناعي — فصل ملف PDF مجمع

اكتشاف حدود المستندات وتسمية الملفات الفردية.

الموجه
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 + صناديق الحدود

استخراج حقول العقد بما في ذلك الموقع داخل المستند.

الموجه
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 (بريد إلكتروني أو رسالة نصية) وسجل الإرسال.

الموجه
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، بروكسي، تور، مركز بيانات.

الموجه
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 والذكاء الاصطناعي

لـ Claude، Cursor وبيئة التطوير الخاصة بك

أوامر تعمل داخل بيئة التطوير — تتضمن خادم 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 — الذكاء الاصطناعي للمستندات داخل بيئة التطوير

ربط خادم 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

الويب هوكس — معالجة job.completed

تسجيل الويب هوك → إرسال المستند → تم استلام الحدث → معالجة

الموجه
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 بنية تحتية خاصة في الاتحاد الأوروبي
فيديو

Cookbook في العمل

شاهد كيف تعمل PaperOffice API في الممارسة العملية — في الفيديو.

Cookbook في العمل

الأسئلة الشائعة

كل ما هو مهم في لمحة

هل أحتاج إلى SDK؟

لا. تعتمد PaperOffice API بالكامل على REST: نقطة نهاية واحدة، رمز حامل (Bearer Token)، وتنسيق multipart/form-data. بالإضافة إلى ذلك، يتوفر خادم MCP للمحركات البيئية المتكاملة (IDEs) والوكلاء.

لماذا يظهر ملف llms.txt في كل موجه؟

ملف llms.txt هو النسخة القابلة للقراءة آلياً من توثيق API. يقرأ نموذجك منه نقاط النهاية والمعلمات وتنسيقات الإجابات — ولا يخترع حقولاً.

أي مفتاح يجب أن أدخله؟

رمز مستخدم (User Token) يسبقه بادئة 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 لكل Pipeline موجودة في نظرة عامة على الأسعار؛ يتم الفوترة فقط لما تم معالجته فعلياً.

أين تودون تجربة PaperOffice؟

تم ربط الكمبيوتر والهاتف الذكي: مساحة العمل على جهاز الحاسوب، والالتقاط عبر الهاتف.

لقد أصبحت النسخة التجريبية الخاصة بك جاهزة

من أين ترغبون في البدء؟

تم تحسين مساحة العمل الكاملة لأجهزة الكمبيوتر. وتُعد النسخة المحمولة مناسبة لالتقاط المستندات ومراجعتها والموافقة عليها.

app.paperoffice.ai

البدء على الكمبيوتر

سنرسل رابط الدخول الشخصي الخاص بك إلى بريدك الإلكتروني.

التسجيل مجاناً فتح التطبيق تطبيق PaperOffice المنتج الكامل: ويب وسطح مكتب وجوال. التقاط المستندات وتنظيمها والبحث فيها والعمل عليها مع الفريق. يلزم حساب مجاني فتح ساحة التجربة ساحة التجربة جرّبوا وظائف محددة فوراً — دون تسجيل، بمفتاح API تجريبي مقيّد. بدون تسجيل، لكن بمفتاح API تجريبي مقيّد