{ "info": { "_postman_id": "paperoffice-ai-public-2026", "name": "PaperOffice AI API", "description": "# 🚀 Get Started in 10 Seconds\n\n**Forget SDKs. Let AI code for you.**\n\n```\n1. Paste URL in AI → Cursor, Windsurf, Claude, ChatGPT\n2. Prompt → Tell it what you need\n```\n\n**That's it.** Two steps. Your AI crawls the URL and writes the code.\n\n**From coders, for coders.** 🤘 No bullshit. Just paste, prompt, ship.\n\n---\n\n## 💡 Example Prompt\n\nJust copy this into your AI:\n\n```\nRead this API documentation:\nhttps://api.paperoffice.ai/latest/docs/postman\n\nCreate a Python function that takes an image \nand returns the OCR text.\n```\n\nYour AI will:\n- Crawl the URL automatically\n- Understand all endpoints\n- Write working code\n- Handle auth & errors\n\n---\n\n## 🔗 The Magic URL\n\n```\nhttps://api.paperoffice.ai/latest/docs/postman\n```\n\nPaste this URL in any AI. It reads the entire API spec automatically.\n\n---\n\n## ⚡ Before vs Now\n\n| Before (painful) | Now (10 seconds) |\n|------------------|------------------|\n| Read documentation | Paste URL |\n| Install SDK | Write prompt |\n| Copy examples | **Ship it** |\n| Debug for hours | |\n\n---\n\n## 🌍 Any Language\n\nYour AI speaks them all:\n\n`Python` `JavaScript` `TypeScript` `PHP` `Java` `Go` `Rust` `C#` `Ruby` `Swift` `Kotlin` `+ more`\n\nNo SDK needed. No library to learn. Just describe what you want.\n\n---\n\n## 🔐 Authentication\n\n**Option 1: VISITOR Mode (FREE - No token needed!)**\n```\nJust leave bearer_token variable empty.\nTest all endpoints with limited quota.\n```\n\n**Option 2: Full Access with User Token**\n```\nHeader: Authorization: Bearer YOUR_USER_TOKEN\n```\n\n### How to get your User Token:\n\n1. Login at [app.paperoffice.ai](https://app.paperoffice.ai)\n2. Go to **Settings → API Access** or **Account → Developer**\n3. Copy your **User Token** (starts with `po_usr_...`)\n\n### Token Types:\n\n| Token Type | Format | Use Case |\n|------------|--------|----------|\n| **User Token** | `po_usr_...` | **Use this!** Full API access tied to your account |\n| Device Token | `po_dev_...` | Mobile/Desktop app authentication |\n| VISITOR | (empty) | Free testing with limited quota |\n\n⚠️ **Important:** Document AI endpoints require a **User Token** to access your documents and workspaces!\n\n---\n\n## 🌐 Base URLs\n\n| Environment | URL |\n|-------------|-----|\n| **Development** | `https://api.paperoffice.ai/latest` |\n| **Production** | `https://api.paperoffice.ai/latest` |\n\n---\n\n## 📦 250+ Endpoints in 12 Categories\n\n| Category | What it does |\n|----------|--------------|\n| **Getting Started** | Documentation, Demo Files, Job Management |\n| **Agent AI** | RAG knowledge base, semantic search |\n| **AI-IDP** | Process invoices, receipts, contracts, IDs |\n| **AI-OCR** | Extract text from images/PDFs |\n| **Analytics AI** | Knowledge graph analysis |\n| **Automation AI** | Workflow forms, orchestration, tasks |\n| **Document AI** | Complete DMS with storage & connectors |\n| **Image AI** | AI image generation & editing |\n| **PaperOffice Account** | Billing, messages, compliance |\n| **PDF AI** | Convert, merge, split, edit PDFs |\n| **Security & Data AI** | Fraud prevention, geolocation, business data |\n| **Voice AI** | Text-to-Speech, Speech-to-Text |\n\n---\n\n## ⚡ Job Types: Sync vs Async\n\n```\npriority >= 900 → SYNC (waits for result, returns directly)\npriority < 900 → ASYNC (returns job_id, poll for result)\n```\n\n**Instant APIs** (no polling): Security & Data AI (IP lookup, BIC, currency)\n**Async APIs** (use polling): AI-OCR, AI-IDP, Image AI, Voice AI, PDF AI\n\n→ See **Getting Started → Job Management** for polling examples.\n\n---\n\n## 💬 Pro Tip for Power Users\n\nStart every session with:\n\n```\nRead this API: https://api.paperoffice.ai/latest/docs/postman\nI'll ask you to build integrations with it.\n```\n\nThen just chat naturally: *\"Now make me an invoice scanner\"*\n\n---\n\n## 🎯 One-Liner Examples\n\n**OCR an image:**\n```\n\"Use https://api.paperoffice.ai/latest/docs/postman - extract text from this image\"\n```\n\n**Process an invoice:**\n```\n\"Use https://api.paperoffice.ai/latest/docs/postman - extract all fields from this invoice PDF\"\n```\n\n**Generate speech:**\n```\n\"Use https://api.paperoffice.ai/latest/docs/postman - convert this text to speech\"\n```\n\n---\n\n**From coders, for coders.** 🤘\n\n*Last updated: January 13, 2026*\n\n\n---\n*Generated from MariaDB SOT (inkl. response_schema) at 2026-04-05 07:24:41*", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://api.paperoffice.ai/latest", "type": "string", "description": "API Base URL - Development: api.paperoffice.ai/latest, Production: api.paperoffice.ai/latest" }, { "key": "bearer_token", "value": "", "type": "string", "description": "Your User Token (po_usr_...) from app.paperoffice.ai → Settings → API Access. Leave EMPTY for free VISITOR tier!" }, { "key": "priority", "value": "900", "type": "string", "description": "Job Priority: ≥900=synchronous (waits for result), <900=async (returns job_id)" }, { "key": "job_id", "value": "", "type": "string", "description": "Auto-extracted from response" }, { "key": "pipeline", "value": "paperoffice_llm___generate", "type": "string", "description": "Pipeline for Generic Job Request" }, { "key": "locale", "value": "en_US", "type": "string", "description": "Response language/locale (e.g. en_US, de_DE, es_ES, fr_FR). Use full locale format for robustness." } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// ═══════════════════════════════════════════════════════", "// AUTO-EXTRACT job_id FROM RESPONSE", "// ═══════════════════════════════════════════════════════", "if (pm.response.code === 200 || pm.response.code === 201) {", " try {", " var jsonData = pm.response.json();", " ", " // Extract job_id if present", " if (jsonData.job_id) {", " pm.collectionVariables.set('job_id', jsonData.job_id);", " console.log('job_id saved: ' + jsonData.job_id);", " }", " ", " // Also check nested response.job_id", " if (jsonData.response && jsonData.response.job_id) {", " pm.collectionVariables.set('job_id', jsonData.response.job_id);", " console.log('job_id saved: ' + jsonData.response.job_id);", " }", " ", " // Check for data.job_id pattern", " if (jsonData.data && jsonData.data.job_id) {", " pm.collectionVariables.set('job_id', jsonData.data.job_id);", " console.log('job_id saved: ' + jsonData.data.job_id);", " }", " } catch (e) {", " // Response is not JSON - ignore", " }", "}" ] } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearer_token}}", "type": "string" } ] }, "item": [ { "name": "🤖 MCP Protocol", "item": [ { "name": "Execute Tool", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Führt ein Tool mit den angegebenen Argumenten aus. Der Tool-Name muss aus tools/list oder tools/search stammen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Tool name from tools/list (required)" }, { "key": "arguments", "value": "", "type": "text", "description": "Tool arguments as key-value pairs" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Führt ein Tool mit den angegebenen Argumenten aus. Der Tool-Name muss aus tools/list oder tools/search stammen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Tool name from tools/list (required)" }, { "key": "arguments", "value": "", "type": "text", "description": "Tool arguments as key-value pairs" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {\n \"POST \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp?debug=manifest\": \"string\"\n },\n \"tools_count\": 0,\n \"search\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"include_details\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"check\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"explain\": \"string\",\n \"examples\": \"string\",\n \"language\": \"string\",\n \"include_alternatives\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"intents\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"categories\": 0\n },\n \"documentation\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Initialize Session", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Startet eine neue MCP Session und gibt Server-Capabilities zurück. Muss vor allen anderen MCP-Aufrufen erfolgen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "protocolVersion", "value": "", "type": "text", "description": "MCP protocol version (e.g. 2024-11-05)" }, { "key": "capabilities", "value": "", "type": "text", "description": "Client capabilities" }, { "key": "clientInfo", "value": "", "type": "text", "description": "ClientInfo" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Startet eine neue MCP Session und gibt Server-Capabilities zurück. Muss vor allen anderen MCP-Aufrufen erfolgen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "protocolVersion", "value": "", "type": "text", "description": "MCP protocol version (e.g. 2024-11-05)" }, { "key": "capabilities", "value": "", "type": "text", "description": "Client capabilities" }, { "key": "clientInfo", "value": "", "type": "text", "description": "ClientInfo" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {\n \"POST \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp?debug=manifest\": \"string\"\n },\n \"tools_count\": 0,\n \"search\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"include_details\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"check\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"explain\": \"string\",\n \"examples\": \"string\",\n \"language\": \"string\",\n \"include_alternatives\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"intents\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"categories\": 0\n },\n \"documentation\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Intelligent Tool Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Intelligente Tool-Empfehlung mit Intent-Erkennung, Query-Anreicherung und Reasoning (Claude-Style). Versteht deutsche und englische Anfragen automatisch.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "User query (natural language, min 3 chars) (required)" }, { "key": "limit", "value": 5, "type": "text", "description": "Max recommendations (1-10, default: 5)" }, { "key": "explain", "value": true, "type": "text", "description": "Include reasoning for recommendations" }, { "key": "examples", "value": true, "type": "text", "description": "Include example API calls" }, { "key": "language", "value": "", "type": "text", "description": "Force language (auto-detected if omitted)" }, { "key": "include_alternatives", "value": true, "type": "text", "description": "Include alternative tools" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Intelligente Tool-Empfehlung mit Intent-Erkennung, Query-Anreicherung und Reasoning (Claude-Style). Versteht deutsche und englische Anfragen automatisch.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "User query (natural language, min 3 chars) (required)" }, { "key": "limit", "value": 5, "type": "text", "description": "Max recommendations (1-10, default: 5)" }, { "key": "explain", "value": true, "type": "text", "description": "Include reasoning for recommendations" }, { "key": "examples", "value": true, "type": "text", "description": "Include example API calls" }, { "key": "language", "value": "", "type": "text", "description": "Force language (auto-detected if omitted)" }, { "key": "include_alternatives", "value": true, "type": "text", "description": "Include alternative tools" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {\n \"POST \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp?debug=manifest\": \"string\"\n },\n \"tools_count\": 0,\n \"search\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"include_details\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"check\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"explain\": \"string\",\n \"examples\": \"string\",\n \"language\": \"string\",\n \"include_alternatives\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"intents\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"categories\": 0\n },\n \"documentation\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List All Tools", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Listet alle verfügbaren Tools mit Beschreibungen und Input-Schemas auf. Unterstützt Pagination (100 Tools pro Seite).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "cursor", "value": "", "type": "text", "description": "Pagination cursor from previous response" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Listet alle verfügbaren Tools mit Beschreibungen und Input-Schemas auf. Unterstützt Pagination (100 Tools pro Seite).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "cursor", "value": "", "type": "text", "description": "Pagination cursor from previous response" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {\n \"POST \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp?debug=manifest\": \"string\"\n },\n \"tools_count\": 0,\n \"search\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"include_details\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"check\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"explain\": \"string\",\n \"examples\": \"string\",\n \"language\": \"string\",\n \"include_alternatives\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"intents\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"categories\": 0\n },\n \"documentation\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List Intent Categories", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Listet alle verfügbaren Intent-Kategorien für tools/check auf. Zeigt Keywords und Beschreibungen für jede Kategorie.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Listet alle verfügbaren Intent-Kategorien für tools/check auf. Zeigt Keywords und Beschreibungen für jede Kategorie.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {\n \"POST \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp?debug=manifest\": \"string\"\n },\n \"tools_count\": 0,\n \"search\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"include_details\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"check\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"explain\": \"string\",\n \"examples\": \"string\",\n \"language\": \"string\",\n \"include_alternatives\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"intents\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"categories\": 0\n },\n \"documentation\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Search Tools", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Semantische Suche nach Tools mit Hybrid-Algorithmus (70% Vector-Embeddings, 30% Volltext). Findet relevante Tools basierend auf natürlichsprachlichen Anfragen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Search query (natural language, min 2 chars) (required)" }, { "key": "limit", "value": 5, "type": "text", "description": "Max results (1-20, default: 5)" }, { "key": "include_details", "value": true, "type": "text", "description": "Include full tool details" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/mcp", "host": [ "{{base_url}}" ], "path": [ "mcp" ] }, "description": "Semantische Suche nach Tools mit Hybrid-Algorithmus (70% Vector-Embeddings, 30% Volltext). Findet relevante Tools basierend auf natürlichsprachlichen Anfragen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Search query (natural language, min 2 chars) (required)" }, { "key": "limit", "value": 5, "type": "text", "description": "Max results (1-20, default: 5)" }, { "key": "include_details", "value": true, "type": "text", "description": "Include full tool details" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {\n \"POST \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp\": \"string\",\n \"GET \\/dev\\/mcp?debug=manifest\": \"string\"\n },\n \"tools_count\": 0,\n \"search\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"include_details\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"check\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"params\": {\n \"query\": \"string\",\n \"limit\": \"string\",\n \"explain\": \"string\",\n \"examples\": \"string\",\n \"language\": \"string\",\n \"include_alternatives\": \"string\"\n },\n \"features\": [\n \"string\"\n ]\n },\n \"intents\": {\n \"method\": \"string\",\n \"description\": \"string\",\n \"categories\": 0\n },\n \"documentation\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "✏️ PDF Editing", "item": [ { "name": "Ai split", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF AI Split Automatically detect and split multi-document PDFs into individual files using AI Vision analysis. --- When to Use - Batch Scanning - Split a stack of scanned documents into individual files - Mail Processing - Separate multiple letters/invoices from one scan - Archive Digitization -...\n\n💰 **Kosten**: 40 Credits/page (0.04€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "PDF file to analyze and split (required)" }, { "key": "template", "value": "pdf_ai_split", "type": "text", "description": "Workflow template name required" }, { "key": "naming_instruction", "value": "Dokumenttyp_Datum_Absender", "type": "text", "description": "Naming pattern for output files optional" }, { "key": "locale", "value": "de_DE", "type": "text", "description": "Locale for ALL output: 'de_DE', 'en_US', 'fr_FR' - affects document_type, reasoning, filenames" }, { "key": "document_types", "value": "", "type": "text", "description": "Allowed types, comma-separated: 'Rechnung,Schreiben,Angebot' optional" }, { "key": "date_format", "value": "DD.MM.YYYY", "type": "text", "description": "Date format: 'YYYY-MM-DD', 'DD.MM.YYYY', 'MM/DD/YYYY' optional" }, { "key": "include_document_type", "value": "false", "type": "text", "description": "Include document_type in response default: false" }, { "key": "include_date", "value": "false", "type": "text", "description": "Include date in response default: false" }, { "key": "include_sender", "value": "false", "type": "text", "description": "Include sender in response default: false" }, { "key": "include_reasoning", "value": "false", "type": "text", "description": "Include reasoning in response default: false" }, { "key": "priority", "value": "900", "type": "text", "description": "≥900=sync wait for result," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF AI Split Automatically detect and split multi-document PDFs into individual files using AI Vision analysis. --- When to Use - Batch Scanning - Split a stack of scanned documents into individual files - Mail Processing - Separate multiple letters/invoices from one scan - Archive Digitization -...\n\n💰 **Kosten**: 40 Credits/page (0.04€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "PDF file to analyze and split (required)" }, { "key": "template", "value": "pdf_ai_split", "type": "text", "description": "Workflow template name required" }, { "key": "naming_instruction", "value": "Dokumenttyp_Datum_Absender", "type": "text", "description": "Naming pattern for output files optional" }, { "key": "locale", "value": "de_DE", "type": "text", "description": "Locale for ALL output: 'de_DE', 'en_US', 'fr_FR' - affects document_type, reasoning, filenames" }, { "key": "document_types", "value": "", "type": "text", "description": "Allowed types, comma-separated: 'Rechnung,Schreiben,Angebot' optional" }, { "key": "date_format", "value": "DD.MM.YYYY", "type": "text", "description": "Date format: 'YYYY-MM-DD', 'DD.MM.YYYY', 'MM/DD/YYYY' optional" }, { "key": "include_document_type", "value": "false", "type": "text", "description": "Include document_type in response default: false" }, { "key": "include_date", "value": "false", "type": "text", "description": "Include date in response default: false" }, { "key": "include_sender", "value": "false", "type": "text", "description": "Include sender in response default: false" }, { "key": "include_reasoning", "value": "false", "type": "text", "description": "Include reasoning in response default: false" }, { "key": "priority", "value": "900", "type": "text", "description": "≥900=sync wait for result," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"standard_output\": {\n \"data\": {\n \"structured\": {\n \"documents_created\": [\n null\n ]\n }\n }\n }\n }\n}" } ] } ] }, { "name": "🔍 OCR", "item": [ { "name": "Get json", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get OCR Text JSON Retrieve extracted text from all pages. Response includes: - Per-page OCR text - Statistics char_count, line_count, confidence - Optional: Bounding boxes for word positions\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "locale", "value": "", "type": "text", "description": "Response language: de_DE, en_US, es_ES, fr_FR, it_IT, pt_PT" }, { "key": "page", "value": "", "type": "text", "description": "Optional: Specific page number (1-based)" }, { "key": "include_bounding_boxes", "value": "", "type": "text", "description": "Include word coordinates (x, y, width, height)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get OCR Text JSON Retrieve extracted text from all pages. Response includes: - Per-page OCR text - Statistics char_count, line_count, confidence - Optional: Bounding boxes for word positions\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "locale", "value": "", "type": "text", "description": "Response language: de_DE, en_US, es_ES, fr_FR, it_IT, pt_PT" }, { "key": "page", "value": "", "type": "text", "description": "Optional: Specific page number (1-based)" }, { "key": "include_bounding_boxes", "value": "", "type": "text", "description": "Include word coordinates (x, y, width, height)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"pages\": [\n {}\n ],\n \"confidence\": 0\n }\n }\n}" } ] }, { "name": "Ocr details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Detaillierte OCR-Daten eines Dokuments. Includes: - Text pro Seite - Bounding Boxes x, y, width, height - Confidence Scores - Erkannte Sprache - Character/Word Counts\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "page", "value": "", "type": "text", "description": "Optional: Specific page number" }, { "key": "include_bounding_boxes", "value": "", "type": "text", "description": "Include word/line bounding boxes" }, { "key": "format", "value": "", "type": "text", "description": "full, text_only, or structured" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Detaillierte OCR-Daten eines Dokuments. Includes: - Text pro Seite - Bounding Boxes x, y, width, height - Confidence Scores - Erkannte Sprache - Character/Word Counts\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "page", "value": "", "type": "text", "description": "Optional: Specific page number" }, { "key": "include_bounding_boxes", "value": "", "type": "text", "description": "Include word/line bounding boxes" }, { "key": "format", "value": "", "type": "text", "description": "full, text_only, or structured" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"pages\": [\n {}\n ],\n \"confidence\": 0,\n \"languages_detected\": [\n \"string\"\n ],\n \"word_count\": 0\n }\n }\n}" } ] }, { "name": "Plain text", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get OCR Text Plain Text Returns OCR text as plain text, page by page. Useful for: - Copy/paste full document text - Integration with text processing tools - Simple exports\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "format", "value": "", "type": "text", "description": "Output format: json (default), text (plain text)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get OCR Text Plain Text Returns OCR text as plain text, page by page. Useful for: - Copy/paste full document text - Integration with text processing tools - Simple exports\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "format", "value": "", "type": "text", "description": "Output format: json (default), text (plain text)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "🤖 AI-OCR", "item": [ { "name": "Aiocr gridboxes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI-OCR Grid/Boxes OCR with bounding boxes - includes precise text positions for each line. Required for Document Anonymization! --- When to Use - Document Anonymization redacting sensitive data - IDP Intelligent Document Processing workflows - Text highlighting/annotation - When you need to know ...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Required. Image or PDF file for text extraction. Supported: PNG, JPG, JPEG, TIFF, BMP, WEBP, PDF" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. >=900 = sync waits for result," }, { "key": "ocr_mode", "value": "grid", "type": "text", "description": "OCR mode: text fastest, text only, grid + bounding boxes, complete + tables + layout" }, { "key": "output_searchable_pdf", "value": "false", "type": "text", "description": "Create searchable PDF Sandwich PDF with invisible OCR layer. Default: false" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI-OCR Grid/Boxes OCR with bounding boxes - includes precise text positions for each line. Required for Document Anonymization! --- When to Use - Document Anonymization redacting sensitive data - IDP Intelligent Document Processing workflows - Text highlighting/annotation - When you need to know ...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Required. Image or PDF file for text extraction. Supported: PNG, JPG, JPEG, TIFF, BMP, WEBP, PDF" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. >=900 = sync waits for result," }, { "key": "ocr_mode", "value": "grid", "type": "text", "description": "OCR mode: text fastest, text only, grid + bounding boxes, complete + tables + layout" }, { "key": "output_searchable_pdf", "value": "false", "type": "text", "description": "Create searchable PDF Sandwich PDF with invisible OCR layer. Default: false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"pages\": {},\n \"simplified_boxes\": [\n {}\n ],\n \"summary\": {}\n }\n }\n}" } ] }, { "name": "Complete analysis", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI-OCR Complete Analysis Full document analysis - includes text, bounding boxes, table detection, and layout analysis. --- When to Use - Complex documents with tables and structured layouts - Financial reports, invoices with line items - Scientific papers, technical documents - When you need tabl...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Required. Image or PDF file for text extraction. Supported: PNG, JPG, JPEG, TIFF, BMP, WEBP, PDF" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. >=900 = sync waits for result," }, { "key": "ocr_mode", "value": "complete", "type": "text", "description": "OCR mode: text fastest, text only, grid + bounding boxes, complete + tables + layout" }, { "key": "output_searchable_pdf", "value": "false", "type": "text", "description": "Create searchable PDF Sandwich PDF with invisible OCR layer. Default: false" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI-OCR Complete Analysis Full document analysis - includes text, bounding boxes, table detection, and layout analysis. --- When to Use - Complex documents with tables and structured layouts - Financial reports, invoices with line items - Scientific papers, technical documents - When you need tabl...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Required. Image or PDF file for text extraction. Supported: PNG, JPG, JPEG, TIFF, BMP, WEBP, PDF" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. >=900 = sync waits for result," }, { "key": "ocr_mode", "value": "complete", "type": "text", "description": "OCR mode: text fastest, text only, grid + bounding boxes, complete + tables + layout" }, { "key": "output_searchable_pdf", "value": "false", "type": "text", "description": "Create searchable PDF Sandwich PDF with invisible OCR layer. Default: false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"pages\": {},\n \"simplified_boxes\": [\n {\n \"id\": 0,\n \"text\": \"string\",\n \"page\": \"string\",\n \"bounding_box\": {},\n \"confidence\": 0\n }\n ],\n \"summary\": {\n \"total_pages\": 0,\n \"total_lines\": 0,\n \"total_chars\": 0,\n \"avg_confidence\": 0,\n \"total_processing_time\": 0,\n \"combined_text\": \"string\",\n \"poaiocr_extracted_fulltext\": \"string\",\n \"combined_markdown\": \"string\",\n \"total_bounding_boxes\": 0,\n \"processing_engine\": \"string\",\n \"created_at\": \"string\"\n }\n }\n }\n}" } ] }, { "name": "Text only", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI-OCR Text Only Fastest OCR mode - extracts text only without position data. --- When to Use - Fast text extraction from documents - Full-text search indexing - Text content analysis - When you DON'T need text positions --- Performance | Metric | Value | |--------|-------| | Speed | ~93 pages/mi...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Required. Image or PDF file for text extraction. Supported: PNG, JPG, JPEG, TIFF, BMP, WEBP, PDF" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. >=900 = sync waits for result," }, { "key": "ocr_mode", "value": "text", "type": "text", "description": "OCR mode: text fastest, text only, grid + bounding boxes, complete + tables + layout" }, { "key": "output_searchable_pdf", "value": "false", "type": "text", "description": "Create searchable PDF Sandwich PDF with invisible OCR layer. Default: false" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI-OCR Text Only Fastest OCR mode - extracts text only without position data. --- When to Use - Fast text extraction from documents - Full-text search indexing - Text content analysis - When you DON'T need text positions --- Performance | Metric | Value | |--------|-------| | Speed | ~93 pages/mi...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Required. Image or PDF file for text extraction. Supported: PNG, JPG, JPEG, TIFF, BMP, WEBP, PDF" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. >=900 = sync waits for result," }, { "key": "ocr_mode", "value": "text", "type": "text", "description": "OCR mode: text fastest, text only, grid + bounding boxes, complete + tables + layout" }, { "key": "output_searchable_pdf", "value": "false", "type": "text", "description": "Create searchable PDF Sandwich PDF with invisible OCR layer. Default: false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"summary\": {\n \"total_pages\": 0,\n \"total_lines\": 0,\n \"combined_text\": \"string\",\n \"poaiocr_extracted_fulltext\": \"string\",\n \"processing_engine\": \"string\"\n }\n }\n }\n}" } ] } ] }, { "name": "🖼️ Image Processing", "item": [ { "name": "Max 1280x1280", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Image Generation (Premium Tier)\n\nGenerates high-quality images using Z-Image-Turbo AI. Max resolution: 1280x1280 (16px grid).\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| prompt | string | Yes | Text description of the image to generate |\n| model | string | No | Tier: basic, premium (default), ultra |\n| width | int | No | Image width, max 1280 for premium tier, snapped to 16px grid |\n| height | int | No | Image height, max 1280 for premium tier, snapped to 16px grid |\n| num_images | int | No | Number of images to generate (default: 1) |\n| negative_prompt | string | No | What to avoid in the generated image |\n| seed | int | No | Fixed seed for reproducibility (-1 = random) |\n| steps | int | No | Generation quality steps (default: 15) |\n| guidance_scale | float | No | Prompt adherence strength (default: 4.0) |\n| precompile_prompt | bool | No | AI-optimize prompt before generation (default: true) |\n| output | string | No | Response format: url, inline (raw binary), base64 |\n| priority | int | No | >=900 for synchronous processing |\n\nCommon Use Cases:\n- Professional photos: 1024x1024 or 1280x1280 for high detail\n- Marketing materials: Landscape 1280x720 (16:9) or portrait 720x1280 (9:16)\n- Batch generation: num_images=2-10 for A/B testing variants\n- Product images: With negative_prompt to exclude unwanted elements\n- Reproducible: Fixed seed for consistent branding\n\n💰 **Kosten**: 50 Credits/image (0.05€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "A beautiful sunset over mountains, photorealistic, golden hour lighting", "type": "text", "description": "Required. Text description of the image to generate (required)" }, { "key": "model", "value": "premium", "type": "text", "description": "Required. Tier: basic, premium, or ultra (required)" }, { "key": "width", "value": "1024", "type": "text", "description": "Image width max 1280 for premium tier" }, { "key": "height", "value": "1024", "type": "text", "description": "Image height max 1280 for premium tier" }, { "key": "num_images", "value": "1", "type": "text", "description": "Number of images to generate default: 1" }, { "key": "negative_prompt", "value": "", "type": "text", "description": "Optional. What to avoid in the image" }, { "key": "seed", "value": "-1", "type": "text", "description": "Seed for reproducibility -1 = random" }, { "key": "steps", "value": "15", "type": "text", "description": "Generation steps default: 15" }, { "key": "guidance_scale", "value": "4.0", "type": "text", "description": "Guidance scale default: 4.0" }, { "key": "precompile_prompt", "value": "true", "type": "text", "description": "AI-optimize prompt default: true" }, { "key": "output", "value": "inline", "type": "text", "description": "Output mode: url JSON with URLs, inline raw image binary, base64 JSON with base64 data" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Image Generation (Premium Tier)\n\nGenerates high-quality images using Z-Image-Turbo AI. Max resolution: 1280x1280 (16px grid).\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| prompt | string | Yes | Text description of the image to generate |\n| model | string | No | Tier: basic, premium (default), ultra |\n| width | int | No | Image width, max 1280 for premium tier, snapped to 16px grid |\n| height | int | No | Image height, max 1280 for premium tier, snapped to 16px grid |\n| num_images | int | No | Number of images to generate (default: 1) |\n| negative_prompt | string | No | What to avoid in the generated image |\n| seed | int | No | Fixed seed for reproducibility (-1 = random) |\n| steps | int | No | Generation quality steps (default: 15) |\n| guidance_scale | float | No | Prompt adherence strength (default: 4.0) |\n| precompile_prompt | bool | No | AI-optimize prompt before generation (default: true) |\n| output | string | No | Response format: url, inline (raw binary), base64 |\n| priority | int | No | >=900 for synchronous processing |\n\nCommon Use Cases:\n- Professional photos: 1024x1024 or 1280x1280 for high detail\n- Marketing materials: Landscape 1280x720 (16:9) or portrait 720x1280 (9:16)\n- Batch generation: num_images=2-10 for A/B testing variants\n- Product images: With negative_prompt to exclude unwanted elements\n- Reproducible: Fixed seed for consistent branding\n\n💰 **Kosten**: 50 Credits/image (0.05€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "A beautiful sunset over mountains, photorealistic, golden hour lighting", "type": "text", "description": "Required. Text description of the image to generate (required)" }, { "key": "model", "value": "premium", "type": "text", "description": "Required. Tier: basic, premium, or ultra (required)" }, { "key": "width", "value": "1024", "type": "text", "description": "Image width max 1280 for premium tier" }, { "key": "height", "value": "1024", "type": "text", "description": "Image height max 1280 for premium tier" }, { "key": "num_images", "value": "1", "type": "text", "description": "Number of images to generate default: 1" }, { "key": "negative_prompt", "value": "", "type": "text", "description": "Optional. What to avoid in the image" }, { "key": "seed", "value": "-1", "type": "text", "description": "Seed for reproducibility -1 = random" }, { "key": "steps", "value": "15", "type": "text", "description": "Generation steps default: 15" }, { "key": "guidance_scale", "value": "4.0", "type": "text", "description": "Guidance scale default: 4.0" }, { "key": "precompile_prompt", "value": "true", "type": "text", "description": "AI-optimize prompt default: true" }, { "key": "output", "value": "inline", "type": "text", "description": "Output mode: url JSON with URLs, inline raw image binary, base64 JSON with base64 data" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"width\": 0,\n \"height\": 0,\n \"seed\": 0,\n \"steps\": 0,\n \"guidance_scale\": 0\n }\n }\n}" } ] }, { "name": "Max 2048x2048", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Image Generation (Ultra Tier)\n\nGenerates maximum-quality images using Z-Image-Turbo AI. Max resolution: 2048x2048 (16px grid).\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| prompt | string | Yes | Text description of the image to generate |\n| model | string | No | Tier: basic, premium, ultra (default) |\n| width | int | No | Image width, max 2048 for ultra tier, snapped to 16px grid |\n| height | int | No | Image height, max 2048 for ultra tier, snapped to 16px grid |\n| num_images | int | No | Number of images to generate (default: 1) |\n| negative_prompt | string | No | What to avoid in the generated image |\n| seed | int | No | Fixed seed for reproducibility (-1 = random) |\n| steps | int | No | Generation quality steps (default: 15, recommended: 25 for ultra) |\n| guidance_scale | float | No | Prompt adherence strength (default: 4.0, recommended: 7.5 for ultra) |\n| precompile_prompt | bool | No | AI-optimize prompt before generation (default: true) |\n| output | string | No | Response format: url, inline (raw binary), base64 |\n| priority | int | No | >=900 for synchronous processing |\n\nCommon Use Cases:\n- Print-ready images: 2048x2048 or 1536x1536 for maximum quality\n- Poster/banner: Wide formats like 2048x1152 (16:9)\n- Art generation: Higher steps (25+) and guidance (7.5+) for detailed output\n- Large format: Billboards, presentations, high-DPI displays\n\n💰 **Kosten**: 60 Credits/image (0.06€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "A beautiful sunset over mountains, photorealistic, golden hour lighting", "type": "text", "description": "Required. Text description of the image to generate (required)" }, { "key": "model", "value": "ultra", "type": "text", "description": "Required. Tier: basic, premium, or ultra (required)" }, { "key": "width", "value": "1536", "type": "text", "description": "Image width max 2048 for ultra tier" }, { "key": "height", "value": "1536", "type": "text", "description": "Image height max 2048 for ultra tier" }, { "key": "num_images", "value": "1", "type": "text", "description": "Number of images to generate default: 1" }, { "key": "negative_prompt", "value": "", "type": "text", "description": "Optional. What to avoid in the image" }, { "key": "seed", "value": "-1", "type": "text", "description": "Seed for reproducibility -1 = random" }, { "key": "steps", "value": "15", "type": "text", "description": "Generation steps default: 15" }, { "key": "guidance_scale", "value": "4.0", "type": "text", "description": "Guidance scale default: 4.0" }, { "key": "precompile_prompt", "value": "true", "type": "text", "description": "AI-optimize prompt default: true" }, { "key": "output", "value": "inline", "type": "text", "description": "Output mode: url JSON with URLs, inline raw image binary, base64 JSON with base64 data" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Image Generation (Ultra Tier)\n\nGenerates maximum-quality images using Z-Image-Turbo AI. Max resolution: 2048x2048 (16px grid).\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| prompt | string | Yes | Text description of the image to generate |\n| model | string | No | Tier: basic, premium, ultra (default) |\n| width | int | No | Image width, max 2048 for ultra tier, snapped to 16px grid |\n| height | int | No | Image height, max 2048 for ultra tier, snapped to 16px grid |\n| num_images | int | No | Number of images to generate (default: 1) |\n| negative_prompt | string | No | What to avoid in the generated image |\n| seed | int | No | Fixed seed for reproducibility (-1 = random) |\n| steps | int | No | Generation quality steps (default: 15, recommended: 25 for ultra) |\n| guidance_scale | float | No | Prompt adherence strength (default: 4.0, recommended: 7.5 for ultra) |\n| precompile_prompt | bool | No | AI-optimize prompt before generation (default: true) |\n| output | string | No | Response format: url, inline (raw binary), base64 |\n| priority | int | No | >=900 for synchronous processing |\n\nCommon Use Cases:\n- Print-ready images: 2048x2048 or 1536x1536 for maximum quality\n- Poster/banner: Wide formats like 2048x1152 (16:9)\n- Art generation: Higher steps (25+) and guidance (7.5+) for detailed output\n- Large format: Billboards, presentations, high-DPI displays\n\n💰 **Kosten**: 60 Credits/image (0.06€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "A beautiful sunset over mountains, photorealistic, golden hour lighting", "type": "text", "description": "Required. Text description of the image to generate (required)" }, { "key": "model", "value": "ultra", "type": "text", "description": "Required. Tier: basic, premium, or ultra (required)" }, { "key": "width", "value": "1536", "type": "text", "description": "Image width max 2048 for ultra tier" }, { "key": "height", "value": "1536", "type": "text", "description": "Image height max 2048 for ultra tier" }, { "key": "num_images", "value": "1", "type": "text", "description": "Number of images to generate default: 1" }, { "key": "negative_prompt", "value": "", "type": "text", "description": "Optional. What to avoid in the image" }, { "key": "seed", "value": "-1", "type": "text", "description": "Seed for reproducibility -1 = random" }, { "key": "steps", "value": "15", "type": "text", "description": "Generation steps default: 15" }, { "key": "guidance_scale", "value": "4.0", "type": "text", "description": "Guidance scale default: 4.0" }, { "key": "precompile_prompt", "value": "true", "type": "text", "description": "AI-optimize prompt default: true" }, { "key": "output", "value": "inline", "type": "text", "description": "Output mode: url JSON with URLs, inline raw image binary, base64 JSON with base64 data" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"width\": 0,\n \"height\": 0,\n \"seed\": 0,\n \"steps\": 0,\n \"guidance_scale\": 0\n }\n }\n}" } ] }, { "name": "Max 512x512", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Image Generation (Basic Tier)\n\nGenerates images using Z-Image-Turbo AI. Max resolution: 512x512 (16px grid).\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| prompt | string | Yes | Text description of the image to generate |\n| model | string | No | Tier: basic (default), premium, ultra |\n| width | int | No | Image width, max 512 for basic tier, snapped to 16px grid |\n| height | int | No | Image height, max 512 for basic tier, snapped to 16px grid |\n| num_images | int | No | Number of images to generate (default: 1) |\n| negative_prompt | string | No | What to avoid in the generated image |\n| seed | int | No | Fixed seed for reproducibility (-1 = random) |\n| steps | int | No | Generation quality steps (default: 15) |\n| guidance_scale | float | No | Prompt adherence strength (default: 4.0) |\n| precompile_prompt | bool | No | AI-optimize prompt before generation (default: true, set false for raw/exact prompts) |\n| output | string | No | Response format: url (JSON with download URLs), inline (raw image binary), base64 (JSON with base64 data) |\n| priority | int | No | >=900 for synchronous processing, <900 for async (returns job_id) |\n\nCommon Use Cases:\n- Icons/Logos: Square 512x512 with precompile_prompt=false for exact control\n- Thumbnails: Small preview images\n- Batch generation: Set num_images=2-10 for multiple variants\n- Reproducible results: Use a fixed seed value (same seed + same prompt = same image)\n- Fine-tuned quality: Increase steps (e.g. 25) and guidance_scale (e.g. 7.5)\n- Negative prompts: Exclude unwanted elements (e.g. \"blurry, low quality, watermark\")\n- Aspect ratios: Set width/height freely within max (e.g. 512x288 for landscape, 288x512 for portrait)\n\n💰 **Kosten**: 40 Credits/image (0.04€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "A beautiful sunset over mountains, photorealistic, golden hour lighting", "type": "text", "description": "Required. Text description of the image to generate (required)" }, { "key": "model", "value": "basic", "type": "text", "description": "Required. Tier: basic, premium, or ultra (required)" }, { "key": "width", "value": "512", "type": "text", "description": "Image width max 512 for basic tier" }, { "key": "height", "value": "512", "type": "text", "description": "Image height max 512 for basic tier" }, { "key": "num_images", "value": "1", "type": "text", "description": "Number of images to generate default: 1" }, { "key": "negative_prompt", "value": "", "type": "text", "description": "Optional. What to avoid in the image" }, { "key": "seed", "value": "-1", "type": "text", "description": "Seed for reproducibility -1 = random" }, { "key": "precompile_prompt", "value": "true", "type": "text", "description": "AI-optimize prompt default: true" }, { "key": "output", "value": "inline", "type": "text", "description": "Output mode: url JSON with URLs, inline raw image binary, base64 JSON with base64 data" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," }, { "key": "steps", "value": "15", "type": "text", "description": "Steps" }, { "key": "guidance_scale", "value": "4.0", "type": "text", "description": "Guidance scale" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Image Generation (Basic Tier)\n\nGenerates images using Z-Image-Turbo AI. Max resolution: 512x512 (16px grid).\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| prompt | string | Yes | Text description of the image to generate |\n| model | string | No | Tier: basic (default), premium, ultra |\n| width | int | No | Image width, max 512 for basic tier, snapped to 16px grid |\n| height | int | No | Image height, max 512 for basic tier, snapped to 16px grid |\n| num_images | int | No | Number of images to generate (default: 1) |\n| negative_prompt | string | No | What to avoid in the generated image |\n| seed | int | No | Fixed seed for reproducibility (-1 = random) |\n| steps | int | No | Generation quality steps (default: 15) |\n| guidance_scale | float | No | Prompt adherence strength (default: 4.0) |\n| precompile_prompt | bool | No | AI-optimize prompt before generation (default: true, set false for raw/exact prompts) |\n| output | string | No | Response format: url (JSON with download URLs), inline (raw image binary), base64 (JSON with base64 data) |\n| priority | int | No | >=900 for synchronous processing, <900 for async (returns job_id) |\n\nCommon Use Cases:\n- Icons/Logos: Square 512x512 with precompile_prompt=false for exact control\n- Thumbnails: Small preview images\n- Batch generation: Set num_images=2-10 for multiple variants\n- Reproducible results: Use a fixed seed value (same seed + same prompt = same image)\n- Fine-tuned quality: Increase steps (e.g. 25) and guidance_scale (e.g. 7.5)\n- Negative prompts: Exclude unwanted elements (e.g. \"blurry, low quality, watermark\")\n- Aspect ratios: Set width/height freely within max (e.g. 512x288 for landscape, 288x512 for portrait)\n\n💰 **Kosten**: 40 Credits/image (0.04€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "A beautiful sunset over mountains, photorealistic, golden hour lighting", "type": "text", "description": "Required. Text description of the image to generate (required)" }, { "key": "model", "value": "basic", "type": "text", "description": "Required. Tier: basic, premium, or ultra (required)" }, { "key": "width", "value": "512", "type": "text", "description": "Image width max 512 for basic tier" }, { "key": "height", "value": "512", "type": "text", "description": "Image height max 512 for basic tier" }, { "key": "num_images", "value": "1", "type": "text", "description": "Number of images to generate default: 1" }, { "key": "negative_prompt", "value": "", "type": "text", "description": "Optional. What to avoid in the image" }, { "key": "seed", "value": "-1", "type": "text", "description": "Seed for reproducibility -1 = random" }, { "key": "precompile_prompt", "value": "true", "type": "text", "description": "AI-optimize prompt default: true" }, { "key": "output", "value": "inline", "type": "text", "description": "Output mode: url JSON with URLs, inline raw image binary, base64 JSON with base64 data" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," }, { "key": "steps", "value": "15", "type": "text", "description": "Steps" }, { "key": "guidance_scale", "value": "4.0", "type": "text", "description": "Guidance scale" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"width\": 0,\n \"height\": 0,\n \"seed\": 0,\n \"steps\": 0,\n \"guidance_scale\": 0\n }\n }\n}" } ] }, { "name": "Remove background", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Remove Background from Image\n\nRemoves the background from any image using AI (REMBG), leaving only the foreground subject with transparency.\n\nSupported Input Formats: JPG, JPEG, PNG, WebP, GIF, BMP\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| file | file | Yes | Image file to process |\n| output_format | string | No | Output format: webp (default, best quality/size), png (lossless with transparency) |\n| output | string | No | Response format: url (JSON with download URL, default), inline (raw image binary for direct embedding), base64 (JSON with base64 data URL) |\n| priority | int | No | >=900 for synchronous processing (default for remove_bg) |\n\nProcessing Time: ~5 seconds (always synchronous)\n\n💰 **Kosten**: 10 Credits/image (0.01€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "Image file JPG, JPEG, PNG, WebP, GIF, BMP (required)" }, { "key": "output_format", "value": "webp", "type": "text", "description": "Output format: webp default or png" }, { "key": "output", "value": "url", "type": "text", "description": "Output mode: url default, inline raw binary, base64" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync default for remove_bg" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Remove Background from Image\n\nRemoves the background from any image using AI (REMBG), leaving only the foreground subject with transparency.\n\nSupported Input Formats: JPG, JPEG, PNG, WebP, GIF, BMP\n\nParameters:\n| Param | Type | Required | Description |\n|-------|------|----------|-------------|\n| file | file | Yes | Image file to process |\n| output_format | string | No | Output format: webp (default, best quality/size), png (lossless with transparency) |\n| output | string | No | Response format: url (JSON with download URL, default), inline (raw image binary for direct embedding), base64 (JSON with base64 data URL) |\n| priority | int | No | >=900 for synchronous processing (default for remove_bg) |\n\nProcessing Time: ~5 seconds (always synchronous)\n\n💰 **Kosten**: 10 Credits/image (0.01€/image)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "Image file JPG, JPEG, PNG, WebP, GIF, BMP (required)" }, { "key": "output_format", "value": "webp", "type": "text", "description": "Output format: webp default or png" }, { "key": "output", "value": "url", "type": "text", "description": "Output mode: url default, inline raw binary, base64" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync default for remove_bg" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"width\": 0,\n \"height\": 0,\n \"seed\": 0,\n \"steps\": 0,\n \"guidance_scale\": 0\n }\n }\n}" } ] } ] }, { "name": "🧠 AI Features", "item": [ { "name": "Agent createupdate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/agents_v2/create", "host": [ "{{base_url}}" ], "path": [ "agents_v2", "create" ] }, "description": "Create or Update AI Agent Attach AI agent configuration to a document. Use case: - Custom extraction fields beyond standard IDP\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des Agents (nur bei Update)" }, { "key": "name", "value": "", "type": "text", "description": "Name des Agents (Pflicht bei Neuerstellung)" }, { "key": "system_prompt", "value": "", "type": "text", "description": "System-Prompt des Agents (Pflicht bei Neuerstellung)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Agents" }, { "key": "llm_tier", "value": "basic", "type": "text", "description": "LLM-Qualitaetsstufe" }, { "key": "channels", "value": "", "type": "text", "description": "Kommunikationskanaele (chat, phone, email, widget)" }, { "key": "voice_id", "value": "", "type": "text", "description": "Voice-ID fuer Telefonie-Kanal" }, { "key": "language", "value": "de", "type": "text", "description": "Sprache des Agents (ISO-Code)" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie des Agents" }, { "key": "tags", "value": "", "type": "text", "description": "Tags fuer Suche und Filterung" }, { "key": "is_active", "value": true, "type": "text", "description": "Agent aktiv schalten" }, { "key": "max_turns", "value": 10, "type": "text", "description": "Max. Gespraechsrunden" }, { "key": "temperature", "value": 0.7, "type": "text", "description": "LLM-Temperatur (0.0-2.0)" }, { "key": "knowledge_workspace_ids", "value": "", "type": "text", "description": "Workspace-IDs fuer RAG-Zugriff" }, { "key": "tools", "value": "", "type": "text", "description": "Agent-Tools (MCP-Tool-IDs)" }, { "key": "sub_agents", "value": "", "type": "text", "description": "Sub-Agent-UUIDs fuer Delegation" }, { "key": "escalation_config", "value": "", "type": "text", "description": "Eskalations-Konfiguration (an Mensch, Helpdesk, etc.)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/agents_v2/create", "host": [ "{{base_url}}" ], "path": [ "agents_v2", "create" ] }, "description": "Create or Update AI Agent Attach AI agent configuration to a document. Use case: - Custom extraction fields beyond standard IDP\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des Agents (nur bei Update)" }, { "key": "name", "value": "", "type": "text", "description": "Name des Agents (Pflicht bei Neuerstellung)" }, { "key": "system_prompt", "value": "", "type": "text", "description": "System-Prompt des Agents (Pflicht bei Neuerstellung)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Agents" }, { "key": "llm_tier", "value": "basic", "type": "text", "description": "LLM-Qualitaetsstufe" }, { "key": "channels", "value": "", "type": "text", "description": "Kommunikationskanaele (chat, phone, email, widget)" }, { "key": "voice_id", "value": "", "type": "text", "description": "Voice-ID fuer Telefonie-Kanal" }, { "key": "language", "value": "de", "type": "text", "description": "Sprache des Agents (ISO-Code)" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie des Agents" }, { "key": "tags", "value": "", "type": "text", "description": "Tags fuer Suche und Filterung" }, { "key": "is_active", "value": true, "type": "text", "description": "Agent aktiv schalten" }, { "key": "max_turns", "value": 10, "type": "text", "description": "Max. Gespraechsrunden" }, { "key": "temperature", "value": 0.7, "type": "text", "description": "LLM-Temperatur (0.0-2.0)" }, { "key": "knowledge_workspace_ids", "value": "", "type": "text", "description": "Workspace-IDs fuer RAG-Zugriff" }, { "key": "tools", "value": "", "type": "text", "description": "Agent-Tools (MCP-Tool-IDs)" }, { "key": "sub_agents", "value": "", "type": "text", "description": "Sub-Agent-UUIDs fuer Delegation" }, { "key": "escalation_config", "value": "", "type": "text", "description": "Eskalations-Konfiguration (an Mensch, Helpdesk, etc.)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"agent_id\": \"string\",\n \"status\": \"string\"\n }\n },\n \"job_type\": \"poai-job_xxx\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Agent delete", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete AI Agent Remove agent configuration from a document.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu loeschenden Agents (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete AI Agent Remove agent configuration from a document.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu loeschenden Agents (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"deleted\": true\n }\n }\n}" } ] }, { "name": "Agent get", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get AI Agent Retrieve agent configuration and extracted data.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des abzurufenden Agents (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get AI Agent Retrieve agent configuration and extracted data.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des abzurufenden Agents (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"agent_id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"status\": \"string\",\n \"config\": {}\n }\n },\n \"job_type\": \"poai-job_xxx\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Agents list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List All AI Agents Get all AI agents for the authenticated account.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "locale", "value": "", "type": "text", "description": "Response language: de_DE, en_US, es_ES, fr_FR, it_IT, pt_PT" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List All AI Agents Get all AI agents for the authenticated account.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "locale", "value": "", "type": "text", "description": "Response language: de_DE, en_US, es_ES, fr_FR, it_IT, pt_PT" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"agents\": [\n {}\n ],\n \"total\": 0\n }\n },\n \"jobs\": \"poai-job_xxx\",\n \"templates\": \"string\"\n}" } ] }, { "name": "Meeting prep", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Meeting Prep Generate AI briefing for upcoming meeting.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Event-ID fuer die Meeting-Vorbereitung erstellt werden soll (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Meeting Prep Generate AI briefing for upcoming meeting.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Event-ID fuer die Meeting-Vorbereitung erstellt werden soll (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"preparation\": \"string\",\n \"key_documents\": [\n {}\n ],\n \"action_items\": [\n \"string\"\n ]\n }\n },\n \"job_type\": \"poai-job_xxx\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Noshow risk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI No-Show Risk Predict no-show probability for a meeting.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Event-ID fuer Risikobewertung" }, { "key": "guest_email", "value": "", "type": "text", "description": "E-Mail des Gastes fuer historische Analyse" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI No-Show Risk Predict no-show probability for a meeting.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Event-ID fuer Risikobewertung" }, { "key": "guest_email", "value": "", "type": "text", "description": "E-Mail des Gastes fuer historische Analyse" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"risk_score\": 0,\n \"risk_factors\": [\n \"string\"\n ],\n \"recommendation\": \"string\"\n }\n },\n \"job_type\": \"poai-job_xxx\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Smart slots", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Smart Slots Get AI-optimized slot suggestions based on your patterns.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "guest_email", "value": "", "type": "text", "description": "E-Mail des Gastes fuer personalisierte Vorschlaege" }, { "key": "meeting_type_id", "value": "", "type": "text", "description": "Meeting-Typ-ID fuer Dauer und Puffer-Berechnung" }, { "key": "preferred_times", "value": "", "type": "text", "description": "Bevorzugte Zeiten des Gastes (z.B. morgens, nachmittags)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "AI Smart Slots Get AI-optimized slot suggestions based on your patterns.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "guest_email", "value": "", "type": "text", "description": "E-Mail des Gastes fuer personalisierte Vorschlaege" }, { "key": "meeting_type_id", "value": "", "type": "text", "description": "Meeting-Typ-ID fuer Dauer und Puffer-Berechnung" }, { "key": "preferred_times", "value": "", "type": "text", "description": "Bevorzugte Zeiten des Gastes (z.B. morgens, nachmittags)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"suggested_slots\": [\n {}\n ],\n \"optimal_time\": \"string\"\n }\n },\n \"job_type\": \"poai-job_xxx\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] } ] }, { "name": "🌤️ Weather", "item": [ { "name": "By city", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather by City Get current weather and 7-day forecast for any city worldwide. --- When to Use - Display weather for a specific city - Travel planning - Weather widgets --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | city | string | ✅...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "city", "value": "", "type": "text", "description": "City name (e.g. Berlin, Munich, New York)" }, { "key": "locale", "value": "", "type": "text", "description": "Language for weather descriptions" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather by City Get current weather and 7-day forecast for any city worldwide. --- When to Use - Display weather for a specific city - Travel planning - Weather widgets --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | city | string | ✅...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "city", "value": "", "type": "text", "description": "City name (e.g. Berlin, Munich, New York)" }, { "key": "locale", "value": "", "type": "text", "description": "Language for weather descriptions" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"temperature\": 0,\n \"humidity\": 0,\n \"description\": \"string\",\n \"wind_speed\": 0,\n \"icon\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "By coordinates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather by Coordinates Get weather for specific coordinates. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | lat | float | Yes | Latitude | | lon | float | Yes | Longitude | Response: Current weather conditions\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "lat", "value": "", "type": "text", "description": "Latitude (e.g. 52.52 for Berlin)" }, { "key": "lon", "value": "", "type": "text", "description": "Longitude (e.g. 13.405 for Berlin)" }, { "key": "lang", "value": "", "type": "text", "description": "Response language (e.g. de, en)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather by Coordinates Get weather for specific coordinates. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | lat | float | Yes | Latitude | | lon | float | Yes | Longitude | Response: Current weather conditions\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "lat", "value": "", "type": "text", "description": "Latitude (e.g. 52.52 for Berlin)" }, { "key": "lon", "value": "", "type": "text", "description": "Longitude (e.g. 13.405 for Berlin)" }, { "key": "lang", "value": "", "type": "text", "description": "Response language (e.g. de, en)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"temperature\": 0,\n \"humidity\": 0,\n \"description\": \"string\",\n \"wind_speed\": 0,\n \"icon\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "By ip", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather by IP Get weather for IP-based location. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | ip | string | No | IP address default: caller's IP | Response: Current weather conditions\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "locale", "value": "", "type": "text", "description": "Query parameter: locale" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather by IP Get weather for IP-based location. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | ip | string | No | IP address default: caller's IP | Response: Current weather conditions\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "locale", "value": "", "type": "text", "description": "Query parameter: locale" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"temperature\": 0,\n \"humidity\": 0,\n \"description\": \"string\",\n \"wind_speed\": 0,\n \"icon\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Weather icons", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather Icons Get weather icon URLs. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | icon_code | string | Yes | Weather icon code | Response: Icon URL\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "condition_code", "value": "", "type": "text", "description": "Query parameter: condition_code" }, { "key": "size", "value": "", "type": "text", "description": "Query parameter: size" }, { "key": "is_day", "value": "", "type": "text", "description": "Query parameter: is_day" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Weather Icons Get weather icon URLs. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | icon_code | string | Yes | Weather icon code | Response: Icon URL\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "condition_code", "value": "", "type": "text", "description": "Query parameter: condition_code" }, { "key": "size", "value": "", "type": "text", "description": "Query parameter: size" }, { "key": "is_day", "value": "", "type": "text", "description": "Query parameter: is_day" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"icons\": {},\n \"processing_time\": \"string\"\n}" } ] } ] }, { "name": "📍 Geocoding", "item": [ { "name": "Forward geocoding", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert Address to Coordinates Translate any address worldwide into GPS coordinates latitude/longitude. Parameters form-data | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | address | string | ✅ | Full or partial address in any language/script | | la...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "address", "value": "東京都渋谷区", "type": "text", "description": "Full or partial address in any language/script" }, { "key": "lang", "value": "ja", "type": "text", "description": "Response language de, en, ja, ru, ar, zh, etc." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert Address to Coordinates Translate any address worldwide into GPS coordinates latitude/longitude. Parameters form-data | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | address | string | ✅ | Full or partial address in any language/script | | la...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "address", "value": "東京都渋谷区", "type": "text", "description": "Full or partial address in any language/script" }, { "key": "lang", "value": "ja", "type": "text", "description": "Response language de, en, ja, ru, ar, zh, etc." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"formatted_address\": \"string\",\n \"components\": {},\n \"status\": \"success\"\n}" } ] }, { "name": "Geocoding autocomplete", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Address Autocomplete Suggestions Get address suggestions as user types. Fast response times for real-time autocomplete. Parameters form-data | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | q | string | ✅ | Partial address/search term | | lang | stri...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "q", "value": "Москва", "type": "text", "description": "Partial address/search term" }, { "key": "lang", "value": "ru", "type": "text", "description": "Response language default: de" }, { "key": "limit", "value": "5", "type": "text", "description": "Max results 1-20 default: 10" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Address Autocomplete Suggestions Get address suggestions as user types. Fast response times for real-time autocomplete. Parameters form-data | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | q | string | ✅ | Partial address/search term | | lang | stri...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "q", "value": "Москва", "type": "text", "description": "Partial address/search term" }, { "key": "lang", "value": "ru", "type": "text", "description": "Response language default: de" }, { "key": "limit", "value": "5", "type": "text", "description": "Max results 1-20 default: 10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"query\": \"string\",\n \"results\": [\n {\n \"lat\": 0,\n \"lng\": 0,\n \"name\": \"Beispiel\",\n \"street\": \"string\",\n \"housenumber\": \"string\",\n \"postcode\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"source\": \"photon\",\n \"cached\": true,\n \"_billing\": {},\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Reverse geocoding", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert Coordinates to Address Translate GPS coordinates latitude/longitude into a human-readable address. Parameters form-data | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | lat | float | ✅ | Latitude -90 to 90 | | lng | float | ✅ | Longitude -1...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "lat", "value": 35.6762, "type": "text", "description": "Latitude -90 to 90" }, { "key": "lng", "value": 139.6503, "type": "text", "description": "Longitude -180 to 180" }, { "key": "lang", "value": "en", "type": "text", "description": "Response language default: de" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert Coordinates to Address Translate GPS coordinates latitude/longitude into a human-readable address. Parameters form-data | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | lat | float | ✅ | Latitude -90 to 90 | | lng | float | ✅ | Longitude -1...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "lat", "value": 35.6762, "type": "text", "description": "Latitude -90 to 90" }, { "key": "lng", "value": 139.6503, "type": "text", "description": "Longitude -180 to 180" }, { "key": "lang", "value": "en", "type": "text", "description": "Response language default: de" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"formatted_address\": \"string\",\n \"components\": {},\n \"status\": \"success\"\n}" } ] }, { "name": "Service status", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/geocoding/status", "host": [ "{{base_url}}" ], "path": [ "geocoding", "status" ] }, "description": "Service Health Check Public Check if geocoding service is available. No authentication required. Response json { \"success\": true, \"status\": \"operational\", \"endpoints\": { \"forward\": \"/geocoding/forward\", \"reverse\": \"/geocoding/reverse\", \"autocomplete\": \"/geocoding/autocomplete\", \"batch\": \"/geocodi...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/geocoding/status", "host": [ "{{base_url}}" ], "path": [ "geocoding", "status" ] }, "description": "Service Health Check Public Check if geocoding service is available. No authentication required. Response json { \"success\": true, \"status\": \"operational\", \"endpoints\": { \"forward\": \"/geocoding/forward\", \"reverse\": \"/geocoding/reverse\", \"autocomplete\": \"/geocoding/autocomplete\", \"batch\": \"/geocodi...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"available\": true,\n \"success\": true,\n \"endpoints\": {\n \"forward\": \"string\",\n \"reverse\": \"string\",\n \"autocomplete\": \"string\",\n \"batch\": \"string\"\n },\n \"pricing\": {\n \"credits_per_request\": 0,\n \"credits_per_batch_item\": 0,\n \"batch_max_items\": 0\n },\n \"cache\": {\n \"enabled\": true,\n \"ttl\": \"string\"\n },\n \"supported_languages\": [\n \"string\"\n ]\n}" } ] } ] }, { "name": "🗺️ Maps", "item": [ { "name": "Ip address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate a static map from an IP address. Combines IP2Location + Static Map Returns: - Map image or JSON with location data - City, region, country info Perfect for: - Security emails - Login location display\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "IP address to locate" }, { "key": "zoom", "value": "", "type": "text", "description": "Zoom level" }, { "key": "width", "value": "", "type": "text", "description": "Image width" }, { "key": "height", "value": "", "type": "text", "description": "Image height" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate a static map from an IP address. Combines IP2Location + Static Map Returns: - Map image or JSON with location data - City, region, country info Perfect for: - Security emails - Login location display\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "IP address to locate" }, { "key": "zoom", "value": "", "type": "text", "description": "Zoom level" }, { "key": "width", "value": "", "type": "text", "description": "Image width" }, { "key": "height", "value": "", "type": "text", "description": "Image height" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"content_type\": \"string\",\n \"image_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"status\": \"success\"\n}" } ] }, { "name": "Map coordinates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate a static map image from coordinates. Returns: PNG image or JSON Parameters: - lat/lon - Coordinates - zoom - 1-16 default: 12 - width/height - Image size - marker - Show red marker 0/1 - format - image, json, base64 Use Cases: - Embed maps in emails - Location previews\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "lat", "value": "", "type": "text", "description": "Latitude" }, { "key": "lon", "value": "", "type": "text", "description": "Longitude" }, { "key": "zoom", "value": "", "type": "text", "description": "Zoom level (1-16)" }, { "key": "width", "value": "", "type": "text", "description": "Image width (100-800)" }, { "key": "height", "value": "", "type": "text", "description": "Image height (50-600)" }, { "key": "marker", "value": "", "type": "text", "description": "Show marker (0/1)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate a static map image from coordinates. Returns: PNG image or JSON Parameters: - lat/lon - Coordinates - zoom - 1-16 default: 12 - width/height - Image size - marker - Show red marker 0/1 - format - image, json, base64 Use Cases: - Embed maps in emails - Location previews\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "lat", "value": "", "type": "text", "description": "Latitude" }, { "key": "lon", "value": "", "type": "text", "description": "Longitude" }, { "key": "zoom", "value": "", "type": "text", "description": "Zoom level (1-16)" }, { "key": "width", "value": "", "type": "text", "description": "Image width (100-800)" }, { "key": "height", "value": "", "type": "text", "description": "Image height (50-600)" }, { "key": "marker", "value": "", "type": "text", "description": "Show marker (0/1)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"content_type\": \"string\",\n \"image_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"status\": \"success\"\n}" } ] }, { "name": "Map tile", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/maptiles/tiles/get/{z}/{x}/{y}.pbf", "host": [ "{{base_url}}" ], "path": [ "maptiles", "tiles", "get", "{z}", "{x}", "{y}.pbf" ] }, "description": "Get a vector map tile. Path parameters: - {z} - Zoom level 0-14, higher = more detail - {x} - Tile X coordinate - {y} - Tile Y coordinate Returns: Mapbox Vector Tile .pbf Example: Zoom 14, Berlin area → /tiles/14/8529/5458.pbf\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/maptiles/tiles/get/{z}/{x}/{y}.pbf", "host": [ "{{base_url}}" ], "path": [ "maptiles", "tiles", "get", "{z}", "{x}", "{y}.pbf" ] }, "description": "Get a vector map tile. Path parameters: - {z} - Zoom level 0-14, higher = more detail - {x} - Tile X coordinate - {y} - Tile Y coordinate Returns: Mapbox Vector Tile .pbf Example: Zoom 14, Berlin area → /tiles/14/8529/5458.pbf\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"content_type\": \"string\",\n \"body\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Style json", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/maptiles/style.json", "host": [ "{{base_url}}" ], "path": [ "maptiles", "style.json" ] }, "description": "Get MapLibre/Mapbox style configuration. Returns: JSON style definition for MapLibre GL JS Use this URL directly in your MapLibre map initialization.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/maptiles/style.json", "host": [ "{{base_url}}" ], "path": [ "maptiles", "style.json" ] }, "description": "Get MapLibre/Mapbox style configuration. Returns: JSON style definition for MapLibre GL JS Use this URL directly in your MapLibre map initialization.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"version\": 0,\n \"name\": \"Beispiel\",\n \"sources\": {},\n \"layers\": [\n {\n \"id\": \"poai-job_xxx\",\n \"type\": \"background\",\n \"source\": \"string\",\n \"source-layer\": \"string\"\n }\n ],\n \"glyphs\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"sprite\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "🧾 Invoice Processing", "item": [ { "name": "Bank check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bank Check Extract data from bank checks. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | string | Yes | ban...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "bank_check", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bank Check Extract data from bank checks. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | string | Yes | ban...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "bank_check", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"check_number\": \"string\",\n \"amount\": 0,\n \"date\": \"string\",\n \"payee\": \"string\",\n \"bank_name\": \"string\",\n \"routing_number\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Bank details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bank Details Extract banking information from documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | str...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "basic", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "bank_details", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bank Details Extract banking information from documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | str...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "basic", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "bank_details", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"bank_name\": \"string\",\n \"iban\": \"string\",\n \"bic\": \"string\",\n \"account_holder\": \"string\",\n \"account_number\": \"string\",\n \"bank_code\": \"string\"\n },\n \"text\": \"string\",\n \"suggested_fields\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Basic fields", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Invoice Light Basic Fields Extract basic invoice data minimal fields. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_col...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "basic", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "idp_light", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Invoice Light Basic Fields Extract basic invoice data minimal fields. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_col...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "basic", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "idp_light", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {\n \"vendor_name\": \"Beispiel\",\n \"vendor_address\": \"string\",\n \"vendor_vat_id\": \"poai-job_xxx\",\n \"vendor_tax_number\": \"string\",\n \"vendor_iban\": \"string\",\n \"vendor_bic\": \"string\",\n \"customer_name\": \"Beispiel\",\n \"customer_address\": \"string\",\n \"invoice_number\": \"string\",\n \"invoice_date\": \"2026-02-07T12:00:00Z\",\n \"due_date\": \"2026-02-07T12:00:00Z\",\n \"delivery_date\": \"2026-02-07T12:00:00Z\",\n \"order_number\": \"string\",\n \"currency\": \"string\",\n \"net_amount\": 0,\n \"tax_rate\": 0,\n \"tax_amount\": 0,\n \"gross_amount\": 0,\n \"payment_terms\": \"string\"\n },\n \"suggested_fields\": [\n {\n \"field_name\": \"string\",\n \"value\": \"string\",\n \"confidence\": 0,\n \"source_box_ids\": [\n null\n ]\n }\n ],\n \"pages_images\": {}\n }\n }\n}" } ] }, { "name": "Cash receipt", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Cash Receipt Extract data from retail receipts and cash transactions. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_col...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "cash_receipt", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Cash Receipt Extract data from retail receipts and cash transactions. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_col...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "cash_receipt", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"merchant_name\": \"string\",\n \"merchant_address\": \"string\",\n \"receipt_date\": \"string\",\n \"receipt_time\": \"string\",\n \"total_amount\": 0,\n \"payment_method\": \"string\",\n \"tax_amount\": 0\n },\n \"text\": \"string\",\n \"suggested_fields\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Datev skr03", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "DATEV SKR03 Export Extrahiert Buchhaltungsdaten im DATEV-Format. Felder: Belegdatum, Belegnummer, Buchungstext, Soll-/Habenkonto, Betrag, Steuersatz Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes | | idp_collection | string | Yes |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "accounting_datev", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "DATEV SKR03 Export Extrahiert Buchhaltungsdaten im DATEV-Format. Felder: Belegdatum, Belegnummer, Buchungstext, Soll-/Habenkonto, Betrag, Steuersatz Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes | | idp_collection | string | Yes |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "accounting_datev", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"account_number\": \"string\",\n \"contra_account\": \"string\",\n \"amount\": 0,\n \"tax_key\": \"string\",\n \"booking_text\": \"string\",\n \"document_date\": \"string\",\n \"cost_center\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Finance invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Invoice Extraction Extract data from invoice documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | stri...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "invoice", "type": "text", "description": "IDP template name. Default: invoice (English). For localized versions use the dedicated tools (e.g. po_extraction_invoice_germandeutsch for German/DATEV). Advanced: append :lang:LOCALE for custom localization e.g. invoice:fr:FR" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Additional fields as JSON, e.g., {\"key\":\"has_stamp\",\"description\":\"Is there a stamp?\"}" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Invoice Extraction Extract data from invoice documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | stri...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "invoice", "type": "text", "description": "IDP template name. Default: invoice (English). For localized versions use the dedicated tools (e.g. po_extraction_invoice_germandeutsch for German/DATEV). Advanced: append :lang:LOCALE for custom localization e.g. invoice:fr:FR" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Additional fields as JSON, e.g., {\"key\":\"has_stamp\",\"description\":\"Is there a stamp?\"}" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {\n \"vendor_name\": \"Beispiel\",\n \"vendor_address\": \"string\",\n \"vendor_vat_id\": \"poai-job_xxx\",\n \"vendor_tax_number\": \"string\",\n \"vendor_iban\": \"string\",\n \"vendor_bic\": \"string\",\n \"customer_name\": \"Beispiel\",\n \"customer_address\": \"string\",\n \"invoice_number\": \"string\",\n \"invoice_date\": \"2026-02-07T12:00:00Z\",\n \"due_date\": \"2026-02-07T12:00:00Z\",\n \"delivery_date\": \"2026-02-07T12:00:00Z\",\n \"order_number\": \"string\",\n \"currency\": \"string\",\n \"net_amount\": 0,\n \"tax_rate\": 0,\n \"tax_amount\": 0,\n \"gross_amount\": 0,\n \"payment_terms\": \"string\"\n },\n \"suggested_fields\": [\n {\n \"field_name\": \"string\",\n \"value\": \"string\",\n \"confidence\": 0,\n \"source_box_ids\": [\n null\n ]\n }\n ],\n \"pages_images\": {}\n }\n }\n}" } ] }, { "name": "Idp fields", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Custom Field Extraction idp_fields only Extract ONLY the fields you define - no template. Format: json {\"key\": \"field_name\", \"description\": \"What to extract\"}, {\"key\": \"another_field\", \"description\": \"Description\"} Tip: To use a template AND add extra fields, use idp_collection + idp_fields toget...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Document to extract from" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_fields", "value": "[{\"key\":\"company_name\",\"description\":\"Name of the company\"},{\"key\":\"invoice_number\",\"description\":\"Invoice number\"},{\"key\":\"total_amount\",\"description\":\"Total amount with currency\"}]", "type": "text", "description": "Custom extraction fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Custom Field Extraction idp_fields only Extract ONLY the fields you define - no template. Format: json {\"key\": \"field_name\", \"description\": \"What to extract\"}, {\"key\": \"another_field\", \"description\": \"Description\"} Tip: To use a template AND add extra fields, use idp_collection + idp_fields toget...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Document to extract from" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_fields", "value": "[{\"key\":\"company_name\",\"description\":\"Name of the company\"},{\"key\":\"invoice_number\",\"description\":\"Invoice number\"},{\"key\":\"total_amount\",\"description\":\"Total amount with currency\"}]", "type": "text", "description": "Custom extraction fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {},\n \"suggested_fields\": [\n {\n \"field_name\": \"string\",\n \"value\": \"string\",\n \"confidence\": 0,\n \"source_box_ids\": [\n null\n ]\n }\n ],\n \"pages_images\": {}\n }\n }\n}" } ] }, { "name": "Invoice germandeutsch", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Rechnung Deutsch Optimiert für deutsche Rechnungen mit DATEV-Feldern. Extrahierte Felder: Rechnungsnummer, Datum, Lieferant, Kunde, Netto, Brutto, USt, IBAN, BIC, Skonto Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes | | idp_coll...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Invoice document PDF/Image" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "invoice:de", "type": "text", "description": "invoice:de = German output, invoice:en = English, invoice:es = Spanish" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Additional fields as JSON" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Rechnung Deutsch Optimiert für deutsche Rechnungen mit DATEV-Feldern. Extrahierte Felder: Rechnungsnummer, Datum, Lieferant, Kunde, Netto, Brutto, USt, IBAN, BIC, Skonto Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes | | idp_coll...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Invoice document PDF/Image" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "invoice:de", "type": "text", "description": "invoice:de = German output, invoice:en = English, invoice:es = Spanish" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Additional fields as JSON" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {\n \"vendor_name\": \"Beispiel\",\n \"vendor_address\": \"string\",\n \"vendor_vat_id\": \"poai-job_xxx\",\n \"vendor_tax_number\": \"string\",\n \"vendor_iban\": \"string\",\n \"vendor_bic\": \"string\",\n \"customer_name\": \"Beispiel\",\n \"customer_address\": \"string\",\n \"invoice_number\": \"string\",\n \"invoice_date\": \"2026-02-07T12:00:00Z\",\n \"due_date\": \"2026-02-07T12:00:00Z\",\n \"delivery_date\": \"2026-02-07T12:00:00Z\",\n \"order_number\": \"string\",\n \"currency\": \"string\",\n \"net_amount\": 0,\n \"tax_rate\": 0,\n \"tax_amount\": 0,\n \"gross_amount\": 0,\n \"payment_terms\": \"string\"\n },\n \"suggested_fields\": [\n {\n \"field_name\": \"string\",\n \"value\": \"string\",\n \"confidence\": 0,\n \"source_box_ids\": [\n null\n ]\n }\n ],\n \"pages_images\": {}\n }\n }\n}" } ] }, { "name": "Of account", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Statement of Account Extract data from account statements. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | s...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "statement_of_account", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Statement of Account Extract data from account statements. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | s...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "statement_of_account", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"account_holder\": \"string\",\n \"account_number\": \"string\",\n \"iban\": \"string\",\n \"statement_date\": \"string\",\n \"opening_balance\": 0,\n \"closing_balance\": 0,\n \"transactions\": [\n {}\n ]\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Utility bill", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Utility Bill Extract data from utility bills electricity, gas, water, internet. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "utility_bill", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Utility Bill Extract data from utility bills electricity, gas, water, internet. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "utility_bill", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"provider_name\": \"string\",\n \"customer_name\": \"string\",\n \"billing_period\": \"string\",\n \"total_amount\": 0,\n \"meter_number\": \"string\",\n \"consumption\": 0,\n \"unit\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "💰 Finance & Payroll", "item": [ { "name": "Pay stub", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Payroll / Pay Stub Extract salary and payroll data. Fields: employee_name, pay_period, gross, net, deductions, taxes, employer\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "payroll", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Payroll / Pay Stub Extract salary and payroll data. Fields: employee_name, pay_period, gross, net, deductions, taxes, employer\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "payroll", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"employee_name\": \"string\",\n \"employer_name\": \"string\",\n \"pay_period\": \"string\",\n \"gross_pay\": 0,\n \"net_pay\": 0,\n \"deductions\": {}\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "✍️ E-Signatures", "item": [ { "name": "Cancel Signature Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/cancel", "host": [ "{{base_url}}" ], "path": [ "signatures", "cancel" ] }, "description": "Bricht eine Signaturanfrage ab\n\n💰 **Kosten**: 990 Credits/request (0.99€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "signature_id", "value": "", "type": "text", "description": "ID der Signaturanfrage" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/cancel", "host": [ "{{base_url}}" ], "path": [ "signatures", "cancel" ] }, "description": "Bricht eine Signaturanfrage ab\n\n💰 **Kosten**: 990 Credits/request (0.99€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "signature_id", "value": "", "type": "text", "description": "ID der Signaturanfrage" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"cancelled\": true,\n \"signature_id\": \"string\"\n }\n }\n}" } ] }, { "name": "Create Signature Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/create", "host": [ "{{base_url}}" ], "path": [ "signatures", "create" ] }, "description": "Erstellt eine neue Signaturanfrage für ein Dokument\n\n💰 **Kosten**: 990 Credits/request (0.99€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "ID des zu signierenden Dokuments" }, { "key": "signers", "value": "", "type": "text", "description": "JSON Array der Unterzeichner {email, name, order}" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht an die Unterzeichner" }, { "key": "level", "value": "SES", "type": "text", "description": "Signatur-Level: SES, AES, QES" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/create", "host": [ "{{base_url}}" ], "path": [ "signatures", "create" ] }, "description": "Erstellt eine neue Signaturanfrage für ein Dokument\n\n💰 **Kosten**: 990 Credits/request (0.99€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "ID des zu signierenden Dokuments" }, { "key": "signers", "value": "", "type": "text", "description": "JSON Array der Unterzeichner {email, name, order}" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht an die Unterzeichner" }, { "key": "level", "value": "SES", "type": "text", "description": "Signatur-Level: SES, AES, QES" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"signature_id\": \"string\",\n \"signing_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"status\": \"pending\",\n \"signers\": [\n {}\n ],\n \"created_at\": \"string\",\n \"expires_at\": \"string\"\n }\n }\n}" } ] }, { "name": "Download eSignature Document", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/download", "host": [ "{{base_url}}" ], "path": [ "signatures", "download" ] }, "description": "Lädt das signierte Dokument herunter\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/download", "host": [ "{{base_url}}" ], "path": [ "signatures", "download" ] }, "description": "Lädt das signierte Dokument herunter\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Send reminder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/remind", "host": [ "{{base_url}}" ], "path": [ "signatures", "remind" ] }, "description": "Sendet eine Erinnerung an ausstehende Unterzeichner\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "signature_id", "value": "", "type": "text", "description": "ID der Signaturanfrage" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/remind", "host": [ "{{base_url}}" ], "path": [ "signatures", "remind" ] }, "description": "Sendet eine Erinnerung an ausstehende Unterzeichner\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "signature_id", "value": "", "type": "text", "description": "ID der Signaturanfrage" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"sent\": true,\n \"signature_id\": \"string\"\n }\n }\n}" } ] }, { "name": "Signature details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/get", "host": [ "{{base_url}}" ], "path": [ "signatures", "get" ] }, "description": "Details einer Signaturanfrage\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/get", "host": [ "{{base_url}}" ], "path": [ "signatures", "get" ] }, "description": "Details einer Signaturanfrage\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"signature_id\": \"string\",\n \"status\": \"string\",\n \"document_pofid\": \"string\",\n \"signers\": [\n {}\n ],\n \"audit_trail\": [\n {}\n ]\n }\n }\n}" } ] }, { "name": "Signature requests", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/list", "host": [ "{{base_url}}" ], "path": [ "signatures", "list" ] }, "description": "Listet alle Signaturanfragen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signatures/list", "host": [ "{{base_url}}" ], "path": [ "signatures", "list" ] }, "description": "Listet alle Signaturanfragen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"signatures\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "🔗 Signature Links", "item": [ { "name": "Cancel Signing Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/cancel_signing_request", "host": [ "{{base_url}}" ], "path": [ "signature_link", "cancel_signing_request" ] }, "description": "Cancel Signing Request Cancel a pending signing request. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | --- Response json { \"success\": true }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "request_id", "value": "", "type": "text", "description": "ID des zu stornierenden Signatur-Requests (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Stornierungsgrund" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/cancel_signing_request", "host": [ "{{base_url}}" ], "path": [ "signature_link", "cancel_signing_request" ] }, "description": "Cancel Signing Request Cancel a pending signing request. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | --- Response json { \"success\": true }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "request_id", "value": "", "type": "text", "description": "ID des zu stornierenden Signatur-Requests (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Stornierungsgrund" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"cancelled\": true\n }\n }\n}" } ] }, { "name": "Document signatures", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/get_document_signatures", "host": [ "{{base_url}}" ], "path": [ "signature_link", "get_document_signatures" ] }, "description": "Get Document Signatures List all signatures on a document. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | document_id | string | ✅ | Document ID | --- Response json { \"success\": true, \"signatures\": { \"signer\": \"John Doe\", \"signed_at\"...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/get_document_signatures", "host": [ "{{base_url}}" ], "path": [ "signature_link", "get_document_signatures" ] }, "description": "Get Document Signatures List all signatures on a document. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | document_id | string | ✅ | Document ID | --- Response json { \"success\": true, \"signatures\": { \"signer\": \"John Doe\", \"signed_at\"...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"signatures\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Download Signing Link Document", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/download_signed_document", "host": [ "{{base_url}}" ], "path": [ "signature_link", "download_signed_document" ] }, "description": "Download Signed Document Download the completed signed document. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | --- Response Returns the signed PDF document.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/download_signed_document", "host": [ "{{base_url}}" ], "path": [ "signature_link", "download_signed_document" ] }, "description": "Download Signed Document Download the completed signed document. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | --- Response Returns the signed PDF document.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Resend invitation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/resend_invitation", "host": [ "{{base_url}}" ], "path": [ "signature_link", "resend_invitation" ] }, "description": "Resend Invitation Resend signing invitation to a signer. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | | signer_email | string | ✅ | Signer's email | --- Response json { \"success\": tr...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "signer_id", "value": "", "type": "text", "description": "ID des Unterzeichners fuer erneuten Versand (required)" }, { "key": "channel", "value": "email", "type": "text", "description": "Zustellkanal" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/resend_invitation", "host": [ "{{base_url}}" ], "path": [ "signature_link", "resend_invitation" ] }, "description": "Resend Invitation Resend signing invitation to a signer. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | | signer_email | string | ✅ | Signer's email | --- Response json { \"success\": tr...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "signer_id", "value": "", "type": "text", "description": "ID des Unterzeichners fuer erneuten Versand (required)" }, { "key": "channel", "value": "email", "type": "text", "description": "Zustellkanal" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"sent\": true\n }\n }\n}" } ] }, { "name": "Send Signing Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/send_signing_request", "host": [ "{{base_url}}" ], "path": [ "signature_link", "send_signing_request" ] }, "description": "Send Signing Request Send a document for signature via email. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | document_id | string | ✅ | Document to sign | | signers | array | ✅ | List of signers | | message | string | ❌ | Custom ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "request_id", "value": "", "type": "text", "description": "ID des Signatur-Requests (required)" }, { "key": "signers", "value": "", "type": "text", "description": "Array von Unterzeichner-Objekten mit name und email" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht an die Unterzeichner" }, { "key": "channel", "value": "email", "type": "text", "description": "Zustellkanal" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/send_signing_request", "host": [ "{{base_url}}" ], "path": [ "signature_link", "send_signing_request" ] }, "description": "Send Signing Request Send a document for signature via email. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | document_id | string | ✅ | Document to sign | | signers | array | ✅ | List of signers | | message | string | ❌ | Custom ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "request_id", "value": "", "type": "text", "description": "ID des Signatur-Requests (required)" }, { "key": "signers", "value": "", "type": "text", "description": "Array von Unterzeichner-Objekten mit name und email" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht an die Unterzeichner" }, { "key": "channel", "value": "email", "type": "text", "description": "Zustellkanal" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"request_id\": \"string\",\n \"signing_url\": \"string\",\n \"status\": \"string\"\n }\n }\n}" } ] }, { "name": "Sign document", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/sign", "host": [ "{{base_url}}" ], "path": [ "signature_link", "sign" ] }, "description": "Sign Document Submit signature for a document. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | | signature_data | string | ✅ | Base64 signature image | --- Response json { \"success\": tr...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "verified_token", "value": "", "type": "text", "description": "Verifizierungstoken nach OTP-Pruefung" }, { "key": "signature", "value": "", "type": "text", "description": "Signatur-Daten (Base64 PNG bei draw, Text bei type) (required)" }, { "key": "signature_type", "value": "draw", "type": "text", "description": "Typ der Signatur" }, { "key": "signer_name", "value": "", "type": "text", "description": "Name des Unterzeichners (fuer Textfeld-Signatur)" }, { "key": "client_data", "value": "", "type": "text", "description": "Zusaetzliche Client-Daten (IP, Timestamp, User-Agent)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/sign", "host": [ "{{base_url}}" ], "path": [ "signature_link", "sign" ] }, "description": "Sign Document Submit signature for a document. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | | signature_data | string | ✅ | Base64 signature image | --- Response json { \"success\": tr...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "verified_token", "value": "", "type": "text", "description": "Verifizierungstoken nach OTP-Pruefung" }, { "key": "signature", "value": "", "type": "text", "description": "Signatur-Daten (Base64 PNG bei draw, Text bei type) (required)" }, { "key": "signature_type", "value": "draw", "type": "text", "description": "Typ der Signatur" }, { "key": "signer_name", "value": "", "type": "text", "description": "Name des Unterzeichners (fuer Textfeld-Signatur)" }, { "key": "client_data", "value": "", "type": "text", "description": "Zusaetzliche Client-Daten (IP, Timestamp, User-Agent)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"signed\": true,\n \"signed_pofid\": \"string\"\n }\n }\n}" } ] }, { "name": "Signing status", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/get_signing_status", "host": [ "{{base_url}}" ], "path": [ "signature_link", "get_signing_status" ] }, "description": "Check Signing Status Get current status of a signing request. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | --- Response json { \"success\": true, \"status\": \"completed\", \"signed_at\": \"202...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/get_signing_status", "host": [ "{{base_url}}" ], "path": [ "signature_link", "get_signing_status" ] }, "description": "Check Signing Status Get current status of a signing request. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | --- Response json { \"success\": true, \"status\": \"completed\", \"signed_at\": \"202...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"request_id\": \"string\",\n \"status\": \"pending\",\n \"signed_at\": \"string\"\n }\n }\n}" } ] }, { "name": "Verify otp", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/verify_otp", "host": [ "{{base_url}}" ], "path": [ "signature_link", "verify_otp" ] }, "description": "Verify OTP Verify one-time password for signing. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | | otp | string | ✅ | OTP code | --- Response json { \"success\": true, \"verified\": true }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "otp", "value": "", "type": "text", "description": "Einmalpasswort zur Identitaetsbestaetigung (6-stellig) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/signature_link/verify_otp", "host": [ "{{base_url}}" ], "path": [ "signature_link", "verify_otp" ] }, "description": "Verify OTP Verify one-time password for signing. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | signing_id | string | ✅ | Signing request ID | | otp | string | ✅ | OTP code | --- Response json { \"success\": true, \"verified\": true }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "otp", "value": "", "type": "text", "description": "Einmalpasswort zur Identitaetsbestaetigung (6-stellig) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"verified\": true\n }\n }\n}" } ] } ] }, { "name": "⚙️ Workflow Templates", "item": [ { "name": "Create template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Workflow Template Create a new workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | name | string | ✅ | Template name | | description | string | ❌ | Template description | | steps | array | ❌ | Workflow steps ...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Neuer Workflow", "type": "text", "description": "Name des Workflow-Templates" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Workflows" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie zur Gruppierung" }, { "key": "nodes", "value": "", "type": "text", "description": "Workflow-Nodes (Schritte) als Array" }, { "key": "connections", "value": "", "type": "text", "description": "Verbindungen zwischen Nodes" }, { "key": "trigger_type", "value": "manual", "type": "text", "description": "Ausloese-Typ" }, { "key": "trigger_config", "value": "", "type": "text", "description": "Trigger-Konfiguration" }, { "key": "is_active", "value": false, "type": "text", "description": "Workflow sofort aktiv schalten" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Workflow Template Create a new workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | name | string | ✅ | Template name | | description | string | ❌ | Template description | | steps | array | ❌ | Workflow steps ...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Neuer Workflow", "type": "text", "description": "Name des Workflow-Templates" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Workflows" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie zur Gruppierung" }, { "key": "nodes", "value": "", "type": "text", "description": "Workflow-Nodes (Schritte) als Array" }, { "key": "connections", "value": "", "type": "text", "description": "Verbindungen zwischen Nodes" }, { "key": "trigger_type", "value": "manual", "type": "text", "description": "Ausloese-Typ" }, { "key": "trigger_config", "value": "", "type": "text", "description": "Trigger-Konfiguration" }, { "key": "is_active", "value": false, "type": "text", "description": "Workflow sofort aktiv schalten" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"created_at\": \"string\",\n \"version\": 0\n }\n }\n}" } ] }, { "name": "Delete template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete Workflow Template Delete a workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to delete | --- Response json { \"success\": true }\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu loeschenden Templates (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete Workflow Template Delete a workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to delete | --- Response json { \"success\": true }\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu loeschenden Templates (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"deleted\": true,\n \"uuid\": \"string\"\n }\n }\n}" } ] }, { "name": "Deploy template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Deploy Workflow Template Deploy a template to production. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to deploy | --- Response json { \"success\": true, \"deployed_at\": \"2026-01-15T10:00:00Z\" }\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu deployenden Templates (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Deploy Workflow Template Deploy a template to production. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to deploy | --- Response json { \"success\": true, \"deployed_at\": \"2026-01-15T10:00:00Z\" }\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu deployenden Templates (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"uuid\": \"string\",\n \"deployed_version\": 0,\n \"subscription_result\": {}\n }\n }\n}" } ] }, { "name": "Duplicate template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Duplicate Workflow Template Create a copy of an existing template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to duplicate | | new_name | string | ❌ | Name for the copy | --- Response json { ...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu duplizierenden Templates (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Duplicate Workflow Template Create a copy of an existing template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to duplicate | | new_name | string | ❌ | Name for the copy | --- Response json { ...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu duplizierenden Templates (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"uuid\": \"poai-job_xxx\",\n \"name\": \"string\",\n \"source_uuid\": \"string\"\n }\n }\n}" } ] }, { "name": "Execute template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Execute Workflow Template Run a workflow template with input data. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to execute | | input | object | ✅ | Input data for workflow | --- Response json {...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des auszufuehrenden Templates (required)" }, { "key": "input_data", "value": "", "type": "text", "description": "Eingabedaten fuer die Workflow-Ausfuehrung" }, { "key": "file", "value": "", "type": "text", "description": "Datei-Referenz (z.B. pofid) fuer den Workflow" }, { "key": "priority", "value": 800, "type": "text", "description": "Ausfuehrungs-Prioritaet" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Execute Workflow Template Run a workflow template with input data. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to execute | | input | object | ✅ | Input data for workflow | --- Response json {...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des auszufuehrenden Templates (required)" }, { "key": "input_data", "value": "", "type": "text", "description": "Eingabedaten fuer die Workflow-Ausfuehrung" }, { "key": "file", "value": "", "type": "text", "description": "Datei-Referenz (z.B. pofid) fuer den Workflow" }, { "key": "priority", "value": 800, "type": "text", "description": "Ausfuehrungs-Prioritaet" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"workflow_id\": \"string\",\n \"status\": \"completed\",\n \"steps\": [\n {\n \"node_id\": \"string\",\n \"status\": \"string\",\n \"duration_ms\": 0,\n \"output\": {}\n }\n ],\n \"total_duration_ms\": 0\n }\n }\n}" } ] }, { "name": "Get analytics", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Workflow Analytics Get execution statistics for a workflow. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template ID | | period | string | ❌ | 7d, 30d, 90d | --- Response json { \"success\": true, \"an...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Query parameter: template_id" }, { "key": "period", "value": "", "type": "text", "description": "7d, 30d, 90d" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Workflow Analytics Get execution statistics for a workflow. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template ID | | period | string | ❌ | 7d, 30d, 90d | --- Response json { \"success\": true, \"an...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Query parameter: template_id" }, { "key": "period", "value": "", "type": "text", "description": "7d, 30d, 90d" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"executions_total\": 0,\n \"executions_success\": 0,\n \"executions_failed\": 0,\n \"avg_duration_ms\": 0,\n \"last_execution\": \"string\"\n }\n }\n}" } ] }, { "name": "Get executions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Workflow Executions List all executions of a workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ❌ | Filter by template | --- Response json { \"success\": true, \"executions\": { \"id\": \"exec_789\",...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Filter by template" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Workflow Executions List all executions of a workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ❌ | Filter by template | --- Response json { \"success\": true, \"executions\": { \"id\": \"exec_789\",...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Filter by template" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"executions\": [\n {\n \"execution_id\": \"string\",\n \"status\": \"string\",\n \"started_at\": \"string\",\n \"duration_ms\": 0,\n \"trigger_info\": {}\n }\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Get template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Workflow Template Retrieve details of a specific workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template ID | --- Response json { \"success\": true, \"template\": { \"id\": \"wf_123\", \"name\"...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Template ID to retrieve" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Workflow Template Retrieve details of a specific workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template ID | --- Response json { \"success\": true, \"template\": { \"id\": \"wf_123\", \"name\"...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Template ID to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"nodes\": [\n \"string\"\n ],\n \"edges\": [\n \"string\"\n ],\n \"trigger_type\": \"string\",\n \"is_active\": true,\n \"version\": 0\n }\n }\n}" } ] }, { "name": "List Workflow Templates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Workflow Templates Retrieve all workflow templates for your account. --- When to Use - Display available workflows in UI - Find templates to execute - Manage workflow library --- Parameters No parameters required. --- Response json { \"success\": true, \"templates\": { \"id\": \"wf_123\", \"name\": \"I...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Workflow Templates Retrieve all workflow templates for your account. --- When to Use - Display available workflows in UI - Find templates to execute - Manage workflow library --- Parameters No parameters required. --- Response json { \"success\": true, \"templates\": { \"id\": \"wf_123\", \"name\": \"I...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"templates\": [\n {\n \"uuid\": \"string\",\n \"name\": \"string\",\n \"trigger_type\": \"string\",\n \"is_active\": true,\n \"version\": 0,\n \"deployed_version\": 0,\n \"created_at\": \"string\"\n }\n ],\n \"total\": 0\n }\n },\n \"templates\": \"string\"\n}" } ] }, { "name": "Update template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Update Workflow Template Update an existing workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to update | | name | string | ❌ | New name | | description | string | ❌ | New descr...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu aktualisierenden Templates (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name" }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung" }, { "key": "category", "value": "", "type": "text", "description": "Neue Kategorie" }, { "key": "trigger_type", "value": "", "type": "text", "description": "Neuer Trigger-Typ" }, { "key": "is_active", "value": "", "type": "text", "description": "Aktiv-Status aendern" }, { "key": "nodes", "value": "", "type": "text", "description": "Aktualisierte Workflow-Nodes" }, { "key": "connections", "value": "", "type": "text", "description": "Aktualisierte Verbindungen" }, { "key": "trigger_config", "value": "", "type": "text", "description": "Aktualisierte Trigger-Konfiguration" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Update Workflow Template Update an existing workflow template. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Template to update | | name | string | ❌ | New name | | description | string | ❌ | New descr...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu aktualisierenden Templates (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name" }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung" }, { "key": "category", "value": "", "type": "text", "description": "Neue Kategorie" }, { "key": "trigger_type", "value": "", "type": "text", "description": "Neuer Trigger-Typ" }, { "key": "is_active", "value": "", "type": "text", "description": "Aktiv-Status aendern" }, { "key": "nodes", "value": "", "type": "text", "description": "Aktualisierte Workflow-Nodes" }, { "key": "connections", "value": "", "type": "text", "description": "Aktualisierte Verbindungen" }, { "key": "trigger_config", "value": "", "type": "text", "description": "Aktualisierte Trigger-Konfiguration" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"uuid\": \"string\",\n \"version\": 0,\n \"updated_at\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "🤖 Workflow AI", "item": [ { "name": "Explain workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Explain Workflow Get a natural language explanation of what a workflow does. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Workflow to explain | --- Response json { \"success\": true, \"explanation\": \"This wo...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow", "value": "", "type": "text", "description": "Workflow-Objekt das erklaert werden soll (required)" }, { "key": "language", "value": "de", "type": "text", "description": "Ausgabesprache" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Explain Workflow Get a natural language explanation of what a workflow does. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Workflow to explain | --- Response json { \"success\": true, \"explanation\": \"This wo...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow", "value": "", "type": "text", "description": "Workflow-Objekt das erklaert werden soll (required)" }, { "key": "language", "value": "de", "type": "text", "description": "Ausgabesprache" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"explanation\": \"string\",\n \"steps_explained\": [\n {}\n ],\n \"complexity_rating\": \"string\"\n }\n }\n}" } ] }, { "name": "Generate workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate Workflow with AI Let AI create a workflow from a natural language description. --- When to Use - Quickly create new workflows - Get AI suggestions for automation - Convert requirements to workflows --- Parameters | Parameter | Type | Required | Description | |-----------|------|---------...\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "", "type": "text", "description": "Beschreibung des gewuenschten Workflows in natuerlicher Sprache (required)" }, { "key": "include_human_tasks", "value": true, "type": "text", "description": "Human-in-the-Loop Steps einbeziehen" }, { "key": "add_error_handling", "value": true, "type": "text", "description": "Automatische Fehlerbehandlung" }, { "key": "model", "value": "ultra", "type": "text", "description": "LLM-Modell fuer Generierung" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate Workflow with AI Let AI create a workflow from a natural language description. --- When to Use - Quickly create new workflows - Get AI suggestions for automation - Convert requirements to workflows --- Parameters | Parameter | Type | Required | Description | |-----------|------|---------...\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "prompt", "value": "", "type": "text", "description": "Beschreibung des gewuenschten Workflows in natuerlicher Sprache (required)" }, { "key": "include_human_tasks", "value": true, "type": "text", "description": "Human-in-the-Loop Steps einbeziehen" }, { "key": "add_error_handling", "value": true, "type": "text", "description": "Automatische Fehlerbehandlung" }, { "key": "model", "value": "ultra", "type": "text", "description": "LLM-Modell fuer Generierung" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"nodes\": [\n {}\n ],\n \"edges\": [\n {}\n ],\n \"name\": \"Beispiel\",\n \"description\": \"string\",\n \"trigger_type\": \"string\"\n }\n }\n}" } ] }, { "name": "Next step", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Suggest Next Step AI suggests what step to add next. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | current_steps | array | ✅ | Existing steps | | goal | string | ❌ | What to achieve | --- Response json { \"success\": true, \"suggesti...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "nodes", "value": "", "type": "text", "description": "Aktuelle Workflow-Nodes" }, { "key": "connections", "value": "", "type": "text", "description": "Aktuelle Verbindungen" }, { "key": "context", "value": "", "type": "text", "description": "Zusaetzlicher Kontext fuer die Vorschlaege" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Suggest Next Step AI suggests what step to add next. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | current_steps | array | ✅ | Existing steps | | goal | string | ❌ | What to achieve | --- Response json { \"success\": true, \"suggesti...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "nodes", "value": "", "type": "text", "description": "Aktuelle Workflow-Nodes" }, { "key": "connections", "value": "", "type": "text", "description": "Aktuelle Verbindungen" }, { "key": "context", "value": "", "type": "text", "description": "Zusaetzlicher Kontext fuer die Vorschlaege" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"suggestions\": [\n {\n \"node_type\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"confidence\": 0\n }\n ]\n }\n }\n}" } ] }, { "name": "Optimize workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Optimize Workflow AI analyzes and suggests optimizations. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Workflow to optimize | --- Response json { \"success\": true, \"suggestions\": { \"type\": \"merge_steps\", \"...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow", "value": "", "type": "text", "description": "Workflow-Objekt das optimiert werden soll (required)" }, { "key": "goal", "value": "efficiency", "type": "text", "description": "Optimierungsziel" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Optimize Workflow AI analyzes and suggests optimizations. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Workflow to optimize | --- Response json { \"success\": true, \"suggestions\": { \"type\": \"merge_steps\", \"...\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow", "value": "", "type": "text", "description": "Workflow-Objekt das optimiert werden soll (required)" }, { "key": "goal", "value": "efficiency", "type": "text", "description": "Optimierungsziel" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"optimized_nodes\": [\n {}\n ],\n \"optimized_edges\": [\n {}\n ],\n \"changes\": [\n \"string\"\n ],\n \"improvement_score\": 0\n }\n }\n}" } ] }, { "name": "Validate workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_ai/validate", "host": [ "{{base_url}}" ], "path": [ "workflow_ai", "validate" ] }, "description": "Validate Workflow Check workflow for errors and issues. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Workflow to validate | --- Response json { \"success\": true, \"valid\": true, \"warnings\": , \"errors\": }\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow", "value": "", "type": "text", "description": "Workflow-Objekt mit nodes (Array von {id, type, label, config}) und connections (Array von {from, to}). Node-Typen: start, end, approval, condition, notification, webhook, delay, document_action, ai_classify, form. (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_ai/validate", "host": [ "{{base_url}}" ], "path": [ "workflow_ai", "validate" ] }, "description": "Validate Workflow Check workflow for errors and issues. --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template_id | string | ✅ | Workflow to validate | --- Response json { \"success\": true, \"valid\": true, \"warnings\": , \"errors\": }\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow", "value": "", "type": "text", "description": "Workflow-Objekt mit nodes (Array von {id, type, label, config}) und connections (Array von {from, to}). Node-Typen: start, end, approval, condition, notification, webhook, delay, document_action, ai_classify, form. (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"is_valid\": true,\n \"errors\": [\n {}\n ],\n \"warnings\": [\n {}\n ],\n \"suggestions\": [\n \"string\"\n ]\n }\n }\n}" } ] } ] }, { "name": "💾 Storage", "item": [ { "name": "", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/logs", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "logs" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/mkdir", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "mkdir" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "ID of the storage mount (required)" }, { "key": "folder_name", "value": "", "type": "text", "description": "Name of the new folder (no special characters) (required)" }, { "key": "path", "value": "", "type": "text", "description": "Parent path where the folder will be created (relative to base_path)" } ] } } }, { "name": "", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/trace", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "trace" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "ID of the storage mount to trace (required)" } ] } } }, { "name": "", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/browse", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "browse" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/health", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "health" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/sync-queue", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "sync-queue" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/mirrors-list", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "mirrors-list" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/mirrors-add", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "mirrors-add" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "source_mount_id", "value": "", "type": "text", "description": "Source mount ID (data origin) (required)" }, { "key": "target_mount_id", "value": "", "type": "text", "description": "Target mount ID (mirror destination) (required)" }, { "key": "sync_mode", "value": "realtime", "type": "text", "description": "Synchronization mode" }, { "key": "priority", "value": 0, "type": "text", "description": "Mirror priority (lower = higher priority)" } ] } } }, { "name": "", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/mirrors-remove", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "mirrors-remove" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mirror_id", "value": "", "type": "text", "description": "Mirror ID to remove (required)" } ] } } }, { "name": "", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/mirrors-toggle", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "mirrors-toggle" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mirror_id", "value": "", "type": "text", "description": "Mirror ID to toggle (required)" }, { "key": "is_active", "value": "", "type": "text", "description": "1 = active, 0 = paused (required)" } ] } } }, { "name": "", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/health-check-now", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "health-check-now" ] }, "description": "\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Specific mount ID to check. Omit to check ALL active mounts." } ] } } }, { "name": "Add Document Tag", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-tag-add", "host": [ "{{base_url}}" ], "path": [ "documents", "document-tag-add" ] }, "description": "Tag an ein Dokument anfuegen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "tag_name", "value": "", "type": "text", "description": "Tag-Name (max 100 Zeichen) (required)" }, { "key": "tag_color", "value": "", "type": "text", "description": "Optional hex color (#RGB or #RRGGBB format, e.g. #FF0000). Invalid formats will be rejected." } ] } } }, { "name": "Add Storage Mount", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/add", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "add" ] }, "description": "Add Storage Mount Create a new storage mount connection. Required: name, host Optional: connector_type sftp|ftp|ftps|smb|webdav|s3, port, username, password, ssh_key, base_path Response: json { \"status\": \"success\", \"message\": \"MOUNT_CREATED\", \"data\": { \"mount_id\": 123, \"name\": \"Office NAS\" } }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Storage Mounts (Pflichtfeld). (required)" }, { "key": "host", "value": "", "type": "text", "description": "Hostname oder IP-Adresse des Servers." }, { "key": "connector_type", "value": "sftp", "type": "text", "description": "Typ der Speicheranbindung." }, { "key": "mount_purpose", "value": "", "type": "text", "description": "Zweck des Mounts: 'byos' (Bring Your Own Storage) oder 'connector' (Datenquelle). Pflichtfeld, nach Erstellung unveraenderlich. (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Mounts." }, { "key": "port", "value": "", "type": "text", "description": "Port (Standard: 22 fuer SFTP, 443 fuer S3/WebDAV, 993 fuer IMAP)." }, { "key": "username", "value": "", "type": "text", "description": "Benutzername fuer die Authentifizierung." }, { "key": "password", "value": "", "type": "text", "description": "Passwort (wird verschluesselt gespeichert)." }, { "key": "ssh_key", "value": "", "type": "text", "description": "SSH Private Key (wird verschluesselt gespeichert)." }, { "key": "api_token", "value": "", "type": "text", "description": "API-Token (wird verschluesselt gespeichert)." }, { "key": "base_path", "value": "/", "type": "text", "description": "Basispfad auf dem Remote-Server. Keine '..' Segmente erlaubt." }, { "key": "encryption_key", "value": "", "type": "text", "description": "Verschluesselungs-Passwort fuer BYOS-Mounts (Pflicht bei mount_purpose='byos'). ACHTUNG: Bei Verlust unwiderruflich!" }, { "key": "connection_options", "value": "", "type": "text", "description": "Zusaetzliche Verbindungsoptionen als JSON-Objekt (z.B. S3-Region, IMAP-Ordner)." }, { "key": "icon_url", "value": "", "type": "text", "description": "URL fuer ein benutzerdefiniertes Icon." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/add", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "add" ] }, "description": "Add Storage Mount Create a new storage mount connection. Required: name, host Optional: connector_type sftp|ftp|ftps|smb|webdav|s3, port, username, password, ssh_key, base_path Response: json { \"status\": \"success\", \"message\": \"MOUNT_CREATED\", \"data\": { \"mount_id\": 123, \"name\": \"Office NAS\" } }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Storage Mounts (Pflichtfeld). (required)" }, { "key": "host", "value": "", "type": "text", "description": "Hostname oder IP-Adresse des Servers." }, { "key": "connector_type", "value": "sftp", "type": "text", "description": "Typ der Speicheranbindung." }, { "key": "mount_purpose", "value": "", "type": "text", "description": "Zweck des Mounts: 'byos' (Bring Your Own Storage) oder 'connector' (Datenquelle). Pflichtfeld, nach Erstellung unveraenderlich. (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Mounts." }, { "key": "port", "value": "", "type": "text", "description": "Port (Standard: 22 fuer SFTP, 443 fuer S3/WebDAV, 993 fuer IMAP)." }, { "key": "username", "value": "", "type": "text", "description": "Benutzername fuer die Authentifizierung." }, { "key": "password", "value": "", "type": "text", "description": "Passwort (wird verschluesselt gespeichert)." }, { "key": "ssh_key", "value": "", "type": "text", "description": "SSH Private Key (wird verschluesselt gespeichert)." }, { "key": "api_token", "value": "", "type": "text", "description": "API-Token (wird verschluesselt gespeichert)." }, { "key": "base_path", "value": "/", "type": "text", "description": "Basispfad auf dem Remote-Server. Keine '..' Segmente erlaubt." }, { "key": "encryption_key", "value": "", "type": "text", "description": "Verschluesselungs-Passwort fuer BYOS-Mounts (Pflicht bei mount_purpose='byos'). ACHTUNG: Bei Verlust unwiderruflich!" }, { "key": "connection_options", "value": "", "type": "text", "description": "Zusaetzliche Verbindungsoptionen als JSON-Objekt (z.B. S3-Region, IMAP-Ordner)." }, { "key": "icon_url", "value": "", "type": "text", "description": "URL fuer ein benutzerdefiniertes Icon." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"mount_id\": \"poai-job_xxx\",\n \"type\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "Batch Process Documents (AI-DMS)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-batch-process", "host": [ "{{base_url}}" ], "path": [ "documents", "document-batch-process" ] }, "description": "Triggert die AI-DMS Verarbeitung fuer mehrere Dokumente gleichzeitig. Max 50 POFIDs pro Batch. Jedes Dokument wird asynchron durch OCR, Entity Extraction, Klassifizierung etc. verarbeitet.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofids", "value": "", "type": "text", "description": "Array of POFIDs to process (max 50) (required)" }, { "key": "ai_dms_tier", "value": "basic", "type": "text", "description": "AI-DMS processing tier: basic (OCR + classification), premium (+ entity extraction), ultra (+ deep analysis)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-batch-process", "host": [ "{{base_url}}" ], "path": [ "documents", "document-batch-process" ] }, "description": "Triggert die AI-DMS Verarbeitung fuer mehrere Dokumente gleichzeitig. Max 50 POFIDs pro Batch. Jedes Dokument wird asynchron durch OCR, Entity Extraction, Klassifizierung etc. verarbeitet.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofids", "value": "", "type": "text", "description": "Array of POFIDs to process (max 50) (required)" }, { "key": "ai_dms_tier", "value": "basic", "type": "text", "description": "AI-DMS processing tier: basic (OCR + classification), premium (+ entity extraction), ultra (+ deep analysis)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"ai_dms_tier\": \"string\",\n \"queued\": [\n {\n \"pofid\": \"string\",\n \"file_name\": \"string\",\n \"status\": \"string\",\n \"was_reset\": true\n }\n ],\n \"queued_count\": 0,\n \"reset_count\": 0,\n \"not_found\": [\n \"string\"\n ],\n \"not_found_count\": 0,\n \"errors\": [\n {\n \"pofid\": \"string\",\n \"file_name\": \"string\",\n \"error\": \"string\"\n }\n ],\n \"error_count\": 0,\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Cancel Document Checkout", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-cancel-checkout", "host": [ "{{base_url}}" ], "path": [ "documents", "document-cancel-checkout" ] }, "description": "Checkout abbrechen und Dokument wieder freigeben ohne neue Version.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des ausgecheckten Dokuments (required)" } ] } } }, { "name": "Create Document Comment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-comment-create", "host": [ "{{base_url}}" ], "path": [ "documents", "document-comment-create" ] }, "description": "Kommentar oder Antwort zu einem Dokument erstellen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "content", "value": "", "type": "text", "description": "Kommentar-Text (Pflicht) (required)" }, { "key": "parent_id", "value": "", "type": "text", "description": "ID des Eltern-Kommentars fuer Antwort (optional)" }, { "key": "page_number", "value": "", "type": "text", "description": "Seitennummer (optional)" }, { "key": "anchor_text", "value": "", "type": "text", "description": "Ankertext im Dokument (optional)" } ] } } }, { "name": "Create Document Note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-note-create", "host": [ "{{base_url}}" ], "path": [ "documents", "document-note-create" ] }, "description": "Neue Notiz an ein Dokument anfuegen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "content", "value": "", "type": "text", "description": "Notiz-Inhalt (Pflicht) (required)" }, { "key": "title", "value": "", "type": "text", "description": "Optionaler Titel" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie (default: general)" }, { "key": "is_pinned", "value": "", "type": "text", "description": "Pin note to top (0 = no, 1 = yes, default: 0)" }, { "key": "is_private", "value": "", "type": "text", "description": "Private note visible only to you (0 = no, 1 = yes, default: 0)" } ] } } }, { "name": "Delete Document Comment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-comment-delete", "host": [ "{{base_url}}" ], "path": [ "documents", "document-comment-delete" ] }, "description": "Eigenen Kommentar loeschen (inkl. Replies).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "comment_id", "value": "", "type": "text", "description": "ID des zu loeschenden Kommentars (required)" } ] } } }, { "name": "Delete Document Note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-note-delete", "host": [ "{{base_url}}" ], "path": [ "documents", "document-note-delete" ] }, "description": "Notiz loeschen (Soft Delete, nur eigene).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "note_id", "value": "", "type": "text", "description": "ID der zu loeschenden Notiz (required)" } ] } } }, { "name": "Delete Storage Mount", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/delete", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "delete" ] }, "description": "Delete Storage Mount ⚠️ Cannot delete mounts with active connectors.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Parameter: mount_id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/delete", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "delete" ] }, "description": "Delete Storage Mount ⚠️ Cannot delete mounts with active connectors.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Parameter: mount_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"data\": {\n \"mount_id\": 0\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Document Checkin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-checkin", "host": [ "{{base_url}}" ], "path": [ "documents", "document-checkin" ] }, "description": "Dokument einchecken und neue Version erstellen. Erfordert lock_token vom Checkout.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des ausgecheckten Dokuments (required)" }, { "key": "lock_token", "value": "", "type": "text", "description": "Lock-Token vom Checkout (Pflicht) (required)" }, { "key": "comment", "value": "", "type": "text", "description": "Versions-Kommentar (was wurde geaendert)" }, { "key": "upload_id", "value": "", "type": "text", "description": "Upload-ID fuer neue Datei-Version (optional, sonst nur Metadaten-Version)" } ] } } }, { "name": "Document Checkout", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-checkout", "host": [ "{{base_url}}" ], "path": [ "documents", "document-checkout" ] }, "description": "Dokument auschecken (sperren fuer Bearbeitung). Nur in revisionssicheren Workspaces verfuegbar.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des Dokuments (required)" }, { "key": "comment", "value": "", "type": "text", "description": "Optionaler Kommentar zum Checkout" } ] } } }, { "name": "Document Lifecycle Transition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-lifecycle-transition", "host": [ "{{base_url}}" ], "path": [ "documents", "document-lifecycle-transition" ] }, "description": "Lifecycle-Status eines Dokuments aendern. Nur erlaubte Transitionen moeglich.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "new_state", "value": "", "type": "text", "description": "Neuer Lifecycle-Status (required)" }, { "key": "comment", "value": "", "type": "text", "description": "Optionaler Kommentar zur Aenderung" } ] } } }, { "name": "Document Versions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-versions", "host": [ "{{base_url}}" ], "path": [ "documents", "document-versions" ] }, "description": "Alle Versionen eines Dokuments auflisten inkl. Versionshistorie.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Dokument: Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-get/{pofid}", "host": [ "{{base_url}}" ], "path": [ "documents", "document-get", "{pofid}" ] }, "description": "Gibt detaillierte Metadaten eines Dokuments zurueck.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-get/{pofid}", "host": [ "{{base_url}}" ], "path": [ "documents", "document-get", "{pofid}" ] }, "description": "Gibt detaillierte Metadaten eines Dokuments zurueck.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "Dokument: Felder bearbeiten", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-edit/{pofid}", "host": [ "{{base_url}}" ], "path": [ "documents", "document-edit", "{pofid}" ] }, "description": "Setzt oder aendert Meta-Felder eines Dokuments ueber kurze Alias-Keys.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "fields", "value": "", "type": "text", "description": "Key-Value-Paare mit Alias-Keys (document_type, sender_name, total_amount, etc.) oder nativen __-Pfaden (required)" } ] } } }, { "name": "Dokument: Hochladen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-put", "host": [ "{{base_url}}" ], "path": [ "documents", "document-put" ] }, "description": "Laedt ein neues Dokument hoch und speichert es verschluesselt.\n\n💰 **Kosten**: 10 Credits/MB (0.01€/MB)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "Hochzuladende Datei (multipart/form-data, binary) (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Ziel-Workspace-ID fuer das hochgeladene Dokument (required)" }, { "key": "workspace_name", "value": "", "type": "text", "description": "Workspace name" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-put", "host": [ "{{base_url}}" ], "path": [ "documents", "document-put" ] }, "description": "Laedt ein neues Dokument hoch und speichert es verschluesselt.\n\n💰 **Kosten**: 10 Credits/MB (0.01€/MB)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "Hochzuladende Datei (multipart/form-data, binary) (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Ziel-Workspace-ID fuer das hochgeladene Dokument (required)" }, { "key": "workspace_name", "value": "", "type": "text", "description": "Workspace name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"results\": [\n {\n \"status\": \"success\",\n \"pofid\": \"poai-job_xxx\",\n \"documents_id\": 0,\n \"filename\": \"2026-02-07T12:00:00Z\",\n \"size\": 0,\n \"total_pages\": 0,\n \"message\": \"string\"\n }\n ],\n \"workspace_id\": 0,\n \"workspace_name\": \"Beispiel\",\n \"workflow_import\": {\n \"source_job_id\": \"poai-job_xxx\",\n \"documents_imported\": 0\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Dokument: Kopieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-copy", "host": [ "{{base_url}}" ], "path": [ "documents", "document-copy" ] }, "description": "Kopiert ein Dokument in einen anderen Workspace.\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des zu kopierenden Dokuments (required)" }, { "key": "target_workspace_id", "value": "", "type": "text", "description": "ID des Ziel-Workspace, in den das Dokument kopiert werden soll (required)" }, { "key": "locale", "value": "", "type": "text", "description": "Locale" }, { "key": "new_file_name", "value": "", "type": "text", "description": "New file name" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-copy", "host": [ "{{base_url}}" ], "path": [ "documents", "document-copy" ] }, "description": "Kopiert ein Dokument in einen anderen Workspace.\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des zu kopierenden Dokuments (required)" }, { "key": "target_workspace_id", "value": "", "type": "text", "description": "ID des Ziel-Workspace, in den das Dokument kopiert werden soll (required)" }, { "key": "locale", "value": "", "type": "text", "description": "Locale" }, { "key": "new_file_name", "value": "", "type": "text", "description": "New file name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"locale\": \"string\",\n \"original\": {\n \"pofid\": \"poai-job_xxx\",\n \"file_name\": \"2026-02-07T12:00:00Z\",\n \"workspace_id\": 0\n },\n \"copy\": {\n \"documents_id\": 0,\n \"pofid\": \"poai-job_xxx\",\n \"file_name\": \"2026-02-07T12:00:00Z\",\n \"workspace_id\": 0,\n \"workspace_name\": \"Beispiel\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Dokument: Löschen", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-delete", "host": [ "{{base_url}}" ], "path": [ "documents", "document-delete" ] }, "description": "Loescht ein Dokument (Soft-Delete). Das Dokument wird als geloescht markiert.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-delete", "host": [ "{{base_url}}" ], "path": [ "documents", "document-delete" ] }, "description": "Loescht ein Dokument (Soft-Delete). Das Dokument wird als geloescht markiert.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"deleted_count\": 0,\n \"not_found_count\": 0,\n \"error_count\": 0,\n \"deleted_documents\": [\n {\n \"pofid\": \"poai-job_xxx\",\n \"file_name\": \"2026-02-07T12:00:00Z\",\n \"documents_id\": 0,\n \"workspace_id\": 0\n }\n ],\n \"cleanup_queued\": 0,\n \"mode\": \"trash\",\n \"not_found_documents\": [\n \"string\"\n ],\n \"deleted_folders\": [\n \"string\"\n ],\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Dokument: OCR-Text abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/ocr-get", "host": [ "{{base_url}}" ], "path": [ "documents", "ocr-get" ] }, "description": "Gibt den OCR-extrahierten Text eines Dokuments zurueck. Enthaelt Text pro Seite mit Konfidenzbewertung.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/ocr-get", "host": [ "{{base_url}}" ], "path": [ "documents", "ocr-get" ] }, "description": "Gibt den OCR-extrahierten Text eines Dokuments zurueck. Enthaelt Text pro Seite mit Konfidenzbewertung.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"locale\": \"string\",\n \"document\": {\n \"pofid\": \"poai-job_xxx\",\n \"file_name\": \"2026-02-07T12:00:00Z\",\n \"total_pages\": 0\n },\n \"source\": \"ocr\",\n \"ocr_text\": \"string\",\n \"statistics\": {\n \"pages_with_ocr\": 0,\n \"total_characters\": 0,\n \"total_lines\": 0,\n \"average_confidence\": 0\n },\n \"pages\": [\n {\n \"page_number\": 0,\n \"ocr_text\": \"string\",\n \"line_count\": 0,\n \"char_count\": 0,\n \"confidence_avg\": 0,\n \"bounding_boxes\": [\n {}\n ]\n }\n ],\n \"processing_time\": \"string\",\n \"pofid\": \"poai-job_xxx\",\n \"file_name\": \"Beispiel\"\n}" } ] }, { "name": "Dokument: Verschieben", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-move", "host": [ "{{base_url}}" ], "path": [ "documents", "document-move" ] }, "description": "Verschiebt ein Dokument in einen anderen Workspace.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des zu verschiebenden Dokuments (required)" }, { "key": "target_workspace_id", "value": "", "type": "text", "description": "ID des Ziel-Workspace, in den das Dokument verschoben werden soll (required)" }, { "key": "locale", "value": "", "type": "text", "description": "Locale" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-move", "host": [ "{{base_url}}" ], "path": [ "documents", "document-move" ] }, "description": "Verschiebt ein Dokument in einen anderen Workspace.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des zu verschiebenden Dokuments (required)" }, { "key": "target_workspace_id", "value": "", "type": "text", "description": "ID des Ziel-Workspace, in den das Dokument verschoben werden soll (required)" }, { "key": "locale", "value": "", "type": "text", "description": "Locale" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"locale\": \"string\",\n \"document\": {\n \"pofid\": \"poai-job_xxx\",\n \"file_name\": \"2026-02-07T12:00:00Z\",\n \"old_workspace_id\": 0,\n \"new_workspace_id\": 0,\n \"new_workspace_name\": \"Beispiel\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Dokument: Volltextsuche", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-search", "host": [ "{{base_url}}" ], "path": [ "documents", "document-search" ] }, "description": "Durchsucht Dokumente per Volltext nach Suchbegriffen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-search", "host": [ "{{base_url}}" ], "path": [ "documents", "document-search" ] }, "description": "Durchsucht Dokumente per Volltext nach Suchbegriffen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"count\": 0,\n \"result\": [\n {\n \"pofid\": \"poai-job_xxx\",\n \"filename\": \"Beispiel\",\n \"workspace_id\": 0,\n \"relevance_score\": 0\n }\n ],\n \"status\": \"success\"\n}" } ] }, { "name": "Duplicate Check", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/duplicate-check", "host": [ "{{base_url}}" ], "path": [ "documents", "duplicate-check" ] }, "description": "Pruefen ob ein Dokument mit gleichem SHA-256 Hash bereits existiert.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_hash", "value": "", "type": "text", "description": "SHA-256 Hash der Datei (Pflicht) (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Auf Workspace einschraenken" } ] } } }, { "name": "Empty Trash", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/trash-empty", "host": [ "{{base_url}}" ], "path": [ "documents", "trash-empty" ] }, "description": "Papierkorb leeren (endgueltig alle geloeschten Dokumente entfernen).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Nur Papierkorb eines Workspaces leeren" }, { "key": "confirm", "value": "", "type": "text", "description": "Bestaetigung erforderlich (muss true sein) (required)" } ] } } }, { "name": "Get Document Lifecycle", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-lifecycle-get", "host": [ "{{base_url}}" ], "path": [ "documents", "document-lifecycle-get" ] }, "description": "Aktuellen Lifecycle-Status eines Dokuments abrufen inkl. erlaubter Transitionen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "List Deleted Documents (Trash)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/trash-list", "host": [ "{{base_url}}" ], "path": [ "documents", "trash-list" ] }, "description": "Zeigt alle soft-deleted Dokumente im Papierkorb an. Paginiert mit Restlaufzeit (days_remaining) und Wiederherstellbarkeit (is_restorable). Optional nach Workspace filterbar.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Filter by workspace" }, { "key": "page", "value": 1, "type": "text", "description": "Page number (default: 1)" }, { "key": "per_page", "value": 50, "type": "text", "description": "Items per page (10-200, default: 50)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/trash-list", "host": [ "{{base_url}}" ], "path": [ "documents", "trash-list" ] }, "description": "Zeigt alle soft-deleted Dokumente im Papierkorb an. Paginiert mit Restlaufzeit (days_remaining) und Wiederherstellbarkeit (is_restorable). Optional nach Workspace filterbar.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Filter by workspace" }, { "key": "page", "value": 1, "type": "text", "description": "Page number (default: 1)" }, { "key": "per_page", "value": 50, "type": "text", "description": "Items per page (10-200, default: 50)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"page\": 0,\n \"pages\": 0,\n \"per_page\": 0,\n \"processing_time\": \"string\",\n \"retention_days\": 0,\n \"status\": \"string\",\n \"total\": 0,\n \"total_size_bytes\": 0,\n \"total_size_human\": \"string\",\n \"trash_items\": {},\n \"message\": \"string\",\n \"force_deleted_count\": \"string\",\n \"trash_retention_days\": \"string\",\n \"storage_status\": \"string\",\n \"mode\": \"string\"\n}" } ] }, { "name": "List Document Comments", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-comments", "host": [ "{{base_url}}" ], "path": [ "documents", "document-comments" ] }, "description": "Kommentare eines Dokuments als Thread-Struktur auflisten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "List Document Notes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-notes", "host": [ "{{base_url}}" ], "path": [ "documents", "document-notes" ] }, "description": "Alle Notizen eines Dokuments auflisten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "List Document Tags", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-tags", "host": [ "{{base_url}}" ], "path": [ "documents", "document-tags" ] }, "description": "Alle Tags eines Dokuments auflisten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "List Legal Holds", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-legal-holds-list", "host": [ "{{base_url}}" ], "path": [ "documents", "document-legal-holds-list" ] }, "description": "Legal Holds auflisten (pro Workspace oder Dokument).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Mount details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/get", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "get" ] }, "description": "Get Mount Details Get full details including linked connectors.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/get", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "get" ] }, "description": "Get Mount Details Get full details including linked connectors.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"mount_id\": \"poai-job_xxx\",\n \"type\": \"string\",\n \"path\": \"string\",\n \"status\": \"string\",\n \"storage_used\": \"string\"\n}" } ] }, { "name": "Place Legal Hold", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-legal-hold", "host": [ "{{base_url}}" ], "path": [ "documents", "document-legal-hold" ] }, "description": "Dokument unter Legal Hold stellen (Loeschsperre fuer rechtliche Aufbewahrung).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Grund fuer Legal Hold (Pflicht, z.B. Rechtsstreit, Audit) (required)" }, { "key": "reference", "value": "", "type": "text", "description": "Optionale Referenz (Aktenzeichen, Case-ID)" } ] } } }, { "name": "Release Legal Hold", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-legal-hold-release", "host": [ "{{base_url}}" ], "path": [ "documents", "document-legal-hold-release" ] }, "description": "Legal Hold aufheben (Dokument wieder loeschbar).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "hold_id", "value": "", "type": "text", "description": "ID des Legal Holds (Pflicht) (required)" } ] } } }, { "name": "Remove Document Tag", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-tag-remove", "host": [ "{{base_url}}" ], "path": [ "documents", "document-tag-remove" ] }, "description": "Tag von einem Dokument entfernen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID (required)" }, { "key": "tag_name", "value": "", "type": "text", "description": "Name of the tag to delete (REQUIRED if tag_id not provided)" }, { "key": "tag_id", "value": "", "type": "text", "description": "ID of the tag to delete (REQUIRED if tag_name not provided)" } ] } } }, { "name": "Rename Document", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-rename", "host": [ "{{base_url}}" ], "path": [ "documents", "document-rename" ] }, "description": "Benennt ein Dokument um. Die Original-Extension wird immer beibehalten. Pfad-Zeichen (/, \\, ..) werden abgelehnt. Sonderzeichen werden entfernt, fuehrende Punkte geloescht. Maximale Laenge: 255 Zeichen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "Document POFID to rename (required)" }, { "key": "new_file_name", "value": "", "type": "text", "description": "New file name (extension preserved if omitted) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-rename", "host": [ "{{base_url}}" ], "path": [ "documents", "document-rename" ] }, "description": "Benennt ein Dokument um. Die Original-Extension wird immer beibehalten. Pfad-Zeichen (/, \\, ..) werden abgelehnt. Sonderzeichen werden entfernt, fuehrende Punkte geloescht. Maximale Laenge: 255 Zeichen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "Document POFID to rename (required)" }, { "key": "new_file_name", "value": "", "type": "text", "description": "New file name (extension preserved if omitted) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"pofid\": \"poai-job_xxx\",\n \"new_name\": \"Beispiel\",\n \"processing_time\": \"string\",\n \"document\": \"string\",\n \"old_file_name\": \"Beispiel\",\n \"new_file_name\": \"Beispiel\",\n \"workspace_id\": \"poai-job_xxx\"\n}" } ] }, { "name": "Resolve Document Comment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-comment-resolve", "host": [ "{{base_url}}" ], "path": [ "documents", "document-comment-resolve" ] }, "description": "Kommentar-Thread als erledigt markieren oder wieder oeffnen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "comment_id", "value": "", "type": "text", "description": "ID des Root-Kommentars (nicht Reply) (required)" }, { "key": "resolved", "value": "", "type": "text", "description": "true = als erledigt markieren, false = wieder oeffnen (default: true)" } ] } } }, { "name": "Restore Document from Trash", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-restore", "host": [ "{{base_url}}" ], "path": [ "documents", "document-restore" ] }, "description": "Stellt ein oder mehrere soft-deleted Dokumente aus dem Papierkorb wieder her. Unterstuetzt auch Dokumentmappen (.podf). Nur wiederherstellbar solange phase=pending (nicht permanent geloescht).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "POFID or array of POFIDs to restore (required)" }, { "key": "target_workspace_id", "value": "", "type": "text", "description": "Optional: Restore to this workspace instead of original" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-restore", "host": [ "{{base_url}}" ], "path": [ "documents", "document-restore" ] }, "description": "Stellt ein oder mehrere soft-deleted Dokumente aus dem Papierkorb wieder her. Unterstuetzt auch Dokumentmappen (.podf). Nur wiederherstellbar solange phase=pending (nicht permanent geloescht).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "POFID or array of POFIDs to restore (required)" }, { "key": "target_workspace_id", "value": "", "type": "text", "description": "Optional: Restore to this workspace instead of original" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"pofid\": \"poai-job_xxx\",\n \"processing_time\": \"string\",\n \"restored_count\": \"string\",\n \"failed_count\": \"string\",\n \"restored_documents\": \"string\",\n \"failed_documents\": \"string\"\n}" } ] }, { "name": "Storage mounts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/list", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "list" ] }, "description": "List Storage Mounts Get all storage mount connections. Response: json { \"status\": \"success\", \"data\": { \"mounts\": { \"mount_id\": 1, \"name\": \"Office NAS\", \"connector_type\": \"sftp\", \"host\": \"nas.example.com\", \"port\": 22, \"base_path\": \"/documents\", \"is_active\": true, \"connector_count\": 2 } , \"total\": ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/list", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "list" ] }, "description": "List Storage Mounts Get all storage mount connections. Response: json { \"status\": \"success\", \"data\": { \"mounts\": { \"mount_id\": 1, \"name\": \"Office NAS\", \"connector_type\": \"sftp\", \"host\": \"nas.example.com\", \"port\": 22, \"base_path\": \"/documents\", \"is_active\": true, \"connector_count\": 2 } , \"total\": ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"mounts\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Tag Autocomplete", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/tag-autocomplete", "host": [ "{{base_url}}" ], "path": [ "documents", "tag-autocomplete" ] }, "description": "Tags fuer Autovervollstaendigung suchen (workspace-uebergreifend).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Test Storage Mount Connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/test", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "test" ] }, "description": "Test Connection Test if the storage mount is reachable. Can also test new credentials without saving: json { \"connector_type\": \"sftp\", \"host\": \"nas.example.com\", \"port\": 22, \"username\": \"user\", \"password\": \"pass\" }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Parameter: mount_id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/test", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "test" ] }, "description": "Test Connection Test if the storage mount is reachable. Can also test new credentials without saving: json { \"connector_type\": \"sftp\", \"host\": \"nas.example.com\", \"port\": 22, \"username\": \"user\", \"password\": \"pass\" }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Parameter: mount_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"connected\": true,\n \"message\": \"string\",\n \"latency_ms\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Trash Settings", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/trash-settings", "host": [ "{{base_url}}" ], "path": [ "documents", "trash-settings" ] }, "description": "Papierkorb-Einstellungen abrufen oder aendern.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" } }, { "name": "Update Document Comment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-comment-update", "host": [ "{{base_url}}" ], "path": [ "documents", "document-comment-update" ] }, "description": "Eigenen Kommentar bearbeiten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "comment_id", "value": "", "type": "text", "description": "ID des Kommentars (required)" }, { "key": "content", "value": "", "type": "text", "description": "Neuer Kommentar-Text (required)" } ] } } }, { "name": "Update Document Note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/document-note-update", "host": [ "{{base_url}}" ], "path": [ "documents", "document-note-update" ] }, "description": "Bestehende Notiz aktualisieren (nur eigene).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "note_id", "value": "", "type": "text", "description": "ID der Notiz (Pflicht) (required)" }, { "key": "title", "value": "", "type": "text", "description": "Neuer Titel" }, { "key": "content", "value": "", "type": "text", "description": "Neuer Inhalt" }, { "key": "category", "value": "", "type": "text", "description": "Neue Kategorie" }, { "key": "is_pinned", "value": "", "type": "text", "description": "Anheften/Loesen" }, { "key": "is_private", "value": "", "type": "text", "description": "Privat/Oeffentlich" } ] } } }, { "name": "Update Storage Mount", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/update", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "update" ] }, "description": "Update Storage Mount Modify an existing storage mount. Required: mount_id Optional: Any field to update\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Parameter: mount_id" }, { "key": "name", "value": "", "type": "text", "description": "Parameter: name" }, { "key": "is_active", "value": "", "type": "text", "description": "Parameter: is_active" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/storage_mounts/update", "host": [ "{{base_url}}" ], "path": [ "storage_mounts", "update" ] }, "description": "Update Storage Mount Modify an existing storage mount. Required: mount_id Optional: Any field to update\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "mount_id", "value": "", "type": "text", "description": "Parameter: mount_id" }, { "key": "name", "value": "", "type": "text", "description": "Parameter: name" }, { "key": "is_active", "value": "", "type": "text", "description": "Parameter: is_active" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"data\": {\n \"mount_id\": 0\n },\n \"processing_time\": \"string\"\n}" } ] } ] }, { "name": "🔎 Search", "item": [ { "name": "Exact field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Exact Field Search Filter documents by exact meta-field value. Use cases: - Find all documents of type X - Filter by status field - Custom field filtering Note: Query must exactly match the stored value.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "field", "value": "", "type": "text", "description": "Feldname fuer exakte Suche (z.B. file_name, status) (required)" }, { "key": "value", "value": "", "type": "text", "description": "Exakter Wert fuer das Feld (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Exact Field Search Filter documents by exact meta-field value. Use cases: - Find all documents of type X - Filter by status field - Custom field filtering Note: Query must exactly match the stored value.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "field", "value": "", "type": "text", "description": "Feldname fuer exakte Suche (z.B. file_name, status) (required)" }, { "key": "value", "value": "", "type": "text", "description": "Exakter Wert fuer das Feld (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"results\": [\n {\n \"pofid\": \"string\",\n \"filename\": \"string\",\n \"snippet\": \"string\",\n \"score\": 0,\n \"workspace_id\": 0,\n \"metadata\": {}\n }\n ],\n \"total\": 0,\n \"query_time_ms\": 0\n }\n }\n}" } ] }, { "name": "Rag search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "RAG Semantic Search Search across all knowledge sources using semantic similarity. How it works: 1. Your query is embedded using embedding model3-embedding:8b 2. Vector similarity search finds relevant chunks 3. Results ranked by cosine similarity Response: json { \"status\": \"success\", \"data\": { \"...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "Wie setze ich mein Passwort zurück?", "type": "text", "description": "Search query natural language" }, { "key": "limit", "value": "5", "type": "text", "description": "Max results default: 5" }, { "key": "connector_types", "value": "zammad", "type": "text", "description": "Filter by connector optional, comma-separated" }, { "key": "source_types", "value": "ticket,kb_article", "type": "text", "description": "Filter by source type optional" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "RAG Semantic Search Search across all knowledge sources using semantic similarity. How it works: 1. Your query is embedded using embedding model3-embedding:8b 2. Vector similarity search finds relevant chunks 3. Results ranked by cosine similarity Response: json { \"status\": \"success\", \"data\": { \"...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "Wie setze ich mein Passwort zurück?", "type": "text", "description": "Search query natural language" }, { "key": "limit", "value": "5", "type": "text", "description": "Max results default: 5" }, { "key": "connector_types", "value": "zammad", "type": "text", "description": "Filter by connector optional, comma-separated" }, { "key": "source_types", "value": "ticket,kb_article", "type": "text", "description": "Filter by source type optional" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"answer\": \"string\",\n \"sources\": [\n {\n \"pofid\": \"string\",\n \"filename\": \"string\",\n \"snippet\": \"string\",\n \"relevance\": 0\n }\n ],\n \"confidence\": 0\n }\n }\n}" } ] }, { "name": "Search fulltext", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Fulltext Search SQL LIKE + FULLTEXT search on: - file_name - All meta-field values - OCR text Features: - Relevance scoring - Pagination - Optional OCR preview\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchbegriff fuer Volltextsuche (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID zur Einschraenkung der Suche" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Fulltext Search SQL LIKE + FULLTEXT search on: - file_name - All meta-field values - OCR text Features: - Relevance scoring - Pagination - Optional OCR preview\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchbegriff fuer Volltextsuche (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID zur Einschraenkung der Suche" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"results\": [\n {\n \"pofid\": \"string\",\n \"filename\": \"string\",\n \"snippet\": \"string\",\n \"score\": 0,\n \"workspace_id\": 0,\n \"metadata\": {}\n }\n ],\n \"total\": 0,\n \"query_time_ms\": 0\n }\n }\n}" } ] }, { "name": "Search hybrid", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Hybrid Search Fulltext + Semantic Combines both search methods for best results using OpenClaw-style weighted scoring. Parameters: - vector_weight float, default: 0.7: Weight for semantic/vector search 0-1 - bm25_weight float, default: 0.3: Weight for keyword/BM25 search 0-1 - Weights are automat...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchbegriff fuer hybride Suche (Fulltext + Semantic) (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID zur Einschraenkung" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Hybrid Search Fulltext + Semantic Combines both search methods for best results using OpenClaw-style weighted scoring. Parameters: - vector_weight float, default: 0.7: Weight for semantic/vector search 0-1 - bm25_weight float, default: 0.3: Weight for keyword/BM25 search 0-1 - Weights are automat...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchbegriff fuer hybride Suche (Fulltext + Semantic) (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID zur Einschraenkung" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"results\": [\n {\n \"pofid\": \"string\",\n \"filename\": \"string\",\n \"snippet\": \"string\",\n \"score\": 0,\n \"workspace_id\": 0,\n \"metadata\": {}\n }\n ],\n \"total\": 0,\n \"query_time_ms\": 0\n }\n }\n}" } ] }, { "name": "Semantic vector", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Semantic Vector Search AI-powered search using embeddings. How it works: 1. Query text is converted to 4096-dim vector via AI model 2. Cosine similarity search against document embeddings 3. Returns documents above similarity_threshold Requirements: - Documents must have been processed with embed...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchbegriff fuer semantische Vektorsuche (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Semantic Vector Search AI-powered search using embeddings. How it works: 1. Query text is converted to 4096-dim vector via AI model 2. Cosine similarity search against document embeddings 3. Returns documents above similarity_threshold Requirements: - Documents must have been processed with embed...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchbegriff fuer semantische Vektorsuche (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID" }, { "key": "limit", "value": 20, "type": "text", "description": "Max. Ergebnisse" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"results\": [\n {\n \"pofid\": \"string\",\n \"filename\": \"string\",\n \"snippet\": \"string\",\n \"score\": 0,\n \"workspace_id\": 0,\n \"metadata\": {}\n }\n ],\n \"total\": 0,\n \"query_time_ms\": 0\n }\n }\n}" } ] } ] }, { "name": "📚 RAG/Knowledge", "item": [ { "name": "Document stats", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/summary/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "summary", "{document_id}" ] }, "description": "Get global document statistics: counts, embeddings, entities, amounts by type.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/summary/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "summary", "{document_id}" ] }, "description": "Get global document statistics: counts, embeddings, entities, amounts by type.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"total_documents\": 0,\n \"total_entities\": 0,\n \"total_relations\": 0,\n \"graph_density\": 0\n }\n }\n}" } ] }, { "name": "Entity statistics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/stats", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "stats" ] }, "description": "Get statistics for a specific entity: document count, total amounts, date range. Ideal for RAG context enrichment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/stats", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "stats" ] }, "description": "Get statistics for a specific entity: document count, total amounts, date range. Ideal for RAG context enrichment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"entity_types\": {},\n \"total_entities\": 0\n }\n }\n}" } ] }, { "name": "RAG Canonical Entities", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/canonical", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "canonical" ] }, "description": "Get deduplicated/canonical entities across all documents. Useful for RAG context and entity disambiguation.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/canonical", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "canonical" ] }, "description": "Get deduplicated/canonical entities across all documents. Useful for RAG context and entity disambiguation.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"entities\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Similar documents", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/embeddings/search", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "embeddings", "search" ] }, "description": "Find semantically similar documents using embedding comparison. Uses cosine similarity with configurable threshold.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchanfrage oder Referenztext fuer die Aehnlichkeitssuche. (required)" }, { "key": "language", "value": "", "type": "text", "description": "Sprachfilter (optional)." }, { "key": "limit", "value": 10, "type": "text", "description": "Maximale Anzahl aehnlicher Dokumente." }, { "key": "min_similarity", "value": 0.4, "type": "text", "description": "Minimale Cosine-Similarity (0.0 - 1.0)." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/embeddings/search", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "embeddings", "search" ] }, "description": "Find semantically similar documents using embedding comparison. Uses cosine similarity with configurable threshold.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Suchanfrage oder Referenztext fuer die Aehnlichkeitssuche. (required)" }, { "key": "language", "value": "", "type": "text", "description": "Sprachfilter (optional)." }, { "key": "limit", "value": 10, "type": "text", "description": "Maximale Anzahl aehnlicher Dokumente." }, { "key": "min_similarity", "value": 0.4, "type": "text", "description": "Minimale Cosine-Similarity (0.0 - 1.0)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"similar\": [\n {\n \"pofid\": \"string\",\n \"filename\": \"string\",\n \"similarity_score\": 0\n }\n ]\n }\n }\n}" } ] } ] }, { "name": "🧮 Embeddings", "item": [ { "name": "Document embeddings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle Embeddings eines Dokuments. Embedding Types: - document_summary - Zusammenfassung des Dokuments - document_full - Vollständiger Dokumenttext - page - Pro Seite - paragraph - Pro Absatz - metadata - Meta-Daten - entity - Pro Entität\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "", "type": "text", "description": "Optional: document_summary, document_full, page, paragraph, metadata, entity" }, { "key": "include_vectors", "value": "", "type": "text", "description": "Include raw vectors (large response!)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle Embeddings eines Dokuments. Embedding Types: - document_summary - Zusammenfassung des Dokuments - document_full - Vollständiger Dokumenttext - page - Pro Seite - paragraph - Pro Absatz - metadata - Meta-Daten - entity - Pro Entität\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "", "type": "text", "description": "Optional: document_summary, document_full, page, paragraph, metadata, entity" }, { "key": "include_vectors", "value": "", "type": "text", "description": "Include raw vectors (large response!)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"embeddings\": [\n [\n 0\n ]\n ],\n \"model\": \"string\",\n \"dimensions\": 0\n }\n }\n}" } ] }, { "name": "Semantic search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Semantische Suche über Dokument-Embeddings. Findet Dokumente die semantisch ähnlich zur Query sind, nicht nur exakte Keyword-Matches.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Natuerlichsprachliche Suchanfrage (Pflichtfeld). (required)" }, { "key": "language", "value": "", "type": "text", "description": "Sprachfilter (z.B. 'de', 'en'). Null = alle Sprachen." }, { "key": "limit", "value": 10, "type": "text", "description": "Maximale Anzahl Ergebnisse." }, { "key": "min_similarity", "value": 0.4, "type": "text", "description": "Minimale Aehnlichkeit (Cosine-Similarity) fuer Vektor-Suche." }, { "key": "mode", "value": "auto", "type": "text", "description": "Suchmodus: 'vector' (nur Vektor), 'fulltext' (nur Text), 'auto' (Vektor mit Fulltext-Fallback)." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Semantische Suche über Dokument-Embeddings. Findet Dokumente die semantisch ähnlich zur Query sind, nicht nur exakte Keyword-Matches.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "query", "value": "", "type": "text", "description": "Natuerlichsprachliche Suchanfrage (Pflichtfeld). (required)" }, { "key": "language", "value": "", "type": "text", "description": "Sprachfilter (z.B. 'de', 'en'). Null = alle Sprachen." }, { "key": "limit", "value": 10, "type": "text", "description": "Maximale Anzahl Ergebnisse." }, { "key": "min_similarity", "value": 0.4, "type": "text", "description": "Minimale Aehnlichkeit (Cosine-Similarity) fuer Vektor-Suche." }, { "key": "mode", "value": "auto", "type": "text", "description": "Suchmodus: 'vector' (nur Vektor), 'fulltext' (nur Text), 'auto' (Vektor mit Fulltext-Fallback)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"results\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "🔊 Text-to-Speech", "item": [ { "name": "Available voices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Returns all available TTS voices grouped by language. Each voice includes: name (use as voice parameter), gender, tier (basic/all), and sample URL for preview. 848 voices across 39 languages. Use the name field from the response as the voice parameter in TTS requests.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Returns all available TTS voices grouped by language. Each voice includes: name (use as voice parameter), gender, tier (basic/all), and sample URL for preview. 848 voices across 39 languages. Use the name field from the response as the voice parameter in TTS requests.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"voices\": [\n {\n \"name\": \"string\",\n \"language\": \"string\",\n \"gender\": \"string\",\n \"preview_url\": \"string\"\n }\n ]\n }\n }\n}" } ] }, { "name": "Generate speech", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert text to speech using neural voices. Output Formats: MP3, WAV, OGG. 39 Languages: DE, EN, ES, ES-MX, FR, IT, JA, PT, PT-PT, PT-BR, PL, TR, RU, NL, CS, AR, ZH, HU, KO, HI, BG, DA, EL, ET, FI, HE, HR, ID, LT, LV, MS, NO, RO, SK, SL, SR, SV, TH, UK, VI. Quality Tiers: basic (fast, 1:7), premium (balanced, 1:4), ultra (best quality, 1:1). Sync/Async: Use priority >= 900 for synchronous processing. Voice Cloning: Use voice_sample parameter (Premium/Ultra only).\n\n💰 **Kosten**: 50 Credits/per_1k_characters (0.05€/per_1k_characters)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "Hallo, das ist ein Test.", "type": "text", "description": "Text to convert to speech (max 50.000 characters) (required)" }, { "key": "voice", "value": "Anneliese", "type": "text", "description": "Voice name from /voices_info endpoint (required) (required)" }, { "key": "language", "value": "de", "type": "text", "description": "Language code (required): de, en, es, es-MX, fr, it, ja, pt, pt-PT, pt-BR, pl, tr, ru, nl, cs, ar, zh-cn, hu, ko, hi, bg, da, el, et, fi, he, hr, id, lt, lv, ms, no, ro, sk, sl, sr, sv, th, uk, vi (required)" }, { "key": "quality", "value": "premium", "type": "text", "description": "Quality tier: basic (fast), premium (balanced), ultra (best quality). Default: premium" }, { "key": "output_format", "value": "mp3", "type": "text", "description": "Audio format: mp3 (compressed), wav (lossless), ogg (open source). Default: mp3. WAV/OGG require Premium or Ultra." }, { "key": "output", "value": "url", "type": "text", "description": "Response format: url (download URL), base64 (audio as Base64 string), inline (direct audio stream). Default: url" }, { "key": "priority", "value": "999", "type": "text", "description": "Processing priority: >= 900 = synchronous (waits for result). Default: 999" }, { "key": "speed", "value": "1.0", "type": "text", "description": "Speech speed: 0.9 (slower) to 1.1 (faster). Default: 1.0" }, { "key": "temperature", "value": "0.9", "type": "text", "description": "Sampling temperature: 0.1 (deterministic) to 1.0 (creative). Default: 0.9" }, { "key": "top_p", "value": "0.7", "type": "text", "description": "Top-P nucleus sampling: 0.1 to 1.0. Default: 0.7" }, { "key": "repetition_penalty", "value": "1.1", "type": "text", "description": "Repetition penalty: 0.9 to 1.99. Higher = less repetition. Default: 1.1" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert text to speech using neural voices. Output Formats: MP3, WAV, OGG. 39 Languages: DE, EN, ES, ES-MX, FR, IT, JA, PT, PT-PT, PT-BR, PL, TR, RU, NL, CS, AR, ZH, HU, KO, HI, BG, DA, EL, ET, FI, HE, HR, ID, LT, LV, MS, NO, RO, SK, SL, SR, SV, TH, UK, VI. Quality Tiers: basic (fast, 1:7), premium (balanced, 1:4), ultra (best quality, 1:1). Sync/Async: Use priority >= 900 for synchronous processing. Voice Cloning: Use voice_sample parameter (Premium/Ultra only).\n\n💰 **Kosten**: 50 Credits/per_1k_characters (0.05€/per_1k_characters)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "Hallo, das ist ein Test.", "type": "text", "description": "Text to convert to speech (max 50.000 characters) (required)" }, { "key": "voice", "value": "Anneliese", "type": "text", "description": "Voice name from /voices_info endpoint (required) (required)" }, { "key": "language", "value": "de", "type": "text", "description": "Language code (required): de, en, es, es-MX, fr, it, ja, pt, pt-PT, pt-BR, pl, tr, ru, nl, cs, ar, zh-cn, hu, ko, hi, bg, da, el, et, fi, he, hr, id, lt, lv, ms, no, ro, sk, sl, sr, sv, th, uk, vi (required)" }, { "key": "quality", "value": "premium", "type": "text", "description": "Quality tier: basic (fast), premium (balanced), ultra (best quality). Default: premium" }, { "key": "output_format", "value": "mp3", "type": "text", "description": "Audio format: mp3 (compressed), wav (lossless), ogg (open source). Default: mp3. WAV/OGG require Premium or Ultra." }, { "key": "output", "value": "url", "type": "text", "description": "Response format: url (download URL), base64 (audio as Base64 string), inline (direct audio stream). Default: url" }, { "key": "priority", "value": "999", "type": "text", "description": "Processing priority: >= 900 = synchronous (waits for result). Default: 999" }, { "key": "speed", "value": "1.0", "type": "text", "description": "Speech speed: 0.9 (slower) to 1.1 (faster). Default: 1.0" }, { "key": "temperature", "value": "0.9", "type": "text", "description": "Sampling temperature: 0.1 (deterministic) to 1.0 (creative). Default: 0.9" }, { "key": "top_p", "value": "0.7", "type": "text", "description": "Top-P nucleus sampling: 0.1 to 1.0. Default: 0.7" }, { "key": "repetition_penalty", "value": "1.1", "type": "text", "description": "Repetition penalty: 0.9 to 1.99. Higher = less repetition. Default: 1.1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"audio_duration_seconds\": 0,\n \"mime_type\": \"string\",\n \"language\": \"string\",\n \"voice\": \"string\",\n \"text_length\": 0\n }\n }\n}" } ] }, { "name": "Multi-Speaker (Inline Tags)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate audio with unlimited speakers using inline tags! Two tag formats supported:\n\n**Shorthand:** [de|Anneliese] Text [de|Florian] Text\n**Key-Value:** [voice:Anneliese lang:de] Text [voice:Florian lang:de speed:0.95] Text\n\nSupported tag attributes: voice, lang, speed, temp, quality.\nSpeaker names must match voices from /voices_info endpoint.\n\nLanguages: ar, bg, cs, da, de, el, en, es-ES, es-MX, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, lt, lv, ms, nl, no, pl, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-cn.\n\nOutput: MP3, WAV, OGG. Speed: 0.9-1.1. Quality: basic, premium (default), ultra.\n\n💰 **Kosten**: 50 Credits/per_1k_characters (0.05€/per_1k_characters)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "", "type": "text", "description": "Text with inline voice tags. Shorthand: [de|Anneliese] Text. Key-Value: [voice:Anneliese lang:de] Text. Emotion markers inline: (excited) (whispering) etc. (required)" }, { "key": "language", "value": "", "type": "text", "description": "Fallback language if not specified in tags. One of: ar,bg,cs,da,de,el,en,es-ES,es-MX,et,fi,fr,he,hi,hr,hu,id,it,ja,ko,lt,lv,ms,nl,no,pl,pt-BR,pt-PT,ro,ru,sk,sl,sr,sv,th,tr,uk,vi,zh-cn (required)" }, { "key": "quality", "value": "", "type": "text", "description": "Global quality tier (default: premium). Can be overridden per-tag with quality:ultra." }, { "key": "output_format", "value": "", "type": "text", "description": "Audio output format (default: mp3). Basic tier: mp3 only." }, { "key": "speed", "value": "", "type": "text", "description": "Global speech speed 0.9-1.1 (default: 1.0). Can be overridden per-tag with speed:0.95." }, { "key": "temperature", "value": "", "type": "text", "description": "Expressiveness 0.1-1.0 (default: 0.9)" }, { "key": "top_p", "value": "", "type": "text", "description": "Diversity 0.1-1.0 (default: 0.7)" }, { "key": "repetition_penalty", "value": "", "type": "text", "description": "Repetition penalty 0.9-1.99 (default: 1.1)" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. 100=async (recommended), 900=sync." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Generate audio with unlimited speakers using inline tags! Two tag formats supported:\n\n**Shorthand:** [de|Anneliese] Text [de|Florian] Text\n**Key-Value:** [voice:Anneliese lang:de] Text [voice:Florian lang:de speed:0.95] Text\n\nSupported tag attributes: voice, lang, speed, temp, quality.\nSpeaker names must match voices from /voices_info endpoint.\n\nLanguages: ar, bg, cs, da, de, el, en, es-ES, es-MX, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, lt, lv, ms, nl, no, pl, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, th, tr, uk, vi, zh-cn.\n\nOutput: MP3, WAV, OGG. Speed: 0.9-1.1. Quality: basic, premium (default), ultra.\n\n💰 **Kosten**: 50 Credits/per_1k_characters (0.05€/per_1k_characters)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "", "type": "text", "description": "Text with inline voice tags. Shorthand: [de|Anneliese] Text. Key-Value: [voice:Anneliese lang:de] Text. Emotion markers inline: (excited) (whispering) etc. (required)" }, { "key": "language", "value": "", "type": "text", "description": "Fallback language if not specified in tags. One of: ar,bg,cs,da,de,el,en,es-ES,es-MX,et,fi,fr,he,hi,hr,hu,id,it,ja,ko,lt,lv,ms,nl,no,pl,pt-BR,pt-PT,ro,ru,sk,sl,sr,sv,th,tr,uk,vi,zh-cn (required)" }, { "key": "quality", "value": "", "type": "text", "description": "Global quality tier (default: premium). Can be overridden per-tag with quality:ultra." }, { "key": "output_format", "value": "", "type": "text", "description": "Audio output format (default: mp3). Basic tier: mp3 only." }, { "key": "speed", "value": "", "type": "text", "description": "Global speech speed 0.9-1.1 (default: 1.0). Can be overridden per-tag with speed:0.95." }, { "key": "temperature", "value": "", "type": "text", "description": "Expressiveness 0.1-1.0 (default: 0.9)" }, { "key": "top_p", "value": "", "type": "text", "description": "Diversity 0.1-1.0 (default: 0.7)" }, { "key": "repetition_penalty", "value": "", "type": "text", "description": "Repetition penalty 0.9-1.99 (default: 1.1)" }, { "key": "priority", "value": "", "type": "text", "description": "Job priority. 100=async (recommended), 900=sync." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Voice cloning", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Clone ANY voice with just an audio sample! Requires Premium or Ultra tier. No voice parameter needed - upload voice_sample instead. Voice Sample Requirements: Duration: 5-15 seconds (optimal: ~10s). Quality: Clean audio, NO background noise. Formats: WAV, MP3, OGG, FLAC, M4A, WebM, AAC. Max size: 10 MB. Tip: Clearer samples produce better results.\n\n💰 **Kosten**: 100 Credits/per_1k_characters (0.1€/per_1k_characters)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "Hallo, das ist ein Test mit meiner geklonten Stimme.", "type": "text", "description": "Text to speak (max 50.000 characters) (required)" }, { "key": "voice_sample", "value": "", "type": "text", "description": "Audio file of the voice to clone (required for cloning). 5-15 seconds, clean audio, max 10 MB. Formats: WAV, MP3, OGG, FLAC, M4A, WebM, AAC. (required)" }, { "key": "quality", "value": "premium", "type": "text", "description": "Quality tier: premium (balanced) or ultra (best quality). Basic is NOT supported for voice cloning. Default: premium" }, { "key": "output_format", "value": "mp3", "type": "text", "description": "Audio format: mp3 (compressed), wav (lossless), ogg (open source). Default: mp3" }, { "key": "output", "value": "url", "type": "text", "description": "Response format: url (download URL), base64, inline. Default: url" }, { "key": "priority", "value": "999", "type": "text", "description": "Processing priority: >= 900 = sync. Default: 999" }, { "key": "language", "value": "", "type": "text", "description": "Language code (optional, auto-detected from sample if empty): de, en, es, fr, it, ja, pt, etc." }, { "key": "speed", "value": "1.0", "type": "text", "description": "Speech speed: 0.9 to 1.1. Default: 1.0" }, { "key": "temperature", "value": "0.9", "type": "text", "description": "Sampling temperature: 0.1 to 1.0. Default: 0.9" }, { "key": "top_p", "value": "0.7", "type": "text", "description": "Top-P: 0.1 to 1.0. Default: 0.7" }, { "key": "repetition_penalty", "value": "1.1", "type": "text", "description": "Repetition penalty: 0.9 to 1.99. Default: 1.1" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Clone ANY voice with just an audio sample! Requires Premium or Ultra tier. No voice parameter needed - upload voice_sample instead. Voice Sample Requirements: Duration: 5-15 seconds (optimal: ~10s). Quality: Clean audio, NO background noise. Formats: WAV, MP3, OGG, FLAC, M4A, WebM, AAC. Max size: 10 MB. Tip: Clearer samples produce better results.\n\n💰 **Kosten**: 100 Credits/per_1k_characters (0.1€/per_1k_characters)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "Hallo, das ist ein Test mit meiner geklonten Stimme.", "type": "text", "description": "Text to speak (max 50.000 characters) (required)" }, { "key": "voice_sample", "value": "", "type": "text", "description": "Audio file of the voice to clone (required for cloning). 5-15 seconds, clean audio, max 10 MB. Formats: WAV, MP3, OGG, FLAC, M4A, WebM, AAC. (required)" }, { "key": "quality", "value": "premium", "type": "text", "description": "Quality tier: premium (balanced) or ultra (best quality). Basic is NOT supported for voice cloning. Default: premium" }, { "key": "output_format", "value": "mp3", "type": "text", "description": "Audio format: mp3 (compressed), wav (lossless), ogg (open source). Default: mp3" }, { "key": "output", "value": "url", "type": "text", "description": "Response format: url (download URL), base64, inline. Default: url" }, { "key": "priority", "value": "999", "type": "text", "description": "Processing priority: >= 900 = sync. Default: 999" }, { "key": "language", "value": "", "type": "text", "description": "Language code (optional, auto-detected from sample if empty): de, en, es, fr, it, ja, pt, etc." }, { "key": "speed", "value": "1.0", "type": "text", "description": "Speech speed: 0.9 to 1.1. Default: 1.0" }, { "key": "temperature", "value": "0.9", "type": "text", "description": "Sampling temperature: 0.1 to 1.0. Default: 0.9" }, { "key": "top_p", "value": "0.7", "type": "text", "description": "Top-P: 0.1 to 1.0. Default: 0.7" }, { "key": "repetition_penalty", "value": "1.1", "type": "text", "description": "Repetition penalty: 0.9 to 1.99. Default: 1.1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] } ] }, { "name": "🎤 Speech-to-Text", "item": [ { "name": "Transcribe audio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Transcribe audio to text with 3 quality tiers.\n\nBasic (1ct/min): Full transcription, 50+ languages, auto-detection, language confidence.\nPremium (2ct/min): + Word-level timestamps with confidence, segment timestamps, SRT/VTT export, custom vocabulary (hotwords).\nUltra (3ct/min): + Multi-speaker diarization, speaker labels, overlap detection, speaker count, multilingual meetings, RTTM export.\n\nSupported Formats: MP3, WAV, OGG, FLAC, M4A, WEBM. Max Size: 25 MB.\nSync/Async: Use priority >= 900 for synchronous processing.\n\n💰 **Kosten**: 10 Credits/minute (0.01€/minute)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Audio file to transcribe (required). Supported: MP3, WAV, OGG, FLAC, M4A, WEBM. Max 25 MB." }, { "key": "quality", "value": "basic", "type": "text", "description": "STT quality tier. basic: text only (1ct/min). premium: + word timestamps, SRT/VTT, hotwords (2ct/min). ultra: + speaker diarization, overlap detection, RTTM (3ct/min)" }, { "key": "output_format", "value": "json", "type": "text", "description": "Response format. json: structured JSON (default). srt: SubRip subtitle format. vtt: WebVTT subtitle format. rttm: Rich Transcription Time Marked (ultra only). Only srt/vtt/rttm available with premium or ultra quality." }, { "key": "hotwords", "value": "", "type": "text", "description": "Custom vocabulary hint. Comma-separated list of domain-specific words, names, or technical terms to improve recognition accuracy. Only available with premium or ultra quality. Example: PaperOffice,Datacore,Galera" }, { "key": "priority", "value": "999", "type": "text", "description": "Processing priority: >=900 = sync (waits for result). Default: 999" }, { "key": "locale", "value": "", "type": "text", "description": "Language hint (optional): de, en, es, fr, etc. Empty = auto-detection" }, { "key": "language", "value": "", "type": "text", "description": "Alternative to locale - same functionality. Language code: de, en, es, etc." }, { "key": "min_speakers", "value": "", "type": "text", "description": "Minimum expected speakers (ultra only). Helps diarization accuracy when you know the approximate speaker count." }, { "key": "max_speakers", "value": "", "type": "text", "description": "Maximum expected speakers (ultra only). Helps diarization accuracy when you know the approximate speaker count." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Transcribe audio to text with 3 quality tiers.\n\nBasic (1ct/min): Full transcription, 50+ languages, auto-detection, language confidence.\nPremium (2ct/min): + Word-level timestamps with confidence, segment timestamps, SRT/VTT export, custom vocabulary (hotwords).\nUltra (3ct/min): + Multi-speaker diarization, speaker labels, overlap detection, speaker count, multilingual meetings, RTTM export.\n\nSupported Formats: MP3, WAV, OGG, FLAC, M4A, WEBM. Max Size: 25 MB.\nSync/Async: Use priority >= 900 for synchronous processing.\n\n💰 **Kosten**: 10 Credits/minute (0.01€/minute)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "Audio file to transcribe (required). Supported: MP3, WAV, OGG, FLAC, M4A, WEBM. Max 25 MB." }, { "key": "quality", "value": "basic", "type": "text", "description": "STT quality tier. basic: text only (1ct/min). premium: + word timestamps, SRT/VTT, hotwords (2ct/min). ultra: + speaker diarization, overlap detection, RTTM (3ct/min)" }, { "key": "output_format", "value": "json", "type": "text", "description": "Response format. json: structured JSON (default). srt: SubRip subtitle format. vtt: WebVTT subtitle format. rttm: Rich Transcription Time Marked (ultra only). Only srt/vtt/rttm available with premium or ultra quality." }, { "key": "hotwords", "value": "", "type": "text", "description": "Custom vocabulary hint. Comma-separated list of domain-specific words, names, or technical terms to improve recognition accuracy. Only available with premium or ultra quality. Example: PaperOffice,Datacore,Galera" }, { "key": "priority", "value": "999", "type": "text", "description": "Processing priority: >=900 = sync (waits for result). Default: 999" }, { "key": "locale", "value": "", "type": "text", "description": "Language hint (optional): de, en, es, fr, etc. Empty = auto-detection" }, { "key": "language", "value": "", "type": "text", "description": "Alternative to locale - same functionality. Language code: de, en, es, etc." }, { "key": "min_speakers", "value": "", "type": "text", "description": "Minimum expected speakers (ultra only). Helps diarization accuracy when you know the approximate speaker count." }, { "key": "max_speakers", "value": "", "type": "text", "description": "Maximum expected speakers (ultra only). Helps diarization accuracy when you know the approximate speaker count." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"language\": \"string\",\n \"confidence\": 0,\n \"duration_seconds\": 0,\n \"segments\": [\n {\n \"start\": 0,\n \"end\": 0,\n \"text\": \"string\"\n }\n ]\n }\n }\n}" } ] } ] }, { "name": "📋 Forms", "item": [ { "name": "Create form", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Erstellt ein neues Formular\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Formulars (required)" }, { "key": "fields", "value": "", "type": "text", "description": "Array von Formularfeld-Objekten. Jedes Feld braucht: type (text/number/email/select/checkbox/textarea/date/file/hidden), name (interner Key), label (Anzeige-Text). Optional: required, placeholder, options (bei select), default_value. (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Erstellt ein neues Formular\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Formulars (required)" }, { "key": "fields", "value": "", "type": "text", "description": "Array von Formularfeld-Objekten. Jedes Feld braucht: type (text/number/email/select/checkbox/textarea/date/file/hidden), name (interner Key), label (Anzeige-Text). Optional: required, placeholder, options (bei select), default_value. (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"form_id\": \"string\",\n \"created\": true\n }\n }\n}" } ] }, { "name": "Delete form", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Löscht ein Formular\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "form_id", "value": "", "type": "text", "description": "ID des Formulars" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Löscht ein Formular\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "form_id", "value": "", "type": "text", "description": "ID des Formulars" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"deleted\": true\n }\n }\n}" } ] }, { "name": "Get form", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Details eines Formulars\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "form_id", "value": "", "type": "text", "description": "ID des Formulars" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Details eines Formulars\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "form_id", "value": "", "type": "text", "description": "ID des Formulars" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"form_id\": \"string\",\n \"title\": \"string\",\n \"fields\": [\n {}\n ],\n \"status\": \"string\"\n }\n }\n}" } ] }, { "name": "List forms", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Listet alle Formulare\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Listet alle Formulare\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"forms\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Update form", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Aktualisiert ein Formular\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "form_id", "value": "", "type": "text", "description": "ID des Formulars" }, { "key": "name", "value": "", "type": "text", "description": "Name des Formulars" }, { "key": "fields", "value": "", "type": "text", "description": "JSON Array der Formularfelder" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Aktualisiert ein Formular\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "form_id", "value": "", "type": "text", "description": "ID des Formulars" }, { "key": "name", "value": "", "type": "text", "description": "Name des Formulars" }, { "key": "fields", "value": "", "type": "text", "description": "JSON Array der Formularfelder" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"updated\": true\n }\n }\n}" } ] } ] }, { "name": "✅ Tasks", "item": [ { "name": "Claim task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Übernimmt eine Aufgabe\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Übernimmt eine Aufgabe\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"claimed\": true,\n \"task_id\": \"string\",\n \"claimed_by\": \"string\"\n }\n }\n}" } ] }, { "name": "Complete task", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Markiert eine Aufgabe als erledigt\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Markiert eine Aufgabe als erledigt\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"completed\": true,\n \"task_id\": \"string\",\n \"decision\": \"poai-job_xxx\",\n \"workflow_continued\": true\n }\n }\n}" } ] }, { "name": "Mark Task Read", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Markiert eine Aufgabe als gelesen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Markiert eine Aufgabe als gelesen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"marked\": true,\n \"task_id\": \"string\"\n }\n }\n}" } ] }, { "name": "My tasks", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Listet alle Aufgaben des aktuellen Benutzers\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "", "type": "text", "description": "Filter nach Status" }, { "key": "priority", "value": "", "type": "text", "description": "Filter nach Prioritaet" }, { "key": "step_type", "value": "", "type": "text", "description": "Filter nach Step-Typ (z.B. approval, review, manual_input)" }, { "key": "limit", "value": 50, "type": "text", "description": "Max. Tasks" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Listet alle Aufgaben des aktuellen Benutzers\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "", "type": "text", "description": "Filter nach Status" }, { "key": "priority", "value": "", "type": "text", "description": "Filter nach Prioritaet" }, { "key": "step_type", "value": "", "type": "text", "description": "Filter nach Step-Typ (z.B. approval, review, manual_input)" }, { "key": "limit", "value": 50, "type": "text", "description": "Max. Tasks" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"tasks\": [\n {\n \"task_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"status\": \"pending\",\n \"priority\": \"string\",\n \"workflow_id\": \"string\",\n \"created_at\": \"string\",\n \"due_date\": \"string\"\n }\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Task details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Details einer Aufgabe\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Details einer Aufgabe\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_id", "value": "", "type": "text", "description": "ID der Aufgabe" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"task_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"workflow_id\": \"string\",\n \"document_pofid\": \"string\",\n \"form_data\": {},\n \"created_at\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📅 Calendar/Events", "item": [ { "name": "Create event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Event Create a new calendar event. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | title | string | ✅ | Event title | | start | string | ✅ | Start time ISO 8601 | | end | string | ✅ | End time ISO 8601 | | description | string ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "", "type": "text", "description": "Titel des Events (Pflichtfeld) (required)" }, { "key": "start_time", "value": "", "type": "text", "description": "Startzeit im ISO-8601 Format (z.B. 2026-03-20T10:00:00Z) (required)" }, { "key": "start_datetime", "value": "", "type": "text", "description": "Startzeit als Alias fuer start_time" }, { "key": "end_time", "value": "", "type": "text", "description": "Endzeit. Standard: start + 1 Stunde" }, { "key": "end_datetime", "value": "", "type": "text", "description": "Endzeit als Alias fuer end_time" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Events" }, { "key": "location", "value": "", "type": "text", "description": "Ort des Events" }, { "key": "metadata", "value": "", "type": "text", "description": "Beliebige Zusatzdaten als JSON-Objekt" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Event Create a new calendar event. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | title | string | ✅ | Event title | | start | string | ✅ | Start time ISO 8601 | | end | string | ✅ | End time ISO 8601 | | description | string ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "", "type": "text", "description": "Titel des Events (Pflichtfeld) (required)" }, { "key": "start_time", "value": "", "type": "text", "description": "Startzeit im ISO-8601 Format (z.B. 2026-03-20T10:00:00Z) (required)" }, { "key": "start_datetime", "value": "", "type": "text", "description": "Startzeit als Alias fuer start_time" }, { "key": "end_time", "value": "", "type": "text", "description": "Endzeit. Standard: start + 1 Stunde" }, { "key": "end_datetime", "value": "", "type": "text", "description": "Endzeit als Alias fuer end_time" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Events" }, { "key": "location", "value": "", "type": "text", "description": "Ort des Events" }, { "key": "metadata", "value": "", "type": "text", "description": "Beliebige Zusatzdaten als JSON-Objekt" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"event_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"location\": \"string\",\n \"attendees\": [\n \"string\"\n ],\n \"status\": \"string\"\n }\n }\n}" } ] }, { "name": "Delete event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete Event Delete a calendar event.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Numerische Event-ID (required)" }, { "key": "id", "value": "", "type": "text", "description": "Alias fuer event_id" }, { "key": "uuid", "value": "", "type": "text", "description": "UUID des Events (Alternative zur numerischen ID)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete Event Delete a calendar event.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Numerische Event-ID (required)" }, { "key": "id", "value": "", "type": "text", "description": "Alias fuer event_id" }, { "key": "uuid", "value": "", "type": "text", "description": "UUID des Events (Alternative zur numerischen ID)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"deleted\": true,\n \"event_id\": \"string\"\n }\n }\n}" } ] }, { "name": "Get event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Single Event Retrieve details of a specific event.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Query parameter: event_id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Single Event Retrieve details of a specific event.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Query parameter: event_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"event_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"location\": \"string\",\n \"attendees\": [\n \"string\"\n ],\n \"status\": \"string\"\n }\n }\n}" } ] }, { "name": "List events", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Calendar Events Retrieve events within a date range. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | start | string | ✅ | Start date ISO 8601 | | end | string | ✅ | End date ISO 8601 |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "start", "value": "", "type": "text", "description": "Start date (ISO 8601)" }, { "key": "end", "value": "", "type": "text", "description": "End date (ISO 8601)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Calendar Events Retrieve events within a date range. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | start | string | ✅ | Start date ISO 8601 | | end | string | ✅ | End date ISO 8601 |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "start", "value": "", "type": "text", "description": "Start date (ISO 8601)" }, { "key": "end", "value": "", "type": "text", "description": "End date (ISO 8601)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"events\": [\n {\n \"event_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"location\": \"string\",\n \"attendees\": [\n null\n ],\n \"status\": \"string\"\n }\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Search events", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Search Events Search calendar events by keyword.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "q", "value": "", "type": "text", "description": "Search query" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Search Events Search calendar events by keyword.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "q", "value": "", "type": "text", "description": "Search query" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"events\": [\n {\n \"event_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"location\": \"string\",\n \"attendees\": [\n null\n ],\n \"status\": \"string\"\n }\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Upcoming events", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Upcoming Events Get upcoming events.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "days", "value": 7, "type": "text", "description": "Anzahl Tage in die Zukunft (1-365)" }, { "key": "limit", "value": 10, "type": "text", "description": "Maximale Anzahl Events (1-100)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Upcoming Events Get upcoming events.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "days", "value": 7, "type": "text", "description": "Anzahl Tage in die Zukunft (1-365)" }, { "key": "limit", "value": 10, "type": "text", "description": "Maximale Anzahl Events (1-100)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"events\": [\n {\n \"event_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"location\": \"string\",\n \"attendees\": [\n null\n ],\n \"status\": \"string\"\n }\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Update event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Update Event Update an existing calendar event.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Numerische Event-ID (oder id/uuid) (required)" }, { "key": "id", "value": "", "type": "text", "description": "Alias fuer event_id" }, { "key": "uuid", "value": "", "type": "text", "description": "UUID des Events (Alternative zur numerischen ID)" }, { "key": "title", "value": "", "type": "text", "description": "Neuer Titel des Events" }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung" }, { "key": "location", "value": "", "type": "text", "description": "Neuer Ort" }, { "key": "status", "value": "", "type": "text", "description": "Neuer Status" }, { "key": "cancellation_reason", "value": "", "type": "text", "description": "Stornierungsgrund (nur bei status=cancelled)" }, { "key": "start_datetime", "value": "", "type": "text", "description": "Neue Startzeit (ISO-8601)" }, { "key": "end_datetime", "value": "", "type": "text", "description": "Neue Endzeit (ISO-8601)" }, { "key": "timezone", "value": "", "type": "text", "description": "Zeitzone (z.B. Europe/Berlin)" }, { "key": "rating_score", "value": "", "type": "text", "description": "Bewertung 1-5" }, { "key": "rating_feedback", "value": "", "type": "text", "description": "Feedback-Text zur Bewertung" }, { "key": "crm_lead_id", "value": "", "type": "text", "description": "CRM Lead-ID fuer Verknuepfung" }, { "key": "crm_contact_id", "value": "", "type": "text", "description": "CRM Contact-ID fuer Verknuepfung" }, { "key": "crm_account_id", "value": "", "type": "text", "description": "CRM Account-ID fuer Verknuepfung" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Update Event Update an existing calendar event.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Numerische Event-ID (oder id/uuid) (required)" }, { "key": "id", "value": "", "type": "text", "description": "Alias fuer event_id" }, { "key": "uuid", "value": "", "type": "text", "description": "UUID des Events (Alternative zur numerischen ID)" }, { "key": "title", "value": "", "type": "text", "description": "Neuer Titel des Events" }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung" }, { "key": "location", "value": "", "type": "text", "description": "Neuer Ort" }, { "key": "status", "value": "", "type": "text", "description": "Neuer Status" }, { "key": "cancellation_reason", "value": "", "type": "text", "description": "Stornierungsgrund (nur bei status=cancelled)" }, { "key": "start_datetime", "value": "", "type": "text", "description": "Neue Startzeit (ISO-8601)" }, { "key": "end_datetime", "value": "", "type": "text", "description": "Neue Endzeit (ISO-8601)" }, { "key": "timezone", "value": "", "type": "text", "description": "Zeitzone (z.B. Europe/Berlin)" }, { "key": "rating_score", "value": "", "type": "text", "description": "Bewertung 1-5" }, { "key": "rating_feedback", "value": "", "type": "text", "description": "Feedback-Text zur Bewertung" }, { "key": "crm_lead_id", "value": "", "type": "text", "description": "CRM Lead-ID fuer Verknuepfung" }, { "key": "crm_contact_id", "value": "", "type": "text", "description": "CRM Contact-ID fuer Verknuepfung" }, { "key": "crm_account_id", "value": "", "type": "text", "description": "CRM Account-ID fuer Verknuepfung" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"event_id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"location\": \"string\",\n \"attendees\": [\n \"string\"\n ],\n \"status\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "💳 Billing", "item": [ { "name": "Pricing Plaene & Tiers", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/billing/pricing/tiers", "host": [ "{{base_url}}" ], "path": [ "billing", "pricing", "tiers" ] }, "description": "Zeigt alle verfuegbaren PaperOffice-Preisplaene (Tiers) mit Preisen, Credits, Features und Details. Ideal fuer Preisvergleiche und Empfehlungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/billing/pricing/tiers", "host": [ "{{base_url}}" ], "path": [ "billing", "pricing", "tiers" ] }, "description": "Zeigt alle verfuegbaren PaperOffice-Preisplaene (Tiers) mit Preisen, Credits, Features und Details. Ideal fuer Preisvergleiche und Empfehlungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"refill_options\": [\n \"string\"\n ],\n \"source\": \"string\",\n \"status\": \"string\",\n \"tiers\": {\n \"VPN\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0,\n \"_fix_note\": \"string\"\n }\n },\n \"VISITOR\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0,\n \"_fix_note\": \"string\"\n }\n },\n \"APP-LITE\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"downgrade_from\": \"string\",\n \"tab\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n }\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_fix_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"APP-FREE\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"trial_days\": 0,\n \"downgrade_to\": \"string\",\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_fix_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T1\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_fix_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T2\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"badge\": \"string\",\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T3\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T4\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"extra_discount_percent\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true,\n \"realtime_webhooks\": true\n }\n },\n \"APP-T5\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"extra_discount_percent\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"badge\": \"string\",\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true,\n \"custom_contracts\": true,\n \"data_residency\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true,\n \"realtime_webhooks\": true\n }\n },\n \"APP-T6\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"extra_discount_percent\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"badge\": \"string\",\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"user_accounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n },\n \"workers\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"_note\": \"string\"\n },\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"base_cost_eur\": 0,\n \"cost_eur_with_discount\": 0,\n \"_note\": \"string\"\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true,\n \"custom_contracts\": true,\n \"data_residency\": true,\n \"dedicated_tam\": true,\n \"white_glove_onboarding\": true,\n \"quarterly_business_reviews\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": 0,\n \"allow_additional\": true,\n \"cost_per_additional_credits\": 0\n },\n \"storage_modes\": {\n \"import\": true,\n \"crawl\": true,\n \"user_storage\": true\n },\n \"connector_types\": {\n \"sftp\": true\n },\n \"rate_limits\": {\n \"files_per_day\": 0,\n \"_note\": \"string\"\n },\n \"polling\": {\n \"min_interval_seconds\": 0\n },\n \"after_import\": [\n \"string\"\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true,\n \"realtime_webhooks\": true\n }\n },\n \"API-T1\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T2\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"badge\": \"string\",\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T3\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T4\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"badge\": \"string\",\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T5\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"badge\": \"string\",\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"SLA-T1\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"availability\": \"string\",\n \"availability_hours\": {\n \"start\": \"string\",\n \"end\": \"string\",\n \"days\": [\n \"string\"\n ],\n \"timezone\": \"string\"\n },\n \"direct_access\": {\n \"direct_email\": true,\n \"direct_phone\": true,\n \"ticket_system\": true\n },\n \"channels\": [\n \"string\"\n ],\n \"support_level\": 0,\n \"support_level_name\": \"string\",\n \"dedicated_manager\": true\n },\n \"SLA-T2\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"availability\": \"string\",\n \"availability_hours\": {\n \"start\": \"string\",\n \"end\": \"string\",\n \"days\": [\n \"string\"\n ],\n \"timezone\": \"string\"\n },\n \"direct_access\": {\n \"direct_email\": true,\n \"direct_phone\": true,\n \"ticket_system\": true\n },\n \"channels\": [\n \"string\"\n ],\n \"support_level\": 0,\n \"support_level_name\": \"string\",\n \"dedicated_manager\": true,\n \"uptime_sla\": \"string\",\n \"incident_reports\": \"string\"\n },\n \"SLA-T3\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"availability\": \"string\",\n \"availability_hours\": {\n \"start\": \"string\",\n \"end\": \"string\",\n \"days\": [\n \"string\"\n ],\n \"timezone\": \"string\"\n },\n \"direct_access\": {\n \"direct_email\": true,\n \"direct_phone\": true,\n \"ticket_system\": true\n },\n \"channels\": [\n \"string\"\n ],\n \"support_level\": 0,\n \"support_level_name\": \"string\",\n \"dedicated_manager\": true,\n \"dedicated_manager_type\": \"string\",\n \"uptime_sla\": \"string\",\n \"incident_reports\": \"string\"\n }\n }\n}" } ] }, { "name": "Pricing Calculator (Komplett)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/billing/pricing/all", "host": [ "{{base_url}}" ], "path": [ "billing", "pricing", "all" ] }, "description": "Liefert ALLE Pricing-Daten: Tiers, Job-Kosten, Overage-System, Storage-Preise, Priority-System, Support-Units und Calculator-Services. Ideal fuer umfassende Kostenanalysen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/billing/pricing/all", "host": [ "{{base_url}}" ], "path": [ "billing", "pricing", "all" ] }, "description": "Liefert ALLE Pricing-Daten: Tiers, Job-Kosten, Overage-System, Storage-Preise, Priority-System, Support-Units und Calculator-Services. Ideal fuer umfassende Kostenanalysen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cache_ttl\": 0,\n \"data\": {\n \"job_costs\": {\n \"business_intelligence___generate_report\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"chatwidget___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"compliance___generate_dpa\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___ai_suggest\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___auto_categorize\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___score_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"hitl___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___start_stream\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"internal___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"knowledge___ai_summary\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"knowledge___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"lead_scoring___score_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"substitutes___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___batch\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___single\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___all\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___email\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___phone\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___website\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"vat___rates\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_ai___generate_workflow\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___get_authtoken\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___profile___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___profile___update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___restore\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___attachment_upload\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___chat_message\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"paperoffice_agent___embedding\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___message_tokens\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"paperoffice_agent___storage_mb\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"text\": true,\n \"voice\": true,\n \"images\": true,\n \"vision\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"price_per_minute_cents\": 0\n },\n \"paperoffice_agent___ultra_pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"text\": true,\n \"voice\": true,\n \"images\": true,\n \"vision\": true,\n \"thinking\": true,\n \"ai_reasoning\": true,\n \"priority_processing\": true\n },\n \"price_per_minute_cents\": 0\n },\n \"paperoffice_agent___ultra_pro_max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"text\": true,\n \"voice\": true,\n \"images\": true,\n \"vision\": true,\n \"thinking\": true,\n \"ai_reasoning\": true,\n \"priority_processing\": true,\n \"extended_context\": true,\n \"mission_critical\": true\n },\n \"price_per_minute_cents\": 0\n },\n \"paperoffice_agent___voice_minute\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"analytics___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"anonymization___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___at_risk\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___insights\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___opportunities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___sentiment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___image_embeddings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___knowledge_graph\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___summary\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___vision\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___auto_reply_check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"leadscore___analyze\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"rag___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_ai_insights\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___languages\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bank___auto_match\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bank___details\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bunq___check_payment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bunq___payments\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bunq___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___invoices\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___invoices___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___invoices___pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___payment_methods\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___pricing___calculator\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"billing___pricing___jobs\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"billing___pricing___plans\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"billing___revolut___check_payment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___revolut___payments\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___revolut___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___cancel\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___change\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___checkout\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___portal\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___setup_products\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___usage\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___usage___history\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___archive_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___convert_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___create_activity\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___create_contact\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___create_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___dashboard\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___delete_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___disqualify_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_account\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_case\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_contact\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_related_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_session_pricing\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_settings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_accounts\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_activities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_contacts\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_leads\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_opportunities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___pipeline\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___restore_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___save_settings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___send_session_payment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___update_activity\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___update_contact\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___update_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_compress\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_merge\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_metadata\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_rotate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_split\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agent_delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agent_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agent_put\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agents_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_binaries_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_copy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_edit\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_move\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_put\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"semantic_search\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"hybrid_search\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n }\n }\n },\n \"documents___document_thumb_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___documents_export\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___documents_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___ocr_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___processing_dashboard_stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"storage___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"fakeemail___add_domain\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"fakeemail___check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"fakeemail___check_bulk\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_emails_per_request\": 0\n },\n \"fakeemail___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"image___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_imagestudio___generate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_imagestudio___generate___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_resolution\": \"string\"\n },\n \"paperoffice_imagestudio___generate___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_resolution\": \"string\"\n },\n \"paperoffice_imagestudio___generate___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_resolution\": \"string\"\n },\n \"paperoffice_imagestudio___remove_bg\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___cancel\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___files\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___jobs_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___request_upload_url\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___retry\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___scan\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___start\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___upload_local_files\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___upload_source\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___countrylist\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___device\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___exchangecurrency\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___fingerprint\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___full\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___ip\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___location\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___vpn\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___weather\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___weathericon_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"harvester_document_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"harvester_entity_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"harvester_llm_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"knowledge_graph_ask\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_canonical_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_cluster\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_document\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_merge_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_mermaid\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_query\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_topic_details\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_topic_summary\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_topics\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_workspace\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"paperoffice_llm___addons\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"include_reasoning\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_confidence\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_alternatives\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"strict_validation\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"multi_language\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n }\n }\n },\n \"paperoffice_llm___generate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_llm___generate___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___basic-pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___basic-pro-max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___premium-pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___premium-pro-max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___ultra-pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___ultra-pro-max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___model_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"maptiles___style\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"maptiles___tile\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"maptiles___tiles\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_aiocr___generate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"ocr_premium\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_ultra\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_grid_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_complete_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_bounding_boxes_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_full_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n }\n },\n \"tiers\": {\n \"basic\": \"string\",\n \"premium\": \"string\",\n \"ultra\": \"string\"\n },\n \"ocr_mode_aliases\": {\n \"basic\": \"string\",\n \"premium\": \"string\",\n \"ultra\": \"string\"\n }\n },\n \"paperoffice_aiocr___generate___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"paperoffice_aiocr___generate___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"convert___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___compress_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___docx_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___ebook_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___edit_metadata_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___email_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___image_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___lock_with_password_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___merge_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___organize_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_excel\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_image\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_pdfa\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_powerpoint\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_word\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pptx_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___remove_restrictions_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___rotate_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___split_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___unlock_with_password_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___url_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___whitepage_scan\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___xlsx_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___xml_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"web2pdf___url_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"esignatures___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_sign___signature\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"price_cents\": 0\n },\n \"paperoffice_sign___signature_request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"paperoffice_sms___send\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"agent_templates___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"agent_templates___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"agent_templates___system_prompt\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___admin_action\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___available\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___book\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___holidays\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___rate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___slots\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"booking___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"booking___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"booking___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___cloud_providers-config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___cloud_providers-download\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___cloud_providers-oauth_callback\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___download\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___dropbox\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___gdrive\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___oauth_callback\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___onedrive\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"compliance___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"contracts___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___document_links\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"currency___exchange\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"demo_files\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"docs___markdown\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"docs___openapi\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"docs___postman\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___embeddings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___meta_fields\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___ocr\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___publisher\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___publishers\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___revisions\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___topics\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documentation\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_download\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_restore\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_add_document\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_dissolve\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_meta_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_meta_set\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_remove_document\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___idp_collections_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___similar\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___trash_empty\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___trash_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___trash_settings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspace_storage_health\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_clear\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"download___demo\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"events___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"faq___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"forms___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"geocoding___batch\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"geocoding___forward\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"health\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___add_note\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___assign_ticket\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___create_ticket\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___dashboard\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___get_config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___get_messages\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___get_ticket\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___list_tickets\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___resolve_action\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___send_reply\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___update_priority\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___update_status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"hotel___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"job___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"free_polls_per_minute\": 0\n },\n \"job___model_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"job___pricelist\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"job___voices_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"leadscore___result\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"leadscore___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"letters___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"location2weather\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___initialize\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/call\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/intents\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/schema\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"meeting___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"message___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"model_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"orders___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ping\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"portal___access\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"portal___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"publishers___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"publishers___top\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___insights\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"security___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"signature_notifications___send\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___action\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___book_presales\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___history\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___presales\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___purchase\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___units\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___use\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___validate_token\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___webhook\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"sync___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"tasks___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"telegram___check_link_status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"telegram___generate_link\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"telegram___unlink\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___get_supported_languages\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___translate_batch\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___translate_single\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___activity\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___add_member\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___get_members\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___get_user_groups\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___remove_member\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"vat___validate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"vehicles___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"voices_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___categories\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___collections\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___grouped\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___nodes\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___outputs\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___voices_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"include_reasoning\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_sender\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_bounding_boxes\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_confidence_scores\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_enhanced\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"handwriting_recognition\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"_comment_ocr_tiers\": \"string\",\n \"ocr_tier_basic\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_tier_premium\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_tier_ultra\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_tier_text_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_tier_grid_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"ocr_tier_complete_legacy\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n }\n }\n },\n \"workflow___pdf_ai_split\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"include_document_type\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_date\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_sender\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n },\n \"include_reasoning\": {\n \"credits\": null,\n \"unit\": null,\n \"description\": null,\n \"request_param\": null,\n \"applies_when\": null\n }\n }\n }\n },\n \"tiers\": {\n \"VPN\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0,\n \"_fix_note\": \"string\"\n }\n },\n \"VISITOR\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0,\n \"_fix_note\": \"string\"\n }\n },\n \"APP-LITE\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"downgrade_from\": \"string\",\n \"tab\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n }\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_fix_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"APP-FREE\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"trial_days\": 0,\n \"downgrade_to\": \"string\",\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_fix_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T1\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_fix_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T2\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"badge\": \"string\",\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T3\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"price_yearly\": 0,\n \"included_storage_pages\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true\n }\n },\n \"APP-T4\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"extra_discount_percent\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true,\n \"realtime_webhooks\": true\n }\n },\n \"APP-T5\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"extra_discount_percent\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"badge\": \"string\",\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true,\n \"custom_contracts\": true,\n \"data_residency\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true,\n \"realtime_webhooks\": true\n }\n },\n \"APP-T6\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"included_storage_pages\": 0,\n \"extra_discount_percent\": 0,\n \"tab\": \"string\",\n \"tab_position\": 0,\n \"badge\": \"string\",\n \"support\": \"string\",\n \"sla\": \"string\",\n \"resources\": {\n \"workspaces\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"user_accounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n },\n \"workers\": {\n \"included\": null,\n \"allow_additional\": null,\n \"_note\": null\n },\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"base_cost_eur\": null,\n \"cost_eur_with_discount\": null,\n \"_note\": null\n }\n },\n \"features\": {\n \"all_ai_functions\": true,\n \"api_access\": true,\n \"webhooks\": true,\n \"custom_integrations\": true,\n \"trust_center\": true,\n \"sso_saml\": true,\n \"audit_logs\": true,\n \"custom_contracts\": true,\n \"data_residency\": true,\n \"dedicated_tam\": true,\n \"white_glove_onboarding\": true,\n \"quarterly_business_reviews\": true\n },\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0,\n \"_note\": \"string\"\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n },\n \"crawler\": {\n \"storage_mounts\": {\n \"included\": null,\n \"allow_additional\": null,\n \"cost_per_additional_credits\": null\n },\n \"storage_modes\": {\n \"import\": null,\n \"crawl\": null,\n \"user_storage\": null\n },\n \"connector_types\": {\n \"sftp\": null\n },\n \"rate_limits\": {\n \"files_per_day\": null,\n \"_note\": null\n },\n \"polling\": {\n \"min_interval_seconds\": null\n },\n \"after_import\": [\n null\n ],\n \"file_pattern\": true,\n \"recursive\": true,\n \"primary_secondary_redundancy\": true,\n \"realtime_webhooks\": true\n }\n },\n \"API-T1\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T2\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"badge\": \"string\",\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T3\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T4\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"badge\": \"string\",\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"API-T5\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"badge\": \"string\",\n \"rate_limits\": {\n \"requests_per_second\": 0,\n \"requests_per_minute\": 0,\n \"requests_per_hour\": 0,\n \"requests_per_day\": 0\n },\n \"queue_limits\": {\n \"max_concurrent_jobs\": 0,\n \"max_queued_jobs\": 0,\n \"max_queued_credits\": 0,\n \"queue_timeout_minutes\": 0\n }\n },\n \"SLA-T1\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"availability\": \"string\",\n \"availability_hours\": {\n \"start\": \"string\",\n \"end\": \"string\",\n \"days\": [\n null\n ],\n \"timezone\": \"string\"\n },\n \"direct_access\": {\n \"direct_email\": true,\n \"direct_phone\": true,\n \"ticket_system\": true\n },\n \"channels\": [\n \"string\"\n ],\n \"support_level\": 0,\n \"support_level_name\": \"string\",\n \"dedicated_manager\": true\n },\n \"SLA-T2\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"availability\": \"string\",\n \"availability_hours\": {\n \"start\": \"string\",\n \"end\": \"string\",\n \"days\": [\n null\n ],\n \"timezone\": \"string\"\n },\n \"direct_access\": {\n \"direct_email\": true,\n \"direct_phone\": true,\n \"ticket_system\": true\n },\n \"channels\": [\n \"string\"\n ],\n \"support_level\": 0,\n \"support_level_name\": \"string\",\n \"dedicated_manager\": true,\n \"uptime_sla\": \"string\",\n \"incident_reports\": \"string\"\n },\n \"SLA-T3\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"credits_monthly\": 0,\n \"overage_factor\": 0,\n \"price_monthly\": 0,\n \"is_paid\": true,\n \"default_priority\": 0,\n \"identification_method\": \"string\",\n \"vpn_allowed\": true,\n \"availability\": \"string\",\n \"availability_hours\": {\n \"start\": \"string\",\n \"end\": \"string\",\n \"days\": [\n null\n ],\n \"timezone\": \"string\"\n },\n \"direct_access\": {\n \"direct_email\": true,\n \"direct_phone\": true,\n \"ticket_system\": true\n },\n \"channels\": [\n \"string\"\n ],\n \"support_level\": 0,\n \"support_level_name\": \"string\",\n \"dedicated_manager\": true,\n \"dedicated_manager_type\": \"string\",\n \"uptime_sla\": \"string\",\n \"incident_reports\": \"string\"\n }\n },\n \"overage_system\": {\n \"_internal_description\": \"string\",\n \"_note_multiplier\": \"string\",\n \"_formula\": \"string\",\n \"_formula_credits\": \"string\",\n \"_formula_note\": \"string\",\n \"refill_options\": [\n \"string\"\n ],\n \"overage_factors_per_tier\": {\n \"APP-T1\": {\n \"factor\": 0,\n \"label\": \"string\",\n \"tier_name\": \"string\"\n },\n \"APP-T2\": {\n \"factor\": 0,\n \"label\": \"string\",\n \"tier_name\": \"string\"\n },\n \"APP-T3\": {\n \"factor\": 0,\n \"label\": \"string\",\n \"tier_name\": \"string\"\n },\n \"APP-T4\": {\n \"factor\": 0,\n \"label\": \"string\",\n \"tier_name\": \"string\"\n },\n \"APP-T5\": {\n \"factor\": 0,\n \"label\": \"string\",\n \"tier_name\": \"string\"\n }\n },\n \"default_factor\": 0,\n \"examples\": {\n \"APP-T1_Starter_5eur_5000cr\": {\n \"plan_price\": 0,\n \"plan_credits\": 0,\n \"overage_factor\": 0,\n \"25_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"50_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"75_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"100_pct\": {\n \"credits\": null,\n \"price_eur\": null\n }\n },\n \"APP-T2_Professional_50eur_50000cr\": {\n \"plan_price\": 0,\n \"plan_credits\": 0,\n \"overage_factor\": 0,\n \"25_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"50_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"75_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"100_pct\": {\n \"credits\": null,\n \"price_eur\": null\n }\n },\n \"APP-T3_Corporate_500eur_500000cr\": {\n \"plan_price\": 0,\n \"plan_credits\": 0,\n \"overage_factor\": 0,\n \"25_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"50_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"75_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"100_pct\": {\n \"credits\": null,\n \"price_eur\": null\n }\n },\n \"APP-T4_Enterprise_5000eur_5000000cr\": {\n \"plan_price\": 0,\n \"plan_credits\": 0,\n \"overage_factor\": 0,\n \"25_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"50_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"75_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"100_pct\": {\n \"credits\": null,\n \"price_eur\": null\n }\n },\n \"APP-T5_Unlimited_15000eur_15000000cr\": {\n \"plan_price\": 0,\n \"plan_credits\": 0,\n \"overage_factor\": 0,\n \"25_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"50_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"75_pct\": {\n \"credits\": null,\n \"price_eur\": null\n },\n \"100_pct\": {\n \"credits\": null,\n \"price_eur\": null\n }\n }\n },\n \"features\": {\n \"purchased_credits_expire\": true,\n \"auto_refill_available\": true,\n \"max_refill_amount_eur\": \"string\",\n \"stripe_payment\": true\n },\n \"limits\": {\n \"default_max_per_cycle\": \"string\",\n \"unlimited_tiers\": [\n \"string\"\n ],\n \"_note\": \"string\"\n }\n },\n \"storage_pricing\": {\n \"_internal_description\": \"string\",\n \"_note_rounding\": \"string\",\n \"_note_not_degressive\": \"string\",\n \"billing_unit\": 0,\n \"billing_unit_label\": \"string\",\n \"tiers\": {\n \"storage_only\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"cost_eur_per_1k_pages\": 0,\n \"cost_credits_per_1k_pages\": 0,\n \"features\": [\n null\n ],\n \"multiplier\": 0\n },\n \"basic\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"cost_eur_per_1k_pages\": 0,\n \"cost_credits_per_1k_pages\": 0,\n \"features\": [\n null\n ],\n \"multiplier\": 0\n },\n \"premium\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"cost_eur_per_1k_pages\": 0,\n \"cost_credits_per_1k_pages\": 0,\n \"features\": [\n null\n ],\n \"multiplier\": 0\n },\n \"ultra\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"cost_eur_per_1k_pages\": 0,\n \"cost_credits_per_1k_pages\": 0,\n \"features\": [\n null\n ],\n \"multiplier\": 0\n }\n },\n \"included_storage_pages\": {\n \"_internal_description\": \"string\",\n \"_base_tier\": \"string\",\n \"APP-LITE\": 0,\n \"APP-FREE\": 0,\n \"APP-T1\": 0,\n \"APP-T2\": 0,\n \"APP-T3\": 0,\n \"APP-T4\": 0,\n \"APP-T5\": 0\n },\n \"workspace_document_limits\": {\n \"_internal_description\": \"string\",\n \"APP-FREE\": 0,\n \"APP-LITE\": 0,\n \"APP-T1\": \"string\",\n \"APP-T2\": \"string\",\n \"APP-T3\": \"string\",\n \"APP-T4\": \"string\",\n \"APP-T5\": \"string\"\n }\n },\n \"resource_billing\": {\n \"_internal_description\": \"string\",\n \"_note_degressive\": \"string\",\n \"degressive_discount_by_tier\": {\n \"APP-FREE\": 0,\n \"APP-LITE\": 0,\n \"APP-T1\": 0,\n \"APP-T2\": 0,\n \"APP-T3\": 0,\n \"APP-T4\": 0,\n \"APP-T5\": 0\n },\n \"workspace\": {\n \"base_cost_eur_monthly\": 0,\n \"base_cost_credits_monthly\": 0,\n \"billing_method\": \"string\",\n \"_price_by_tier\": {\n \"T1\": \"string\",\n \"T2\": \"string\",\n \"T3\": \"string\",\n \"T4\": \"string\",\n \"T5\": \"string\"\n }\n },\n \"user_account\": {\n \"base_cost_eur_monthly\": 0,\n \"base_cost_credits_monthly\": 0,\n \"billing_method\": \"string\",\n \"_price_by_tier\": {\n \"T1\": \"string\",\n \"T2\": \"string\",\n \"T3\": \"string\",\n \"T4\": \"string\",\n \"T5\": \"string\"\n }\n },\n \"storage_mount\": {\n \"base_cost_eur_monthly\": 0,\n \"base_cost_credits_monthly\": 0,\n \"billing_method\": \"string\",\n \"_price_by_tier\": {\n \"T1\": \"string\",\n \"T2\": \"string\",\n \"T3\": \"string\",\n \"T4\": \"string\",\n \"T5\": \"string\"\n }\n },\n \"billing_schedule\": {\n \"frequency\": \"string\",\n \"trigger\": \"string\",\n \"cronjob\": \"string\"\n }\n },\n \"priority_system\": {\n \"_internal_description\": \"string\",\n \"_philosophy\": \"string\",\n \"_formula\": \"string\",\n \"_formula_note\": \"string\",\n \"_overswap_note\": \"string\",\n \"levels\": {\n \"900\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"800\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"700\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"600\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"500\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"400\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"300\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true\n },\n \"200\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true,\n \"plan_default\": \"string\"\n },\n \"150\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true,\n \"plan_default\": \"string\"\n },\n \"100\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true,\n \"plan_default\": \"string\"\n },\n \"50\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true,\n \"plan_default\": \"string\"\n },\n \"0\": {\n \"mode\": \"string\",\n \"sla_label\": \"string\",\n \"sla_seconds\": 0,\n \"min_priority\": 0,\n \"max_priority\": 0,\n \"lane\": \"string\",\n \"cloud_overswap\": true,\n \"plan_default\": \"string\"\n }\n },\n \"boost_examples\": {\n \"_note\": \"string\",\n \"P0_to_P300\": {\n \"delta\": 0,\n \"multiplier\": 0,\n \"description\": \"string\"\n },\n \"P0_to_P500\": {\n \"delta\": 0,\n \"multiplier\": 0,\n \"description\": \"string\"\n },\n \"P0_to_P700\": {\n \"delta\": 0,\n \"multiplier\": 0,\n \"description\": \"string\"\n },\n \"_note_starter\": \"string\",\n \"P50_to_P300\": {\n \"delta\": 0,\n \"multiplier\": 0,\n \"description\": \"string\"\n },\n \"P50_to_P500\": {\n \"delta\": 0,\n \"multiplier\": 0,\n \"description\": \"string\"\n }\n },\n \"anti_starvation\": {\n \"_description\": \"string\",\n \"enabled\": true,\n \"max_wait_hours\": 0,\n \"rescue_priority\": 0\n },\n \"note\": \"string\"\n },\n \"support_units\": {\n \"_internal_description\": \"string\",\n \"unit_definition\": {\n \"duration_minutes\": 0,\n \"levels\": [\n \"string\"\n ],\n \"channels\": [\n \"string\"\n ],\n \"price_eur\": 0,\n \"price_credits\": 0\n },\n \"included_by_plan\": {\n \"_note\": \"string\",\n \"APP-LITE\": 0,\n \"APP-FREE\": 0,\n \"APP-T1\": 0,\n \"APP-T2\": 0,\n \"APP-T3\": 0,\n \"APP-T4\": 0,\n \"APP-T5\": 0\n },\n \"presales_pricing\": {\n \"_note\": \"string\",\n \"consultation_15min\": {\n \"name\": \"string\",\n \"duration_minutes\": 0,\n \"price_eur\": 0,\n \"description\": \"string\"\n },\n \"demo_30min\": {\n \"name\": \"string\",\n \"duration_minutes\": 0,\n \"price_eur\": 0,\n \"description\": \"string\"\n },\n \"demo_60min\": {\n \"name\": \"string\",\n \"duration_minutes\": 0,\n \"price_eur\": 0,\n \"description\": \"string\"\n }\n },\n \"qualification_thresholds\": {\n \"_note\": \"string\",\n \"A\": {\n \"min_score\": 0,\n \"demo\": \"string\",\n \"consultation\": \"string\"\n },\n \"B\": {\n \"min_score\": 0,\n \"demo\": \"string\",\n \"consultation\": \"string\"\n },\n \"C\": {\n \"min_score\": 0,\n \"demo\": \"string\",\n \"consultation\": \"string\"\n },\n \"D\": {\n \"min_score\": 0,\n \"demo\": \"string\",\n \"consultation\": \"string\"\n }\n },\n \"booking_rules\": {\n \"terminwunsch_not_confirmation\": true,\n \"confirmation_after_review\": true,\n \"confirmation_via_email\": true,\n \"min_hours_ahead\": 0\n }\n },\n \"meta\": {\n \"description\": \"string\",\n \"last_updated\": \"string\",\n \"version\": \"string\",\n \"cache_key\": \"string\",\n \"note\": \"string\",\n \"pricing_rule\": \"string\",\n \"_internal_description\": \"string\",\n \"plan_structure\": {\n \"enduser_tab\": [\n \"string\"\n ],\n \"business_tab\": [\n \"string\"\n ]\n },\n \"pricing_philosophy\": {\n \"no_discounts\": \"string\",\n \"feature_upgrades\": \"string\",\n \"predictable\": \"string\",\n \"api_first\": \"string\",\n \"minimum_cost\": \"string\"\n },\n \"queue_limits_explanation\": \"string\"\n },\n \"calculator_services\": [\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"icon\": \"string\",\n \"sort_order\": 0,\n \"services\": [\n {\n \"key\": null,\n \"label\": null,\n \"credits\": null,\n \"credits_display\": null,\n \"unit\": null,\n \"unit_display\": null,\n \"unit_label\": null,\n \"description\": null\n }\n ]\n }\n ]\n },\n \"lang\": \"string\",\n \"processing_time\": \"string\",\n \"source\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "API-Job-Kosten pro Service", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/billing/pricing/jobs", "host": [ "{{base_url}}" ], "path": [ "billing", "pricing", "jobs" ] }, "description": "Zeigt die Credit-Kosten fuer jeden einzelnen API-Service (OCR, LLM, Voice, Import, etc.) mit optionalem Kategorie-Filter.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/billing/pricing/jobs", "host": [ "{{base_url}}" ], "path": [ "billing", "pricing", "jobs" ] }, "description": "Zeigt die Credit-Kosten fuer jeden einzelnen API-Service (OCR, LLM, Voice, Import, etc.) mit optionalem Kategorie-Filter.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobs\": {\n \"business_intelligence___generate_report\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"chatwidget___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"compliance___generate_dpa\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___ai_suggest\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___auto_categorize\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___score_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"hitl___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___start_stream\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"internal___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"knowledge___ai_summary\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"knowledge___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"lead_scoring___score_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"substitutes___default\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___batch\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___single\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___all\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___email\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___phone\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"validate___website\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"vat___rates\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_ai___generate_workflow\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___get_authtoken\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___profile___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___profile___update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_account___restore\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___attachment_upload\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___chat_message\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"paperoffice_agent___embedding\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___message_tokens\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"paperoffice_agent___storage_mb\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_agent___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"text\": true,\n \"voice\": true,\n \"images\": true,\n \"vision\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"price_per_minute_cents\": 0\n },\n \"paperoffice_agent___ultra_pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"text\": true,\n \"voice\": true,\n \"images\": true,\n \"vision\": true,\n \"thinking\": true,\n \"ai_reasoning\": true,\n \"priority_processing\": true\n },\n \"price_per_minute_cents\": 0\n },\n \"paperoffice_agent___ultra_pro_max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"text\": true,\n \"voice\": true,\n \"images\": true,\n \"vision\": true,\n \"thinking\": true,\n \"ai_reasoning\": true,\n \"priority_processing\": true,\n \"extended_context\": true,\n \"mission_critical\": true\n },\n \"price_per_minute_cents\": 0\n },\n \"paperoffice_agent___voice_minute\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"analytics___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"anonymization___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___at_risk\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___insights\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___opportunities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___sentiment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___image_embeddings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___knowledge_graph\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___summary\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___vision\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___auto_reply_check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"leadscore___analyze\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"rag___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_ai_insights\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___languages\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bank___auto_match\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bank___details\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bunq___check_payment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bunq___payments\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___bunq___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___invoices\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___invoices___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___invoices___pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___payment_methods\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___pricing___calculator\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"billing___pricing___jobs\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"billing___pricing___plans\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"billing___revolut___check_payment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___revolut___payments\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___revolut___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___cancel\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___change\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___checkout\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___portal\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___stripe___setup_products\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___usage\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"billing___usage___history\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___archive_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___convert_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___create_activity\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___create_contact\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___create_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___dashboard\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___delete_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___disqualify_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_account\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_case\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_contact\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_related_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_session_pricing\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___get_settings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_accounts\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_activities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_contacts\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_leads\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___list_opportunities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___pipeline\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___restore_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___save_settings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___send_session_payment\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___update_activity\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___update_contact\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___update_lead\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_compress\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_merge\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_metadata\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_rotate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_dataripper___pdf_split\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agent_delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agent_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agent_put\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___agents_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_binaries_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_copy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_edit\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_move\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_put\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"semantic_search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"hybrid_search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n }\n }\n },\n \"documents___document_thumb_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___documents_export\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___documents_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___ocr_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___processing_dashboard_stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"storage___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"fakeemail___add_domain\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"fakeemail___check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"fakeemail___check_bulk\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_emails_per_request\": 0\n },\n \"fakeemail___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"image___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_imagestudio___generate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_imagestudio___generate___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_resolution\": \"string\"\n },\n \"paperoffice_imagestudio___generate___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_resolution\": \"string\"\n },\n \"paperoffice_imagestudio___generate___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"max_resolution\": \"string\"\n },\n \"paperoffice_imagestudio___remove_bg\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___cancel\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___files\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___jobs_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___request_upload_url\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___retry\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___scan\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___start\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___upload_local_files\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"import___upload_source\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___countrylist\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___device\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___exchangecurrency\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___fingerprint\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___full\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___ip\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___location\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___vpn\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___weather\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ip2location___weathericon_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"harvester_document_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"harvester_entity_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"harvester_llm_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"knowledge_graph_ask\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_canonical_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_cluster\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_document\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_merge_entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_mermaid\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_query\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_topic_details\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_topic_summary\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_topics\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"knowledge_graph_workspace\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"tier_minimum\": \"string\"\n },\n \"paperoffice_llm___addons\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"include_reasoning\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_confidence\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_alternatives\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"strict_validation\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"multi_language\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n }\n }\n },\n \"paperoffice_llm___generate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_llm___generate___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___basic-pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___basic-pro-max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___premium-pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___premium-pro-max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___ultra-pro\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___generate___ultra-pro-max\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"features\": {\n \"ocr\": true,\n \"vision\": true,\n \"bounding_boxes\": true,\n \"thinking\": true,\n \"ai_reasoning\": true\n },\n \"max_keys_per_request\": 0\n },\n \"paperoffice_llm___model_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"maptiles___style\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"maptiles___tile\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"maptiles___tiles\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_aiocr___generate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"ocr_premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_grid_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_complete_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_bounding_boxes_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_full_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n }\n },\n \"tiers\": {\n \"basic\": \"string\",\n \"premium\": \"string\",\n \"ultra\": \"string\"\n },\n \"ocr_mode_aliases\": {\n \"basic\": \"string\",\n \"premium\": \"string\",\n \"ultra\": \"string\"\n }\n },\n \"paperoffice_aiocr___generate___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"paperoffice_aiocr___generate___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"convert___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___compress_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___docx_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___ebook_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___edit_metadata_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___email_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___image_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___lock_with_password_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___merge_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___organize_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_excel\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_image\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_pdfa\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_powerpoint\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pdf_to_word\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___pptx_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___remove_restrictions_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___rotate_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___split_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___unlock_with_password_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___url_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___whitepage_scan\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___xlsx_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"pdfstudio___xml_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"web2pdf___url_to_pdf\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"esignatures___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_sign___signature\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\",\n \"price_cents\": 0\n },\n \"paperoffice_sign___signature_request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"paperoffice_sms___send\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"price_cents\": 0\n },\n \"agent_templates___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"agent_templates___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"agent_templates___system_prompt\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___admin_action\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___available\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___book\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___holidays\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___rate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"appointments___slots\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"booking___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"booking___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"booking___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___cloud_providers-config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___cloud_providers-download\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___cloud_providers-oauth_callback\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___download\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___dropbox\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___gdrive\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___oauth_callback\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"cloud_providers___onedrive\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"compliance___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"contracts___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___document_links\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"crm_intelligence___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"currency___exchange\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"demo_files\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"docs___markdown\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"docs___openapi\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"docs___postman\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___embeddings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___entities\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___meta_fields\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___ocr\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___publisher\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___publishers\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___relations\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___revisions\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"document_intelligence___topics\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documentation\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_download\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___document_restore\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_add_document\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_dissolve\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_meta_get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_meta_set\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_remove_document\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___folder_update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___idp_collections_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___similar\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___trash_empty\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___trash_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___trash_settings\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspace_storage_health\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_clear\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"documents___workspaces_update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"download___demo\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"events___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"faq___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"forms___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"geocoding___batch\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"geocoding___forward\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"health\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___add_note\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___assign_ticket\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___create_ticket\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___dashboard\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___get_config\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___get_messages\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___get_ticket\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___list_tickets\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___resolve_action\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___send_reply\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___update_priority\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"helpdesk___update_status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"hotel___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"job___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"free_polls_per_minute\": 0\n },\n \"job___model_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"job___pricelist\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"job___voices_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"leadscore___result\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"leadscore___status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"letters___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"location2weather\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___initialize\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/call\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/check\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/intents\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/schema\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"mcp___tools\\/search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"meeting___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"message___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"model_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"orders___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"ping\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"portal___access\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"portal___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"publishers___stats\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"publishers___top\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___insights\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"relations___search\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"security___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"signature_notifications___send\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___action\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___book_presales\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___history\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___presales\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___purchase\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___units\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___use\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___validate_token\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"support___webhook\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"sync___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"tasks___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"telegram___check_link_status\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"telegram___generate_link\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"telegram___unlink\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___get_supported_languages\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___translate_batch\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"translate___translate_single\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___activity\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___add_member\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___create\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___delete\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___get\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___get_members\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___get_user_groups\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___remove_member\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"user_groups___update\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"vat___validate\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"marketing_name\": \"string\"\n },\n \"vehicles___request\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"voices_list\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___categories\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___collections\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___grouped\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___nodes\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow_catalog___outputs\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___stt___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"paperoffice_voice___tts___voices_info\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\"\n },\n \"workflow\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": \"string\",\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"include_reasoning\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_sender\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_bounding_boxes\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_confidence_scores\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_enhanced\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"handwriting_recognition\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"_comment_ocr_tiers\": \"string\",\n \"ocr_tier_basic\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_tier_premium\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_tier_ultra\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_tier_text_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_tier_grid_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"ocr_tier_complete_legacy\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n }\n }\n },\n \"workflow___pdf_ai_split\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"require_paid_tier\": true,\n \"required_files\": 0,\n \"max_pages\": 0,\n \"is_instant\": true,\n \"description\": \"string\",\n \"addons\": {\n \"include_document_type\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_date\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_sender\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n },\n \"include_reasoning\": {\n \"credits\": 0,\n \"unit\": \"string\",\n \"description\": \"string\",\n \"request_param\": \"string\",\n \"applies_when\": \"string\"\n }\n }\n }\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"category\": \"string\"\n}" } ] } ] }, { "name": "🎫 Helpdesk & Support", "item": [ { "name": "AI Auto-Categorize Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/auto_categorize", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "auto_categorize" ] }, "description": "Automatically categorize a support ticket using AI based on its content.\n\n💰 **Kosten**: 20 Credits/request (0.02€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, das automatisch klassifiziert werden soll (Typ, Prioritaet, Tags) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/auto_categorize", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "auto_categorize" ] }, "description": "Automatically categorize a support ticket using AI based on its content.\n\n💰 **Kosten**: 20 Credits/request (0.02€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, das automatisch klassifiziert werden soll (Typ, Prioritaet, Tags) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "AI Suggestion for Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/ai_suggest", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "ai_suggest" ] }, "description": "Get AI-powered response suggestions for a support ticket based on context, knowledge base, and ticket history.\n\n💰 **Kosten**: 30 Credits/request (0.03€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, fuer das ein KI-Antwortvorschlag generiert werden soll (required)" }, { "key": "language", "value": "", "type": "text", "description": "Language" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/ai_suggest", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "ai_suggest" ] }, "description": "Get AI-powered response suggestions for a support ticket based on context, knowledge base, and ticket history.\n\n💰 **Kosten**: 30 Credits/request (0.03€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, fuer das ein KI-Antwortvorschlag generiert werden soll (required)" }, { "key": "language", "value": "", "type": "text", "description": "Language" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Create Support Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/create_ticket", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "create_ticket" ] }, "description": "Create a new support ticket in the AI HelpDesk system with subject, description, priority, and optional category.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subject", "value": "", "type": "text", "description": "Betreff des Tickets (Pflichtfeld) (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Anliegens" }, { "key": "status", "value": "", "type": "text", "description": "Status: new, open, pending, resolved, closed (Standard: new)" }, { "key": "priority", "value": "", "type": "text", "description": "Prioritaet: low, medium, high, urgent (Standard: medium)" }, { "key": "type", "value": "", "type": "text", "description": "Ticket-Typ: other, question, problem, task, feature_request (Standard: other)" }, { "key": "enduser_id", "value": "", "type": "text", "description": "ID des zugehoerigen Endusers" }, { "key": "assigned_user_id", "value": "", "type": "text", "description": "ID des zustaendigen Support-Mitarbeiters" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/create_ticket", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "create_ticket" ] }, "description": "Create a new support ticket in the AI HelpDesk system with subject, description, priority, and optional category.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subject", "value": "", "type": "text", "description": "Betreff des Tickets (Pflichtfeld) (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Anliegens" }, { "key": "status", "value": "", "type": "text", "description": "Status: new, open, pending, resolved, closed (Standard: new)" }, { "key": "priority", "value": "", "type": "text", "description": "Prioritaet: low, medium, high, urgent (Standard: medium)" }, { "key": "type", "value": "", "type": "text", "description": "Ticket-Typ: other, question, problem, task, feature_request (Standard: other)" }, { "key": "enduser_id", "value": "", "type": "text", "description": "ID des zugehoerigen Endusers" }, { "key": "assigned_user_id", "value": "", "type": "text", "description": "ID des zustaendigen Support-Mitarbeiters" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"id\": \"poai-job_xxx\",\n \"number\": \"string\",\n \"uuid\": \"poai-job_xxx\"\n}" } ] }, { "name": "Get End User Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/get_enduser", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "get_enduser" ] }, "description": "Get detailed information about a specific end user including ticket history.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/get_enduser", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "get_enduser" ] }, "description": "Get detailed information about a specific end user including ticket history.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Get Ticket Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/get_ticket", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "get_ticket" ] }, "description": "Get full details of a specific support ticket including messages, attachments, and history.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/get_ticket", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "get_ticket" ] }, "description": "Get full details of a specific support ticket including messages, attachments, and history.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Get Ticket Messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/get_messages", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "get_messages" ] }, "description": "Get all messages/conversation history of a support ticket.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/get_messages", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "get_messages" ] }, "description": "Get all messages/conversation history of a support ticket.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Helpdesk Dashboard", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/dashboard", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "dashboard" ] }, "description": "Get helpdesk dashboard with ticket statistics, SLA metrics, agent performance, and volume trends.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/dashboard", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "dashboard" ] }, "description": "Get helpdesk dashboard with ticket statistics, SLA metrics, agent performance, and volume trends.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"tickets\": {\n \"total\": 0,\n \"new\": 0\n },\n \"groups\": {\n \"pipeline\": 0,\n \"payment\": 0,\n \"booked\": 0,\n \"active\": 0,\n \"done\": 0\n },\n \"endusers\": 0,\n \"unassigned\": 0,\n \"urgent\": 0\n }\n}" } ] }, { "name": "Helpdesk KB Search", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/kb_search", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "kb_search" ] }, "description": "Search the helpdesk knowledge base for articles matching a query.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/kb_search", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "kb_search" ] }, "description": "Search the helpdesk knowledge base for articles matching a query.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List End Users", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/list_endusers", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "list_endusers" ] }, "description": "List all end users/customers who have interacted with the helpdesk.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/list_endusers", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "list_endusers" ] }, "description": "List all end users/customers who have interacted with the helpdesk.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": [\n {}\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n }\n}" } ] }, { "name": "List Support Tickets", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/list_tickets", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "list_tickets" ] }, "description": "List all support tickets with filtering by status, priority, category, assigned agent, and pagination.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/list_tickets", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "list_tickets" ] }, "description": "List all support tickets with filtering by status, priority, category, assigned agent, and pagination.\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"last_page\": 0,\n \"pagination\": {\n \"page\": 0,\n \"size\": 0,\n \"total\": 0,\n \"pages\": 0,\n \"last_page\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List Ticket Pipelines", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/list_pipelines", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "list_pipelines" ] }, "description": "List all configured ticket pipelines/stages for the helpdesk system.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/list_pipelines", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "list_pipelines" ] }, "description": "List all configured ticket pipelines/stages for the helpdesk system.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n {\n \"id\": 0,\n \"name\": \"Beispiel\",\n \"description\": \"string\",\n \"is_default\": 0,\n \"sort_order\": 0,\n \"stages\": [\n {\n \"id\": 0,\n \"name\": \"string\",\n \"slug\": \"string\",\n \"color\": \"string\",\n \"sort_order\": 0,\n \"is_closed\": 0,\n \"sla_hours\": \"string\",\n \"actions\": [\n null\n ]\n }\n ]\n }\n ],\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Score Helpdesk Lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/score_lead", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "score_lead" ] }, "description": "Score a lead based on helpdesk interactions, ticket history, and engagement metrics.\n\n💰 **Kosten**: 20 Credits/request (0.02€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "enduser_id", "value": "", "type": "text", "description": "ID des Endkunden, dessen Lead-Score berechnet werden soll (required)" }, { "key": "ticket_id", "value": "", "type": "text", "description": "Ticket id" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "company", "value": "", "type": "text", "description": "Company" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/score_lead", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "score_lead" ] }, "description": "Score a lead based on helpdesk interactions, ticket history, and engagement metrics.\n\n💰 **Kosten**: 20 Credits/request (0.02€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "enduser_id", "value": "", "type": "text", "description": "ID des Endkunden, dessen Lead-Score berechnet werden soll (required)" }, { "key": "ticket_id", "value": "", "type": "text", "description": "Ticket id" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "company", "value": "", "type": "text", "description": "Company" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"score\": 0,\n \"grade\": \"string\",\n \"factors\": [\n \"string\"\n ]\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Search Tickets", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/search", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "search" ] }, "description": "Full-text search across all tickets by keyword, subject, or message content.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/search", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "search" ] }, "description": "Full-text search across all tickets by keyword, subject, or message content.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Send Ticket Reply", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/send_reply", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "send_reply" ] }, "description": "Send a reply message on a support ticket. Supports agent replies and internal notes.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, auf das geantwortet werden soll (required)" }, { "key": "message", "value": "", "type": "text", "description": "Inhalt der Antwort-Nachricht (Text oder HTML) (required)" }, { "key": "is_internal", "value": false, "type": "text", "description": "Interne Notiz (true) oder oeffentliche Antwort an Kunden (false, Standard)" }, { "key": "content", "value": "", "type": "text", "description": "Content" }, { "key": "attachment_ids", "value": "", "type": "text", "description": "Attachment ids" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/send_reply", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "send_reply" ] }, "description": "Send a reply message on a support ticket. Supports agent replies and internal notes.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, auf das geantwortet werden soll (required)" }, { "key": "message", "value": "", "type": "text", "description": "Inhalt der Antwort-Nachricht (Text oder HTML) (required)" }, { "key": "is_internal", "value": false, "type": "text", "description": "Interne Notiz (true) oder oeffentliche Antwort an Kunden (false, Standard)" }, { "key": "content", "value": "", "type": "text", "description": "Content" }, { "key": "attachment_ids", "value": "", "type": "text", "description": "Attachment ids" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Update Ticket Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/update_status", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "update_status" ] }, "description": "Update the status of a support ticket (open, pending, in_progress, resolved, closed).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, dessen Status geaendert werden soll (required)" }, { "key": "status", "value": "", "type": "text", "description": "Neuer Ticket-Status (z.B. open, pending, in_progress, resolved, closed) (required)" }, { "key": "note", "value": "", "type": "text", "description": "Optionale Notiz zur Status-Aenderung" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/helpdesk/update_status", "host": [ "{{base_url}}" ], "path": [ "helpdesk", "update_status" ] }, "description": "Update the status of a support ticket (open, pending, in_progress, resolved, closed).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ticket_id", "value": "", "type": "text", "description": "ID des Tickets, dessen Status geaendert werden soll (required)" }, { "key": "status", "value": "", "type": "text", "description": "Neuer Ticket-Status (z.B. open, pending, in_progress, resolved, closed) (required)" }, { "key": "note", "value": "", "type": "text", "description": "Optionale Notiz zur Status-Aenderung" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"label\": \"string\",\n \"message\": \"string\",\n \"new_status\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"status_labels\": {\n \"new\": \"string\",\n \"open\": \"string\",\n \"pending\": \"string\",\n \"review_required\": \"string\",\n \"awaiting_payment\": \"string\",\n \"payment_failed\": \"string\",\n \"paid_booking_ready\": \"poai-job_xxx\",\n \"appointment_booked\": \"string\",\n \"appointment_completed\": \"string\",\n \"noshow\": \"string\",\n \"call_completed\": \"string\",\n \"kickstart_pending\": \"string\",\n \"deep_dive_pending\": \"string\",\n \"consulting_pending\": \"string\",\n \"self_service\": \"string\",\n \"custom_session\": \"string\",\n \"payment_received\": \"string\",\n \"track_assigned\": \"string\",\n \"demo_scheduled\": \"string\",\n \"demo_completed\": \"string\",\n \"proposal_sent\": \"string\",\n \"negotiation\": \"string\",\n \"won\": \"string\",\n \"lost\": \"string\",\n \"closed\": \"string\",\n \"spam\": \"string\"\n },\n \"valid_statuses\": [\n \"string\"\n ]\n}" } ] } ] }, { "name": "📊 Analytics", "item": [ { "name": "Analytics Document Entities", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "{document_id}" ] }, "description": "Get all extracted entities from a document. Entity Types: - company, person, amount, date, location, iban, product, custom Tier: PREMIUM+ 3 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "{document_id}" ] }, "description": "Get all extracted entities from a document. Entity Types: - company, person, amount, date, location, iban, product, custom Tier: PREMIUM+ 3 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"entities\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Analytics Document Relations", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/relations/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "relations", "{document_id}" ] }, "description": "Get a list of document relations not graph format. Relation Types: - references, supersedes, attachment_of, response_to - invoice_for, payment_for, contract_with, order_for, delivery_for Tier: PREMIUM+ 3 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/relations/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "relations", "{document_id}" ] }, "description": "Get a list of document relations not graph format. Relation Types: - references, supersedes, attachment_of, response_to - invoice_for, payment_for, contract_with, order_for, delivery_for Tier: PREMIUM+ 3 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"relations\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "As mermaid", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/universe", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "universe" ] }, "description": "Export document relations as Mermaid diagram format. Tier: PREMIUM+ 2 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "depth", "value": "", "type": "text", "description": "Hop depth (max: 2)" }, { "key": "format", "value": "", "type": "text", "description": "raw or json" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/universe", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "universe" ] }, "description": "Export document relations as Mermaid diagram format. Tier: PREMIUM+ 2 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "depth", "value": "", "type": "text", "description": "Hop depth (max: 2)" }, { "key": "format", "value": "", "type": "text", "description": "raw or json" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"mermaid_code\": \"poai-job_xxx\"\n }\n }\n}" } ] }, { "name": "Document graph", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/knowledge_graph/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "knowledge_graph", "{document_id}" ] }, "description": "Get a vis.js compatible graph centered on a specific document. Returns: - nodes - Array of vis.js node objects - edges - Array of vis.js edge objects - groups - Node group styling definitions - options - vis.js physics and interaction options Tier: PREMIUM+ 5 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/knowledge_graph/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "knowledge_graph", "{document_id}" ] }, "description": "Get a vis.js compatible graph centered on a specific document. Returns: - nodes - Array of vis.js node objects - edges - Array of vis.js edge objects - groups - Node group styling definitions - options - vis.js physics and interaction options Tier: PREMIUM+ 5 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"nodes\": [\n {}\n ],\n \"edges\": [\n {}\n ],\n \"node_count\": 0,\n \"edge_count\": 0\n }\n }\n}" } ] }, { "name": "Document Topics & Clustering", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/topics", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "topics" ] }, "description": "Zeigt die Topic-Cluster der Dokumente. Der Harvester gruppiert Dokumente automatisch in Themen-Cluster (z.B. Rechnungen, Vertraege, Korrespondenz). Zeigt auch welche Dokumente zu welchem Thema gehoeren.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/topics", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "topics" ] }, "description": "Zeigt die Topic-Cluster der Dokumente. Der Harvester gruppiert Dokumente automatisch in Themen-Cluster (z.B. Rechnungen, Vertraege, Korrespondenz). Zeigt auch welche Dokumente zu welchem Thema gehoeren.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"flat_topics\": [\n \"string\"\n ],\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"topics\": [\n \"string\"\n ],\n \"total\": 0,\n \"workspace_id\": \"poai-job_xxx\",\n \"document_id\": \"poai-job_xxx\",\n \"pofid\": \"poai-job_xxx\"\n}" } ] }, { "name": "Entity Search across Documents", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/search", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "search" ] }, "description": "Sucht nach Entitaeten (Firmen, Personen, IBANs, Betraege, etc.) ueber alle Dokumente hinweg. Nutzt den Entity-Index der vom Harvester automatisch erstellt wird.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/search", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "search" ] }, "description": "Sucht nach Entitaeten (Firmen, Personen, IBANs, Betraege, etc.) ueber alle Dokumente hinweg. Nutzt den Entity-Index der vom Harvester automatisch erstellt wird.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"entity_type_filter\": \"string\",\n \"processing_time\": \"string\",\n \"query\": \"string\",\n \"results\": [\n \"string\"\n ],\n \"status\": \"string\",\n \"total\": 0,\n \"workspace_id\": \"poai-job_xxx\"\n}" } ] }, { "name": "Graph statistics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/stats", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "stats" ] }, "description": "Get knowledge graph statistics. Returns: - Total documents, relations, entities - Relation type counts - Entity type counts - Available tier features Tier: ALL 0 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/stats", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "stats" ] }, "description": "Get knowledge graph statistics. Returns: - Total documents, relations, entities - Relation type counts - Entity type counts - Available tier features Tier: ALL 0 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"total_nodes\": 0,\n \"total_edges\": 0,\n \"graph_density\": 0,\n \"avg_connections\": 0\n }\n }\n}" } ] }, { "name": "Graphrag ultra", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/universe", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "universe" ] }, "description": "Ask natural language questions about your documents using Graph-RAG. Intents detected: - COUNT: wie viele, anzahl - SUM: summe, gesamt, total - LIST: liste, zeige, alle - SUMMARIZE: zusammenfassung - COMPARE: vergleich - RELATIONS: verbunden, beziehung Tier: ULTRA 20 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "question", "value": "", "type": "text", "description": "Frage an den Knowledge Graph in natuerlicher Sprache (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "POFID eines Dokuments fuer kontextbezogene Fragen" }, { "key": "data_hints", "value": "", "type": "text", "description": "Zusaetzliche Hinweise fuer die Analyse" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/universe", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "universe" ] }, "description": "Ask natural language questions about your documents using Graph-RAG. Intents detected: - COUNT: wie viele, anzahl - SUM: summe, gesamt, total - LIST: liste, zeige, alle - SUMMARIZE: zusammenfassung - COMPARE: vergleich - RELATIONS: verbunden, beziehung Tier: ULTRA 20 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "question", "value": "", "type": "text", "description": "Frage an den Knowledge Graph in natuerlicher Sprache (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "POFID eines Dokuments fuer kontextbezogene Fragen" }, { "key": "data_hints", "value": "", "type": "text", "description": "Zusaetzliche Hinweise fuer die Analyse" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"answer\": \"string\",\n \"sources\": [\n {}\n ],\n \"confidence\": 0,\n \"reasoning_steps\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Knowledge Graph: Business Partners", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/partners", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "partners" ] }, "description": "Zeigt alle Business-Partner des Users als Netzwerk-Graph. Basiert auf dem Knowledge Graph der vom Harvester automatisch aus Dokumenten extrahiert wird. Zeigt Beziehungen zwischen Firmen, Personen und Dokumenten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/partners", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "partners" ] }, "description": "Zeigt alle Business-Partner des Users als Netzwerk-Graph. Basiert auf dem Knowledge Graph der vom Harvester automatisch aus Dokumenten extrahiert wird. Zeigt Beziehungen zwischen Firmen, Personen und Dokumenten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"partners\": [\n \"string\"\n ],\n \"processing_time\": \"string\",\n \"query\": \"string\",\n \"sort_by\": \"string\",\n \"status\": \"string\",\n \"tier\": \"string\",\n \"total\": 0,\n \"workspace_id\": \"poai-job_xxx\",\n \"partner\": \"string\",\n \"reference\": \"string\",\n \"reference_type\": \"string\",\n \"workspace_name\": \"Beispiel\",\n \"document\": \"string\",\n \"references\": \"string\"\n}" } ] }, { "name": "Query ultra", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/universe", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "universe" ] }, "description": "Execute multi-hop queries through the knowledge graph. Example: Find all contracts connected to an invoice via 2 hops. Alternative Start: Use start_entity_type + start_entity_value instead of start_document_id. Tier: ULTRA 10 + 2hops credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "question", "value": "", "type": "text", "description": "Komplexe Frage die mehrere Schritte (Hops) erfordert (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "POFID eines Dokuments fuer kontextbezogene Analyse" }, { "key": "max_hops", "value": 3, "type": "text", "description": "Maximale Anzahl von Hops im Graph" }, { "key": "data_hints", "value": "", "type": "text", "description": "Zusaetzliche Hinweise fuer die Analyse" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/universe", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "universe" ] }, "description": "Execute multi-hop queries through the knowledge graph. Example: Find all contracts connected to an invoice via 2 hops. Alternative Start: Use start_entity_type + start_entity_value instead of start_document_id. Tier: ULTRA 10 + 2hops credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "question", "value": "", "type": "text", "description": "Komplexe Frage die mehrere Schritte (Hops) erfordert (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "POFID eines Dokuments fuer kontextbezogene Analyse" }, { "key": "max_hops", "value": 3, "type": "text", "description": "Maximale Anzahl von Hops im Graph" }, { "key": "data_hints", "value": "", "type": "text", "description": "Zusaetzliche Hinweise fuer die Analyse" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"answer\": \"string\",\n \"hops\": [\n {}\n ],\n \"confidence\": 0\n }\n }\n}" } ] }, { "name": "Workspace graph", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/knowledge_graph/{workspace_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "knowledge_graph", "{workspace_id}" ] }, "description": "Get a vis.js compatible graph for an entire workspace. Returns: Same structure as Document Graph but includes all workspace documents. Tier: PREMIUM+ 10 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/knowledge_graph/{workspace_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "knowledge_graph", "{workspace_id}" ] }, "description": "Get a vis.js compatible graph for an entire workspace. Returns: Same structure as Document Graph but includes all workspace documents. Tier: PREMIUM+ 10 credits\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"nodes\": [\n {}\n ],\n \"edges\": [\n {}\n ],\n \"node_count\": 0,\n \"edge_count\": 0\n }\n }\n}" } ] } ] }, { "name": "📚 Knowledge Base", "item": [ { "name": "Add KB Article", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/add", "host": [ "{{base_url}}" ], "path": [ "knowledge", "add" ] }, "description": "Erstellt einen neuen Knowledge-Base Artikel mit Titel, Inhalt und Kategorie.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "kb_id", "value": "", "type": "text", "description": "ID der Knowledge Base, in der der Artikel erstellt werden soll (required)" }, { "key": "title", "value": "", "type": "text", "description": "Titel des Artikels (required)" }, { "key": "content", "value": "", "type": "text", "description": "Inhalt des Artikels (Text oder HTML) (required)" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie-Slug oder Name fuer den Artikel (optional)" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "position", "value": "", "type": "text", "description": "Position" }, { "key": "is_active", "value": "", "type": "text", "description": "Is active" }, { "key": "category_id", "value": "", "type": "text", "description": "Category id" }, { "key": "image_url", "value": "", "type": "text", "description": "Image url" }, { "key": "selected_languages", "value": "", "type": "text", "description": "Selected languages" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/add", "host": [ "{{base_url}}" ], "path": [ "knowledge", "add" ] }, "description": "Erstellt einen neuen Knowledge-Base Artikel mit Titel, Inhalt und Kategorie.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "kb_id", "value": "", "type": "text", "description": "ID der Knowledge Base, in der der Artikel erstellt werden soll (required)" }, { "key": "title", "value": "", "type": "text", "description": "Titel des Artikels (required)" }, { "key": "content", "value": "", "type": "text", "description": "Inhalt des Artikels (Text oder HTML) (required)" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie-Slug oder Name fuer den Artikel (optional)" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "position", "value": "", "type": "text", "description": "Position" }, { "key": "is_active", "value": "", "type": "text", "description": "Is active" }, { "key": "category_id", "value": "", "type": "text", "description": "Category id" }, { "key": "image_url", "value": "", "type": "text", "description": "Image url" }, { "key": "selected_languages", "value": "", "type": "text", "description": "Selected languages" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"article\": {\n \"article_id\": \"poai-job_xxx\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"category_id\": \"poai-job_xxx\",\n \"language\": \"string\",\n \"status\": \"draft\",\n \"views\": 0,\n \"helpful_votes\": 0,\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"embedding_stats\": \"string\"\n}" } ] }, { "name": "Create Knowledge Base", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_add", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_add" ] }, "description": "Create a new knowledge base.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "language", "value": "", "type": "text", "description": "Language" }, { "key": "slug", "value": "", "type": "text", "description": "Slug" }, { "key": "visibility", "value": "", "type": "text", "description": "Visibility" }, { "key": "primary_language", "value": "", "type": "text", "description": "Primary language" }, { "key": "enabled_languages", "value": "", "type": "text", "description": "Enabled languages" }, { "key": "theme_color", "value": "", "type": "text", "description": "Theme color" }, { "key": "logo_url", "value": "", "type": "text", "description": "Logo url" }, { "key": "settings", "value": "", "type": "text", "description": "Settings" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_add", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_add" ] }, "description": "Create a new knowledge base.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "language", "value": "", "type": "text", "description": "Language" }, { "key": "slug", "value": "", "type": "text", "description": "Slug" }, { "key": "visibility", "value": "", "type": "text", "description": "Visibility" }, { "key": "primary_language", "value": "", "type": "text", "description": "Primary language" }, { "key": "enabled_languages", "value": "", "type": "text", "description": "Enabled languages" }, { "key": "theme_color", "value": "", "type": "text", "description": "Theme color" }, { "key": "logo_url", "value": "", "type": "text", "description": "Logo url" }, { "key": "settings", "value": "", "type": "text", "description": "Settings" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": 0,\n \"slug\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"name\": \"Beispiel\"\n },\n \"message\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"id\": \"poai-job_xxx\",\n \"slug\": \"string\",\n \"name\": \"Beispiel\"\n}" } ] }, { "name": "Delete KB Article", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/delete", "host": [ "{{base_url}}" ], "path": [ "knowledge", "delete" ] }, "description": "Loescht einen Knowledge-Base Artikel anhand seiner ID.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des Artikels, der geloescht werden soll (required)" }, { "key": "knowledge_id", "value": "", "type": "text", "description": "Knowledge id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/delete", "host": [ "{{base_url}}" ], "path": [ "knowledge", "delete" ] }, "description": "Loescht einen Knowledge-Base Artikel anhand seiner ID.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des Artikels, der geloescht werden soll (required)" }, { "key": "knowledge_id", "value": "", "type": "text", "description": "Knowledge id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"article_id\": \"poai-job_xxx\",\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Delete Knowledge Base", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_delete", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_delete" ] }, "description": "Delete a KB and articles.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Knowledge Base, die geloescht werden soll (required)" }, { "key": "hard", "value": "", "type": "text", "description": "Hard" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_delete", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_delete" ] }, "description": "Delete a KB and articles.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Knowledge Base, die geloescht werden soll (required)" }, { "key": "hard", "value": "", "type": "text", "description": "Hard" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "Generate Summary", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/generate_summary", "host": [ "{{base_url}}" ], "path": [ "knowledge", "generate_summary" ] }, "description": "AI summary of article.\n\n💰 **Kosten**: 30 Credits/request (0.03€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des Artikels, fuer den eine KI-Zusammenfassung generiert werden soll (required)" }, { "key": "text", "value": "", "type": "text", "description": "Text" }, { "key": "language", "value": "", "type": "text", "description": "Language" }, { "key": "max_length", "value": "", "type": "text", "description": "Max length" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/generate_summary", "host": [ "{{base_url}}" ], "path": [ "knowledge", "generate_summary" ] }, "description": "AI summary of article.\n\n💰 **Kosten**: 30 Credits/request (0.03€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des Artikels, fuer den eine KI-Zusammenfassung generiert werden soll (required)" }, { "key": "text", "value": "", "type": "text", "description": "Text" }, { "key": "language", "value": "", "type": "text", "description": "Language" }, { "key": "max_length", "value": "", "type": "text", "description": "Max length" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"summary\": \"string\",\n \"article_id\": \"poai-job_xxx\",\n \"processing_time\": \"string\",\n \"method\": \"string\",\n \"fallback_reason\": \"string\",\n \"model\": \"string\"\n}" } ] }, { "name": "Get KB Article", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/get", "host": [ "{{base_url}}" ], "path": [ "knowledge", "get" ] }, "description": "Get specific article.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/get", "host": [ "{{base_url}}" ], "path": [ "knowledge", "get" ] }, "description": "Get specific article.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"article\": {\n \"article_id\": \"poai-job_xxx\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"category_id\": \"poai-job_xxx\",\n \"language\": \"string\",\n \"status\": \"draft\",\n \"views\": 0,\n \"helpful_votes\": 0,\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n \"processing_time\": \"string\",\n \"data\": \"string\"\n}" } ] }, { "name": "Get Knowledge Base", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_get", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_get" ] }, "description": "Get knowledge base details.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_get", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_get" ] }, "description": "Get knowledge base details.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"data\": \"string\"\n}" } ] }, { "name": "Knowledge Base Search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/search", "host": [ "{{base_url}}" ], "path": [ "knowledge", "search" ] }, "description": "Durchsucht die Knowledge-Base mit semantischer Vektor-Suche nach relevanten Artikeln.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "kb_id", "value": "", "type": "text", "description": "Optionale Knowledge-Base-ID zum Einschraenken der Suche" }, { "key": "query", "value": "", "type": "text", "description": "Query (required)" }, { "key": "language", "value": "", "type": "text", "description": "Language" }, { "key": "limit", "value": "", "type": "text", "description": "Limit" }, { "key": "min_similarity", "value": "", "type": "text", "description": "Min similarity" }, { "key": "mode", "value": "", "type": "text", "description": "Mode" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/search", "host": [ "{{base_url}}" ], "path": [ "knowledge", "search" ] }, "description": "Durchsucht die Knowledge-Base mit semantischer Vektor-Suche nach relevanten Artikeln.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "kb_id", "value": "", "type": "text", "description": "Optionale Knowledge-Base-ID zum Einschraenken der Suche" }, { "key": "query", "value": "", "type": "text", "description": "Query (required)" }, { "key": "language", "value": "", "type": "text", "description": "Language" }, { "key": "limit", "value": "", "type": "text", "description": "Limit" }, { "key": "min_similarity", "value": "", "type": "text", "description": "Min similarity" }, { "key": "mode", "value": "", "type": "text", "description": "Mode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"data\": [\n {\n \"article_id\": \"poai-job_xxx\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"category_id\": \"poai-job_xxx\",\n \"language\": \"string\",\n \"status\": \"draft\",\n \"views\": 0,\n \"helpful_votes\": 0,\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"relevance\": 0,\n \"excerpt\": \"string\"\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"per_page\": 0,\n \"processing_time\": \"string\",\n \"query\": \"string\",\n \"language\": \"string\",\n \"mode\": \"string\",\n \"search_method\": \"string\",\n \"results\": \"string\",\n \"count\": \"string\"\n}" } ] }, { "name": "List Categories", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/categories", "host": [ "{{base_url}}" ], "path": [ "knowledge", "categories" ] }, "description": "Listet alle Kategorien einer Knowledge-Base mit optionalen Uebersetzungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/categories", "host": [ "{{base_url}}" ], "path": [ "knowledge", "categories" ] }, "description": "Listet alle Kategorien einer Knowledge-Base mit optionalen Uebersetzungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n {\n \"id\": 0,\n \"slug\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"name\": \"Beispiel\",\n \"description\": \"string\",\n \"image_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"parent_id\": \"poai-job_xxx\",\n \"sort_order\": 0,\n \"article_count\": 0\n }\n ],\n \"processing_time\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "List KB Articles", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/list", "host": [ "{{base_url}}" ], "path": [ "knowledge", "list" ] }, "description": "List articles with pagination.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/list", "host": [ "{{base_url}}" ], "path": [ "knowledge", "list" ] }, "description": "List articles with pagination.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"articles\": [\n \"string\"\n ],\n \"total\": 0,\n \"limit\": 0,\n \"offset\": 0\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"articles\": \"string\",\n \"total\": \"string\",\n \"limit\": \"string\",\n \"offset\": \"string\"\n}" } ] }, { "name": "List Knowledge Bases", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_list", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_list" ] }, "description": "List all knowledge bases.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_list", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_list" ] }, "description": "List all knowledge bases.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"count\": 0,\n \"data\": [\n \"string\"\n ],\n \"processing_time\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "List Languages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/languages", "host": [ "{{base_url}}" ], "path": [ "knowledge", "languages" ] }, "description": "List available KB languages.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/languages", "host": [ "{{base_url}}" ], "path": [ "knowledge", "languages" ] }, "description": "List available KB languages.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n {\n \"code\": \"string\",\n \"name\": \"Beispiel\",\n \"flag\": \"string\"\n }\n ],\n \"processing_time\": \"string\",\n \"status\": \"string\"\n}" } ] }, { "name": "Update KB Article", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/update", "host": [ "{{base_url}}" ], "path": [ "knowledge", "update" ] }, "description": "Aktualisiert einen bestehenden Knowledge-Base Artikel (Titel, Inhalt, Kategorie, Status).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des Artikels, der aktualisiert werden soll (required)" }, { "key": "title", "value": "", "type": "text", "description": "Neuer Titel des Artikels (optional)" }, { "key": "content", "value": "", "type": "text", "description": "Neuer Inhalt des Artikels (optional)" }, { "key": "knowledge_id", "value": "", "type": "text", "description": "Knowledge id" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "category_id", "value": "", "type": "text", "description": "Category id" }, { "key": "category", "value": "", "type": "text", "description": "Category" }, { "key": "image_url", "value": "", "type": "text", "description": "Image url" }, { "key": "is_active", "value": "", "type": "text", "description": "Is active" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "position", "value": "", "type": "text", "description": "Position" }, { "key": "selected_languages", "value": "", "type": "text", "description": "Selected languages" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/update", "host": [ "{{base_url}}" ], "path": [ "knowledge", "update" ] }, "description": "Aktualisiert einen bestehenden Knowledge-Base Artikel (Titel, Inhalt, Kategorie, Status).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des Artikels, der aktualisiert werden soll (required)" }, { "key": "title", "value": "", "type": "text", "description": "Neuer Titel des Artikels (optional)" }, { "key": "content", "value": "", "type": "text", "description": "Neuer Inhalt des Artikels (optional)" }, { "key": "knowledge_id", "value": "", "type": "text", "description": "Knowledge id" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "category_id", "value": "", "type": "text", "description": "Category id" }, { "key": "category", "value": "", "type": "text", "description": "Category" }, { "key": "image_url", "value": "", "type": "text", "description": "Image url" }, { "key": "is_active", "value": "", "type": "text", "description": "Is active" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "position", "value": "", "type": "text", "description": "Position" }, { "key": "selected_languages", "value": "", "type": "text", "description": "Selected languages" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"article\": {\n \"article_id\": \"poai-job_xxx\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"category_id\": \"poai-job_xxx\",\n \"language\": \"string\",\n \"status\": \"draft\",\n \"views\": 0,\n \"helpful_votes\": 0,\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Update Knowledge Base", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_update", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_update" ] }, "description": "Aktualisiert die Einstellungen einer Knowledge-Base (Name, Sprache, Design, Sichtbarkeit).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Knowledge Base, die aktualisiert werden soll (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name der Knowledge Base (optional)" }, { "key": "slug", "value": "", "type": "text", "description": "Slug (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description (required)" }, { "key": "visibility", "value": "", "type": "text", "description": "Visibility (required)" }, { "key": "primary_language", "value": "", "type": "text", "description": "Primary language (required)" }, { "key": "enabled_languages", "value": "", "type": "text", "description": "Enabled languages (required)" }, { "key": "theme_color", "value": "", "type": "text", "description": "Theme color (required)" }, { "key": "logo_url", "value": "", "type": "text", "description": "Logo url (required)" }, { "key": "settings", "value": "", "type": "text", "description": "Settings (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge/kb_update", "host": [ "{{base_url}}" ], "path": [ "knowledge", "kb_update" ] }, "description": "Aktualisiert die Einstellungen einer Knowledge-Base (Name, Sprache, Design, Sichtbarkeit).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Knowledge Base, die aktualisiert werden soll (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name der Knowledge Base (optional)" }, { "key": "slug", "value": "", "type": "text", "description": "Slug (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description (required)" }, { "key": "visibility", "value": "", "type": "text", "description": "Visibility (required)" }, { "key": "primary_language", "value": "", "type": "text", "description": "Primary language (required)" }, { "key": "enabled_languages", "value": "", "type": "text", "description": "Enabled languages (required)" }, { "key": "theme_color", "value": "", "type": "text", "description": "Theme color (required)" }, { "key": "logo_url", "value": "", "type": "text", "description": "Logo url (required)" }, { "key": "settings", "value": "", "type": "text", "description": "Settings (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"data\": \"string\",\n \"id\": \"poai-job_xxx\",\n \"slug\": \"string\"\n}" } ] } ] }, { "name": "📦 Import & Migration", "item": [ { "name": "Import Start Stream", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/import-start-stream", "host": [ "{{base_url}}" ], "path": [ "import", "import-start-stream" ] }, "description": "Import starten mit SSE-Stream (Echtzeit-Fortschritt pro Datei)\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/import-start-stream", "host": [ "{{base_url}}" ], "path": [ "import", "import-start-stream" ] }, "description": "Import starten mit SSE-Stream (Echtzeit-Fortschritt pro Datei)\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"welcome\": \"string\",\n \"message\": \"string\",\n \"data\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"total_files_imported\": \"string\"\n}" } ] }, { "name": "Import: Abbrechen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/cancel", "host": [ "{{base_url}}" ], "path": [ "import", "cancel" ] }, "description": "Bricht einen laufenden Import-Job ab. Bereits importierte Dateien bleiben erhalten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, der abgebrochen werden soll (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/cancel", "host": [ "{{base_url}}" ], "path": [ "import", "cancel" ] }, "description": "Bricht einen laufenden Import-Job ab. Bereits importierte Dateien bleiben erhalten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, der abgebrochen werden soll (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"import_id\": \"poai-job_xxx\",\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"files_skipped\": \"string\",\n \"retried_files\": \"string\",\n \"deleted_files\": \"string\"\n}" } ] }, { "name": "Import: Dateien hochladen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/upload-local-files", "host": [ "{{base_url}}" ], "path": [ "import", "upload-local-files" ] }, "description": "Laedt mehrere Dateien mit Ordnerstruktur hoch (Local Upload Batch). Dateien werden in einem Session-Verzeichnis auf NAS gruppiert.\n\n💰 **Kosten**: 10 Credits/MB (0.01€/MB)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Hochzuladende Dateien als multipart/form-data (files[]) (required)" }, { "key": "relative_paths", "value": "", "type": "text", "description": "Relative Pfade der Dateien fuer Ordnerstruktur-Erhaltung" }, { "key": "session_id", "value": "", "type": "text", "description": "Session-ID zum Gruppieren zusammengehoeriger Upload-Batches" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/upload-local-files", "host": [ "{{base_url}}" ], "path": [ "import", "upload-local-files" ] }, "description": "Laedt mehrere Dateien mit Ordnerstruktur hoch (Local Upload Batch). Dateien werden in einem Session-Verzeichnis auf NAS gruppiert.\n\n💰 **Kosten**: 10 Credits/MB (0.01€/MB)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Hochzuladende Dateien als multipart/form-data (files[]) (required)" }, { "key": "relative_paths", "value": "", "type": "text", "description": "Relative Pfade der Dateien fuer Ordnerstruktur-Erhaltung" }, { "key": "session_id", "value": "", "type": "text", "description": "Session-ID zum Gruppieren zusammengehoeriger Upload-Batches" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"uploaded\": 0,\n \"failed\": 0,\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"session_id\": \"poai-job_xxx\",\n \"upload_dir\": \"string\",\n \"batch_uploaded\": \"string\",\n \"batch_bytes\": \"string\",\n \"total_files\": \"string\",\n \"total_bytes\": \"string\",\n \"errors\": \"string\",\n \"temp_file_id\": \"poai-job_xxx\",\n \"temp_path\": \"string\",\n \"file_name\": \"Beispiel\"\n}" } ] }, { "name": "Import: Dateiliste", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/files", "host": [ "{{base_url}}" ], "path": [ "import", "files" ] }, "description": "Gibt die Dateiliste eines Import-Jobs zurueck mit Status pro Datei (pending, imported, failed, skipped).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, dessen Dateiliste abgerufen werden soll (required)" }, { "key": "skip", "value": "", "type": "text", "description": "Anzahl zu ueberspringender Eintraege (Offset fuer Paginierung)" }, { "key": "limit", "value": "", "type": "text", "description": "Maximale Anzahl Dateien pro Seite (Standard: 50, Max: 500)" }, { "key": "page", "value": "", "type": "text", "description": "Page" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/files", "host": [ "{{base_url}}" ], "path": [ "import", "files" ] }, "description": "Gibt die Dateiliste eines Import-Jobs zurueck mit Status pro Datei (pending, imported, failed, skipped).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, dessen Dateiliste abgerufen werden soll (required)" }, { "key": "skip", "value": "", "type": "text", "description": "Anzahl zu ueberspringender Eintraege (Offset fuer Paginierung)" }, { "key": "limit", "value": "", "type": "text", "description": "Maximale Anzahl Dateien pro Seite (Standard: 50, Max: 500)" }, { "key": "page", "value": "", "type": "text", "description": "Page" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"files\": [\n {\n \"filename\": \"Beispiel\",\n \"status\": \"string\",\n \"pofid\": \"poai-job_xxx\",\n \"error\": \"string\"\n }\n ],\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"total\": \"string\",\n \"page\": \"string\",\n \"limit\": \"string\",\n \"total_pages\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"files_skipped\": \"string\",\n \"retried_files\": \"string\"\n}" } ] }, { "name": "Import: Job erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/create", "host": [ "{{base_url}}" ], "path": [ "import", "create" ] }, "description": "Erstellt einen neuen Import-Job mit Quellkonfiguration (SFTP, S3, WebDAV, ELO, lokaler Upload etc.) und Ziel-Workspace.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Ziel-Workspace, in den die Dateien importiert werden (required)" }, { "key": "source_type", "value": "", "type": "text", "description": "Quelltyp des Imports (sftp, s3, webdav, imap, elo_office, local_upload etc.) (required)" }, { "key": "source_config", "value": "", "type": "text", "description": "Quell-spezifische Konfiguration (Host, Zugangsdaten, Pfad etc.) (required)" }, { "key": "include_subfolders", "value": "", "type": "text", "description": "Unterordner einbeziehen (Standard: true)" }, { "key": "file_pattern", "value": "", "type": "text", "description": "Dateifilter-Muster, z.B. \"*.pdf\" (Standard: \"*\")" }, { "key": "ai_processing", "value": "", "type": "text", "description": "KI-Verarbeitung aktivieren (wird aus Workspace-Einstellung abgeleitet)" }, { "key": "ai_tier", "value": "", "type": "text", "description": "KI-Verarbeitungsstufe (basic, premium, ultra)" }, { "key": "max_file_size_mb", "value": "", "type": "text", "description": "Max file size mb (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/create", "host": [ "{{base_url}}" ], "path": [ "import", "create" ] }, "description": "Erstellt einen neuen Import-Job mit Quellkonfiguration (SFTP, S3, WebDAV, ELO, lokaler Upload etc.) und Ziel-Workspace.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Ziel-Workspace, in den die Dateien importiert werden (required)" }, { "key": "source_type", "value": "", "type": "text", "description": "Quelltyp des Imports (sftp, s3, webdav, imap, elo_office, local_upload etc.) (required)" }, { "key": "source_config", "value": "", "type": "text", "description": "Quell-spezifische Konfiguration (Host, Zugangsdaten, Pfad etc.) (required)" }, { "key": "include_subfolders", "value": "", "type": "text", "description": "Unterordner einbeziehen (Standard: true)" }, { "key": "file_pattern", "value": "", "type": "text", "description": "Dateifilter-Muster, z.B. \"*.pdf\" (Standard: \"*\")" }, { "key": "ai_processing", "value": "", "type": "text", "description": "KI-Verarbeitung aktivieren (wird aus Workspace-Einstellung abgeleitet)" }, { "key": "ai_tier", "value": "", "type": "text", "description": "KI-Verarbeitungsstufe (basic, premium, ultra)" }, { "key": "max_file_size_mb", "value": "", "type": "text", "description": "Max file size mb (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"import\": {\n \"import_id\": \"poai-job_xxx\",\n \"status\": \"pending\",\n \"total_files\": 0,\n \"processed_files\": 0,\n \"failed_files\": 0,\n \"progress_percent\": 0,\n \"created_at\": \"string\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Import: Job loeschen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/delete", "host": [ "{{base_url}}" ], "path": [ "import", "delete" ] }, "description": "Loescht einen Import-Job und alle zugehoerigen Dateieintraege aus der Datenbank.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, der geloescht werden soll (inkl. aller Datei-Eintraege) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/delete", "host": [ "{{base_url}}" ], "path": [ "import", "delete" ] }, "description": "Loescht einen Import-Job und alle zugehoerigen Dateieintraege aus der Datenbank.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, der geloescht werden soll (inkl. aller Datei-Eintraege) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"import_id\": \"poai-job_xxx\",\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"deleted_files\": \"string\",\n \"session_id\": \"poai-job_xxx\",\n \"upload_dir\": \"string\",\n \"batch_uploaded\": \"string\",\n \"batch_bytes\": \"string\",\n \"total_files\": \"string\",\n \"total_bytes\": \"string\",\n \"errors\": \"string\"\n}" } ] }, { "name": "Import: Jobs auflisten", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/import-jobs-list", "host": [ "{{base_url}}" ], "path": [ "import", "import-jobs-list" ] }, "description": "Listet alle Import-Jobs des Accounts auf inkl. KPI-Statistiken (Gesamt, Abgeschlossen, Laufend, Fehlgeschlagen).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "limit", "value": 50, "type": "text", "description": "Maximale Anzahl Jobs (Standard: 50, Max: 200)" }, { "key": "offset", "value": 0, "type": "text", "description": "Offset fuer Paginierung (Standard: 0)" }, { "key": "status", "value": "", "type": "text", "description": "Nach Job-Status filtern (pending, scanning, scan_complete, importing, completed, failed, cancelled)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/import-jobs-list", "host": [ "{{base_url}}" ], "path": [ "import", "import-jobs-list" ] }, "description": "Listet alle Import-Jobs des Accounts auf inkl. KPI-Statistiken (Gesamt, Abgeschlossen, Laufend, Fehlgeschlagen).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "limit", "value": 50, "type": "text", "description": "Maximale Anzahl Jobs (Standard: 50, Max: 200)" }, { "key": "offset", "value": 0, "type": "text", "description": "Offset fuer Paginierung (Standard: 0)" }, { "key": "status", "value": "", "type": "text", "description": "Nach Job-Status filtern (pending, scanning, scan_complete, importing, completed, failed, cancelled)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credits\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\"\n },\n \"data\": {\n \"jobs\": [\n \"string\"\n ],\n \"kpi\": {\n \"total\": 0,\n \"completed\": 0,\n \"running\": 0,\n \"failed\": 0\n },\n \"pagination\": {\n \"limit\": 0,\n \"offset\": 0,\n \"returned\": 0\n }\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"jobs\": \"poai-job_xxx\",\n \"kpi\": \"string\",\n \"total\": \"string\"\n}" } ] }, { "name": "Import: Quelle scannen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/scan", "host": [ "{{base_url}}" ], "path": [ "import", "scan" ] }, "description": "Scannt die Import-Quelle und listet alle gefundenen Dateien auf. Gibt Anzahl, Groessen und Typ-Aufschluesselung zurueck.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, fuer den die Quelle gescannt werden soll (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/scan", "host": [ "{{base_url}}" ], "path": [ "import", "scan" ] }, "description": "Scannt die Import-Quelle und listet alle gefundenen Dateien auf. Gibt Anzahl, Groessen und Typ-Aufschluesselung zurueck.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, fuer den die Quelle gescannt werden soll (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"files\": [\n {\n \"filename\": \"Beispiel\",\n \"size\": 0,\n \"mime_type\": \"string\"\n }\n ],\n \"total_size\": 0,\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"total_files_found\": \"string\",\n \"total_size_bytes\": \"string\",\n \"total_size_human\": \"string\"\n}" } ] }, { "name": "Import: Starten", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/start", "host": [ "{{base_url}}" ], "path": [ "import", "start" ] }, "description": "Startet den Import-Prozess (Batch-weise, 50 Dateien pro Aufruf). Wiederholte Aufrufe bis alle Dateien importiert sind.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, der gestartet werden soll (Status muss scan_complete sein) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/start", "host": [ "{{base_url}}" ], "path": [ "import", "start" ] }, "description": "Startet den Import-Prozess (Batch-weise, 50 Dateien pro Aufruf). Wiederholte Aufrufe bis alle Dateien importiert sind.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, der gestartet werden soll (Status muss scan_complete sein) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"import\": {\n \"import_id\": \"poai-job_xxx\",\n \"status\": \"pending\",\n \"total_files\": 0,\n \"processed_files\": 0,\n \"failed_files\": 0,\n \"progress_percent\": 0,\n \"created_at\": \"string\"\n },\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"total_files_imported\": \"string\"\n}" } ] }, { "name": "Import: Status abfragen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/status", "host": [ "{{base_url}}" ], "path": [ "import", "status" ] }, "description": "Gibt den aktuellen Status eines Import-Jobs zurueck inkl. Fortschritt und Datei-Statistiken.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, dessen aktueller Status abgefragt werden soll (required)" }, { "key": "include_report", "value": "", "type": "text", "description": "Include report" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/status", "host": [ "{{base_url}}" ], "path": [ "import", "status" ] }, "description": "Gibt den aktuellen Status eines Import-Jobs zurueck inkl. Fortschritt und Datei-Statistiken.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, dessen aktueller Status abgefragt werden soll (required)" }, { "key": "include_report", "value": "", "type": "text", "description": "Include report" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"import\": {\n \"import_id\": \"poai-job_xxx\",\n \"status\": \"pending\",\n \"total_files\": 0,\n \"processed_files\": 0,\n \"failed_files\": 0,\n \"progress_percent\": 0,\n \"created_at\": \"string\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Import: Upload-URL anfordern", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/request-upload-url", "host": [ "{{base_url}}" ], "path": [ "import", "request-upload-url" ] }, "description": "Generiert eine signierte Upload-URL fuer direkten Server-Upload (Cloudflare-Bypass). Gibt URL + HMAC-Token + Ablaufzeit zurueck. Der Token ist 5 Minuten gueltig.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "purpose", "value": "", "type": "text", "description": "Upload-Zweck (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/request-upload-url", "host": [ "{{base_url}}" ], "path": [ "import", "request-upload-url" ] }, "description": "Generiert eine signierte Upload-URL fuer direkten Server-Upload (Cloudflare-Bypass). Gibt URL + HMAC-Token + Ablaufzeit zurueck. Der Token ist 5 Minuten gueltig.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "purpose", "value": "", "type": "text", "description": "Upload-Zweck (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credits\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\"\n },\n \"data\": {\n \"upload_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"upload_token\": \"string\",\n \"expires_in\": 0,\n \"max_size_bytes\": 0,\n \"max_size_hr\": \"2026-02-07T12:00:00Z\"\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"upload_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"upload_token\": \"string\",\n \"expires_in\": \"string\",\n \"max_size_bytes\": \"string\",\n \"max_size_hr\": \"string\"\n}" } ] }, { "name": "Import: Wiederholen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/retry", "host": [ "{{base_url}}" ], "path": [ "import", "retry" ] }, "description": "Versucht fehlgeschlagene Dateien eines Import-Jobs erneut zu importieren.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, dessen fehlgeschlagene Dateien erneut versucht werden sollen (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/retry", "host": [ "{{base_url}}" ], "path": [ "import", "retry" ] }, "description": "Versucht fehlgeschlagene Dateien eines Import-Jobs erneut zu importieren.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "ID des Import-Jobs, dessen fehlgeschlagene Dateien erneut versucht werden sollen (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"import\": {\n \"import_id\": \"poai-job_xxx\",\n \"status\": \"pending\",\n \"total_files\": 0,\n \"processed_files\": 0,\n \"failed_files\": 0,\n \"progress_percent\": 0,\n \"created_at\": \"string\"\n },\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"retried_files\": \"string\",\n \"deleted_files\": \"string\"\n}" } ] }, { "name": "Import: ZIP hochladen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/upload-source", "host": [ "{{base_url}}" ], "path": [ "import", "upload-source" ] }, "description": "Laedt eine ZIP-Datei hoch (ELO-Export oder lokaler Upload). Max 5 GB. Datei wird auf NAS gespeichert und ist von allen Servern lesbar.\n\n💰 **Kosten**: 10 Credits/MB (0.01€/MB)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "ZIP-Datei (required)" }, { "key": "source_type", "value": "", "type": "text", "description": "Source type" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/import/upload-source", "host": [ "{{base_url}}" ], "path": [ "import", "upload-source" ] }, "description": "Laedt eine ZIP-Datei hoch (ELO-Export oder lokaler Upload). Max 5 GB. Datei wird auf NAS gespeichert und ist von allen Servern lesbar.\n\n💰 **Kosten**: 10 Credits/MB (0.01€/MB)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "description": "ZIP-Datei (required)" }, { "key": "source_type", "value": "", "type": "text", "description": "Source type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"source_id\": \"poai-job_xxx\",\n \"files_found\": 0,\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"temp_file_id\": \"poai-job_xxx\",\n \"temp_path\": \"string\",\n \"file_name\": \"Beispiel\"\n}" } ] } ] }, { "name": "🛡️ Compliance", "item": [ { "name": "Agent Audit Log", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/agent_audit/log", "host": [ "{{base_url}}" ], "path": [ "agent_audit", "log" ] }, "description": "Gibt das Audit-Log aller MCP-Tool-Aufrufe zurueck. Gefiltert nach Zeitraum, Tool, Action, Session.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "period", "value": "", "type": "text", "description": "Vordefinierter Zeitraum" }, { "key": "from_date", "value": "", "type": "text", "description": "Start-Datum (ISO 8601, z.B. 2026-03-15T00:00:00Z)" }, { "key": "to_date", "value": "", "type": "text", "description": "End-Datum (ISO 8601)" }, { "key": "tool_filter", "value": "", "type": "text", "description": "Tool-Name Filter (Wildcards mit *, z.B. po_documents_*)" }, { "key": "action_filter", "value": "", "type": "text", "description": "Action-Typ Filter" }, { "key": "session_id", "value": "", "type": "text", "description": "Bestimmte Session filtern" }, { "key": "status_filter", "value": "", "type": "text", "description": "Nur erfolgreiche oder fehlerhafte Aufrufe" }, { "key": "limit", "value": 100, "type": "text", "description": "Max Ergebnisse (1-500)" }, { "key": "offset", "value": 0, "type": "text", "description": "" } ] } } }, { "name": "Agent Audit Summary", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/agent_audit/summary", "host": [ "{{base_url}}" ], "path": [ "agent_audit", "summary" ] }, "description": "Gibt eine aggregierte Zusammenfassung der Agent-Aktivitaet zurueck: Tool-Nutzung, Fehlerrate, Aktivitaets-Heatmap.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "period", "value": "last_7_days", "type": "text", "description": "Zeitraum fuer die Zusammenfassung" } ] } } }, { "name": "By service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/toms_filter", "host": [ "{{base_url}}" ], "path": [ "compliance", "toms_filter" ] }, "description": "TOMs nach Services filtern\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "services", "value": "aiocr,llm", "type": "text", "description": "Komma-getrennte Services" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/toms_filter", "host": [ "{{base_url}}" ], "path": [ "compliance", "toms_filter" ] }, "description": "TOMs nach Services filtern\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "services", "value": "aiocr,llm", "type": "text", "description": "Komma-getrennte Services" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"toms\": [\n {}\n ],\n \"service\": \"string\"\n }\n }\n}" } ] }, { "name": "Download dpa", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/dpa_download", "host": [ "{{base_url}}" ], "path": [ "compliance", "dpa_download" ] }, "description": "DPA als PDF herunterladen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "dpa_id", "value": "", "type": "text", "description": "ID des DPA" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/dpa_download", "host": [ "{{base_url}}" ], "path": [ "compliance", "dpa_download" ] }, "description": "DPA als PDF herunterladen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "dpa_id", "value": "", "type": "text", "description": "ID des DPA" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Generate dpa", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/dpa_generate", "host": [ "{{base_url}}" ], "path": [ "compliance", "dpa_generate" ] }, "description": "Data Processing Agreement generieren\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "company_name", "value": "", "type": "text", "description": "Firmenname für das DPA (required)" }, { "key": "output", "value": "inline", "type": "text", "description": "Output" }, { "key": "priority", "value": "900", "type": "text", "description": "Priority" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/dpa_generate", "host": [ "{{base_url}}" ], "path": [ "compliance", "dpa_generate" ] }, "description": "Data Processing Agreement generieren\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "company_name", "value": "", "type": "text", "description": "Firmenname für das DPA (required)" }, { "key": "output", "value": "inline", "type": "text", "description": "Output" }, { "key": "priority", "value": "900", "type": "text", "description": "Priority" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"dpa_id\": \"string\",\n \"generated\": true\n }\n }\n}" } ] }, { "name": "Services list", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/services", "host": [ "{{base_url}}" ], "path": [ "compliance", "services" ] }, "description": "Liste aller verfügbaren Services für Compliance\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/services", "host": [ "{{base_url}}" ], "path": [ "compliance", "services" ] }, "description": "Liste aller verfügbaren Services für Compliance\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"services\": [\n {}\n ],\n \"total\": 0\n }\n },\n \"jobs\": \"poai-job_xxx\",\n \"templates\": \"string\"\n}" } ] }, { "name": "Tom list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/toms", "host": [ "{{base_url}}" ], "path": [ "compliance", "toms" ] }, "description": "Liste aller technischen und organisatorischen Maßnahmen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "services", "value": "", "type": "text", "description": "Optionale Filterung nach genutzten Services." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/compliance/toms", "host": [ "{{base_url}}" ], "path": [ "compliance", "toms" ] }, "description": "Liste aller technischen und organisatorischen Maßnahmen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "services", "value": "", "type": "text", "description": "Optionale Filterung nach genutzten Services." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"toms\": [\n {}\n ],\n \"total\": 0\n }\n },\n \"jobs\": \"poai-job_xxx\",\n \"templates\": \"string\"\n}" } ] } ] }, { "name": "🔒 Security", "item": [ { "name": "Password add", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF Password Protection Add password protection to PDF documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | PDF file | | password | string | Yes | Password to set | | permissions | string | No | Allowed actions ...\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "password", "value": "", "type": "text", "description": "Password" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF Password Protection Add password protection to PDF documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | PDF file | | password | string | Yes | Password to set | | permissions | string | No | Allowed actions ...\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "password", "value": "", "type": "text", "description": "Password" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n },\n \"job_type\": \"poai-job_xxx\",\n \"processing_mode\": \"string\"\n}" } ] }, { "name": "Remove restrictions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF Remove Restrictions Remove printing/editing restrictions. Parameters: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | password | string | No |\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF Remove Restrictions Remove printing/editing restrictions. Parameters: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | password | string | No |\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "With password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF Password Removal Remove password protection from PDF requires current password. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Protected PDF | | password | string | Yes | Current password | | priority | int | No ...\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "password", "value": "", "type": "text", "description": "Password" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "PDF Password Removal Remove password protection from PDF requires current password. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Protected PDF | | password | string | Yes | Current password | | priority | int | No ...\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "password", "value": "", "type": "text", "description": "Password" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] } ] }, { "name": "👁️ HITL Review", "item": [ { "name": "Create Reviewer Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/create_profile", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "create_profile" ] }, "description": "Create or upsert a reviewer profile with language skills, tier and capacity settings.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Account-ID des Reviewers (Pflicht) (required)" }, { "key": "native_languages", "value": "", "type": "text", "description": "Muttersprachen z.B. [de,tr]" }, { "key": "fluent_languages", "value": "", "type": "text", "description": "Fliessende Sprachen z.B. [en]" }, { "key": "basic_languages", "value": "", "type": "text", "description": "Grundkenntnisse z.B. [fr]" }, { "key": "reviewer_tier", "value": "", "type": "text", "description": "" }, { "key": "max_concurrent_tasks", "value": "", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/create_profile", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "create_profile" ] }, "description": "Create or upsert a reviewer profile with language skills, tier and capacity settings.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Account-ID des Reviewers (Pflicht) (required)" }, { "key": "native_languages", "value": "", "type": "text", "description": "Muttersprachen z.B. [de,tr]" }, { "key": "fluent_languages", "value": "", "type": "text", "description": "Fliessende Sprachen z.B. [en]" }, { "key": "basic_languages", "value": "", "type": "text", "description": "Grundkenntnisse z.B. [fr]" }, { "key": "reviewer_tier", "value": "", "type": "text", "description": "" }, { "key": "max_concurrent_tasks", "value": "", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"account_id\": 0\n}" } ] }, { "name": "Get Consensus Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/consensus_details", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "consensus_details" ] }, "description": "Retrieve all individual reviews for a task with side-by-side field comparison for supervisors.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des Tasks (Pflicht) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/consensus_details", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "consensus_details" ] }, "description": "Retrieve all individual reviews for a task with side-by-side field comparison for supervisors.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des Tasks (Pflicht) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"task_data_summary\": {},\n \"reviews\": [\n \"string\"\n ],\n \"consensus\": {},\n \"field_comparison\": {},\n \"reviews_required\": 0,\n \"task_status\": \"string\"\n}" } ] }, { "name": "Get Task Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/get", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "get" ] }, "description": "Retrieve full details of a single HITL review task by UUID.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des Tasks (Pflicht) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/get", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "get" ] }, "description": "Retrieve full details of a single HITL review task by UUID.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des Tasks (Pflicht) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {},\n \"task\": {}\n}" } ] }, { "name": "HITL Health Check", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/check", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "check" ] }, "description": "Health check for HITL review service.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/check", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "check" ] }, "description": "Health check for HITL review service.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"service\": \"string\",\n \"version\": \"string\"\n}" } ] }, { "name": "List Review Queue", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/list", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "list" ] }, "description": "Cross-tenant review queue with personalized ordering by language match and SLA urgency.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/list", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "list" ] }, "description": "Cross-tenant review queue with personalized ordering by language match and SLA urgency.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"data\": [\n {\n \"review_id\": \"poai-job_xxx\",\n \"document_id\": \"poai-job_xxx\",\n \"status\": \"pending\",\n \"reviewer\": \"string\",\n \"confidence\": 0,\n \"created_at\": \"string\"\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"per_page\": 0,\n \"processing_time\": \"string\",\n \"limit\": \"string\",\n \"offset\": \"string\",\n \"tasks\": \"string\"\n}" } ] }, { "name": "List Reviewer Profiles", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/list_reviewers", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "list_reviewers" ] }, "description": "List all reviewer profiles from SOT including language skills, tier, accuracy scores.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/list_reviewers", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "list_reviewers" ] }, "description": "List all reviewer profiles from SOT including language skills, tier, accuracy scores.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"total\": 0,\n \"reviewers\": [\n {}\n ]\n}" } ] }, { "name": "Review Dashboard Statistics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/dashboard", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "dashboard" ] }, "description": "Aggregated HITL review statistics incl. awaiting_reviews, consensus metrics.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/dashboard", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "dashboard" ] }, "description": "Aggregated HITL review statistics incl. awaiting_reviews, consensus metrics.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"stats\": {\n \"total_tasks\": 0,\n \"pending\": 0,\n \"claimed\": 0,\n \"urgent\": 0,\n \"awaiting_reviews\": 0,\n \"completed_today\": 0,\n \"avg_review_seconds\": 0,\n \"my_reviews_today\": 0\n }\n}" } ] }, { "name": "Review Statistics (Alias)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/stats", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "stats" ] }, "description": "Alias for dashboard. Returns identical statistics.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/stats", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "stats" ] }, "description": "Alias for dashboard. Returns identical statistics.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"total_reviews\": 0,\n \"approval_rate\": 0,\n \"avg_time_seconds\": 0,\n \"by_reviewer\": {},\n \"processing_time\": \"string\",\n \"stats\": \"string\",\n \"overall\": \"string\",\n \"by_account\": \"string\",\n \"by_type\": \"string\",\n \"my_reviews_today\": \"string\"\n}" } ] }, { "name": "Submit Consensus Review", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/submit_review", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "submit_review" ] }, "description": "Submit a review decision (approve/reject/escalate) for a HITL task. Part of 3-reviewer consensus workflow.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des zu reviewenden Tasks (Pflicht) (required)" }, { "key": "decision", "value": "", "type": "text", "description": "Review-Entscheidung (Pflicht) (required)" }, { "key": "field_results", "value": "", "type": "text", "description": "Feld-Korrekturen als Key-Value" }, { "key": "check_results", "value": "", "type": "text", "description": "Binary-Check Ergebnisse" }, { "key": "reject_reason_id", "value": "", "type": "text", "description": "Ablehnungsgrund-ID (Pflicht bei reject wenn kein reject_comment)" }, { "key": "reject_comment", "value": "", "type": "text", "description": "Ablehnungs-Kommentar" }, { "key": "escalation_comment", "value": "", "type": "text", "description": "Eskalationsgrund" }, { "key": "comment", "value": "", "type": "text", "description": "Allgemeiner Reviewer-Kommentar" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/submit_review", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "submit_review" ] }, "description": "Submit a review decision (approve/reject/escalate) for a HITL task. Part of 3-reviewer consensus workflow.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des zu reviewenden Tasks (Pflicht) (required)" }, { "key": "decision", "value": "", "type": "text", "description": "Review-Entscheidung (Pflicht) (required)" }, { "key": "field_results", "value": "", "type": "text", "description": "Feld-Korrekturen als Key-Value" }, { "key": "check_results", "value": "", "type": "text", "description": "Binary-Check Ergebnisse" }, { "key": "reject_reason_id", "value": "", "type": "text", "description": "Ablehnungsgrund-ID (Pflicht bei reject wenn kein reject_comment)" }, { "key": "reject_comment", "value": "", "type": "text", "description": "Ablehnungs-Kommentar" }, { "key": "escalation_comment", "value": "", "type": "text", "description": "Eskalationsgrund" }, { "key": "comment", "value": "", "type": "text", "description": "Allgemeiner Reviewer-Kommentar" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"review_uuid\": \"string\",\n \"reviews_completed\": 0,\n \"reviews_required\": 0,\n \"consensus_reached\": true,\n \"new_status\": \"string\",\n \"kappa\": 0\n}" } ] }, { "name": "Update Reviewer Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/update_profile", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "update_profile" ] }, "description": "Update an existing reviewer profile (upsert semantics).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Account-ID des Reviewers (Pflicht) (required)" }, { "key": "native_languages", "value": "", "type": "text", "description": "" }, { "key": "fluent_languages", "value": "", "type": "text", "description": "" }, { "key": "basic_languages", "value": "", "type": "text", "description": "" }, { "key": "reviewer_tier", "value": "", "type": "text", "description": "" }, { "key": "max_concurrent_tasks", "value": "", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/hitl_review/update_profile", "host": [ "{{base_url}}" ], "path": [ "hitl_review", "update_profile" ] }, "description": "Update an existing reviewer profile (upsert semantics).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Account-ID des Reviewers (Pflicht) (required)" }, { "key": "native_languages", "value": "", "type": "text", "description": "" }, { "key": "fluent_languages", "value": "", "type": "text", "description": "" }, { "key": "basic_languages", "value": "", "type": "text", "description": "" }, { "key": "reviewer_tier", "value": "", "type": "text", "description": "" }, { "key": "max_concurrent_tasks", "value": "", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"account_id\": 0\n}" } ] } ] }, { "name": "🔔 Webhooks", "item": [ { "name": "Create Webhook Subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/subscribe", "host": [ "{{base_url}}" ], "path": [ "webhooks", "subscribe" ] }, "description": "Neue Webhook-Subscription erstellen. Payloads werden mit HMAC-SHA256 signiert.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name der Subscription (Pflicht) (required)" }, { "key": "url", "value": "", "type": "text", "description": "Webhook-Ziel-URL (https empfohlen) (required)" }, { "key": "events", "value": "", "type": "text", "description": "Array von Event-Typen oder [*] fuer alle (required)" }, { "key": "secret", "value": "", "type": "text", "description": "HMAC-Secret (wird auto-generiert wenn leer)" }, { "key": "filters", "value": "", "type": "text", "description": "Optionale Filter (z.B. workspace_id, pofid)" }, { "key": "headers", "value": "", "type": "text", "description": "Zusaetzliche HTTP-Header als Key-Value Paare" }, { "key": "retry_policy", "value": "", "type": "text", "description": "Retry-Strategie (default: exponential)" }, { "key": "max_retries", "value": "", "type": "text", "description": "Max. Retries (0-10, default: 5)" }, { "key": "timeout_ms", "value": "", "type": "text", "description": "Timeout in ms (1000-30000, default: 10000)" } ] } } }, { "name": "Delete Webhook Subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/delete", "host": [ "{{base_url}}" ], "path": [ "webhooks", "delete" ] }, "description": "Webhook-Subscription loeschen (Delivery-Log bleibt erhalten).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subscription_id", "value": "", "type": "text", "description": "ID der zu loeschenden Subscription (required)" } ] } } }, { "name": "Dispatch Webhook Event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/dispatch", "host": [ "{{base_url}}" ], "path": [ "webhooks", "dispatch" ] }, "description": "Event manuell dispatchen (findet alle passenden Subscriptions und feuert Webhooks).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_type", "value": "", "type": "text", "description": "Event-Typ (z.B. document.created, test.ping) (required)" }, { "key": "data", "value": "", "type": "text", "description": "Event-Daten als JSON-Objekt" }, { "key": "job_id", "value": "", "type": "text", "description": "Optional: Job-ID fuer Job-spezifische Subscriptions" } ] } } }, { "name": "List Job Subscriptions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/job-subscriptions", "host": [ "{{base_url}}" ], "path": [ "webhooks", "job-subscriptions" ] }, "description": "Alle Job-Subscriptions des Accounts auflisten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "List Webhook Subscriptions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/list", "host": [ "{{base_url}}" ], "path": [ "webhooks", "list" ] }, "description": "Alle Webhook-Subscriptions des Accounts auflisten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Subscribe to Job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/subscribe-job", "host": [ "{{base_url}}" ], "path": [ "webhooks", "subscribe-job" ] }, "description": "Einmal-Webhook-Subscription fuer eine bestimmte Job-ID erstellen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "Job-ID (Pflicht, alphanumerisch, max 128 Zeichen) (required)" }, { "key": "url", "value": "", "type": "text", "description": "Webhook-Ziel-URL (required)" }, { "key": "secret", "value": "", "type": "text", "description": "HMAC-Secret (wird auto-generiert wenn leer)" }, { "key": "events", "value": "", "type": "text", "description": "Events (default: [job.completed, job.failed])" }, { "key": "headers", "value": "", "type": "text", "description": "Zusaetzliche HTTP-Header" } ] } } }, { "name": "Test Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/test", "host": [ "{{base_url}}" ], "path": [ "webhooks", "test" ] }, "description": "Test-Event an eine Webhook-Subscription senden.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subscription_id", "value": "", "type": "text", "description": "ID der Subscription (Pflicht) (required)" } ] } } }, { "name": "Update Webhook Subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/update", "host": [ "{{base_url}}" ], "path": [ "webhooks", "update" ] }, "description": "Bestehende Webhook-Subscription aktualisieren.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subscription_id", "value": "", "type": "text", "description": "ID der Subscription (Pflicht) (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name" }, { "key": "url", "value": "", "type": "text", "description": "Neue URL" }, { "key": "events", "value": "", "type": "text", "description": "Neue Event-Liste" }, { "key": "secret", "value": "", "type": "text", "description": "Neues Secret" }, { "key": "filters", "value": "", "type": "text", "description": "Neue Filter" }, { "key": "headers", "value": "", "type": "text", "description": "Neue Header" }, { "key": "is_active", "value": "", "type": "text", "description": "Aktiv/Inaktiv setzen" }, { "key": "retry_policy", "value": "", "type": "text", "description": "Neue Retry-Strategie" }, { "key": "max_retries", "value": "", "type": "text", "description": "Neue max. Retries" }, { "key": "timeout_ms", "value": "", "type": "text", "description": "Neuer Timeout" } ] } } }, { "name": "Webhook Delivery Log", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/deliveries", "host": [ "{{base_url}}" ], "path": [ "webhooks", "deliveries" ] }, "description": "Webhook-Delivery-Log abrufen (Zustellungs-Historie).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Webhook System Info", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/webhooks/info", "host": [ "{{base_url}}" ], "path": [ "webhooks", "info" ] }, "description": "Webhook-System Uebersicht: verfuegbare Events, Endpoints, Signatur-Infos.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } } ] }, { "name": "📬 Notifications", "item": [ { "name": "Check Notification Delivery", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/delivery_status", "host": [ "{{base_url}}" ], "path": [ "message_center", "delivery_status" ] }, "description": "Prueft den Zustellstatus einer Notification. Zeigt welche Kanaele erfolgreich waren und welche fehlgeschlagen sind.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "notification_uuid", "value": "", "type": "text", "description": "UUID der Notification (required)" } ] } } }, { "name": "Escalate Notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/escalate", "host": [ "{{base_url}}" ], "path": [ "message_center", "escalate" ] }, "description": "Erzwingt erneuten Versand einer Notification ueber zusaetzliche Kanaele (SMS, Voice Call). Ignoriert User-Preferences und Quiet Hours. Fuer kritische HITL-Tasks die nicht rechtzeitig bearbeitet wurden.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "notification_uuid", "value": "", "type": "text", "description": "UUID der Notification die eskaliert werden soll (required)" }, { "key": "channels", "value": "", "type": "text", "description": "Erzwungene Kanaele" } ] } } }, { "name": "Send Notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/send", "host": [ "{{base_url}}" ], "path": [ "message_center", "send" ] }, "description": "Sendet eine Notification an einen User ueber alle konfigurierten Kanaele (In-App, Web Push, Email, Telegram, SMS, Voice). Der NotificationDispatcher waehlt basierend auf Priority und User-Preferences die optimalen Kanaele.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "target_user_id", "value": "", "type": "text", "description": "Empfaenger User-ID (required)" }, { "key": "category", "value": "workflow", "type": "text", "description": "" }, { "key": "priority", "value": "normal", "type": "text", "description": "" }, { "key": "title", "value": "", "type": "text", "description": "Notification Titel (required)" }, { "key": "message", "value": "", "type": "text", "description": "Notification Nachricht (required)" }, { "key": "action_url", "value": "", "type": "text", "description": "Deep-Link URL" }, { "key": "action_label", "value": "", "type": "text", "description": "Button-Text fuer den Action-Link" } ] } } }, { "name": "Send Task Alert", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/send_task_alert", "host": [ "{{base_url}}" ], "path": [ "message_center", "send_task_alert" ] }, "description": "Sendet eine HITL-Task-spezifische Benachrichtigung. Loest automatisch SLA-basierte Priority-Berechnung aus und verhindert Duplikate (60s Dedup). Unterstuetzt cross-tenant Task-Lookup via Redis routing-key.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "task_uuid", "value": "", "type": "text", "description": "UUID des Workflow-Tasks (required)" }, { "key": "alert_type", "value": "task_assigned", "type": "text", "description": "" } ] } } }, { "name": "Update Notification Preferences", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/preferences", "host": [ "{{base_url}}" ], "path": [ "message_center", "preferences" ] }, "description": "Aktualisiert die Notification-Einstellungen eines Users: aktivierte Kanaele pro Kategorie, Quiet Hours, AI-Features.\n\n💰 **Kosten**: Kostenlos", "body": { "mode": "formdata", "formdata": [ { "key": "channels_enabled", "value": "", "type": "text", "description": "Kanaele pro Kategorie: {\"workflow\": [\"in_app\", \"email\"], ...}" }, { "key": "quiet_hours_enabled", "value": "", "type": "text", "description": "" }, { "key": "quiet_hours_start", "value": "", "type": "text", "description": "Start-Zeit HH:MM" }, { "key": "quiet_hours_end", "value": "", "type": "text", "description": "End-Zeit HH:MM" } ] } } } ] }, { "name": "📧 Fake Email Detection", "item": [ { "name": "Add domain", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Add Custom Domain Add a domain to the disposable or whitelist database. --- When to Use - Report new disposable domains - Whitelist trusted domains - Customize detection for your use case --- Parameters JSON Body | Parameter | Type | Required | Description | |-----------|------|----------|-------...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "domain", "value": "", "type": "text", "description": "Domain-Name (z.B. spam-provider.com) (required)" }, { "key": "type", "value": "disposable", "type": "text", "description": "Listentyp" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Add Custom Domain Add a domain to the disposable or whitelist database. --- When to Use - Report new disposable domains - Whitelist trusted domains - Customize detection for your use case --- Parameters JSON Body | Parameter | Type | Required | Description | |-----------|------|----------|-------...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "domain", "value": "", "type": "text", "description": "Domain-Name (z.B. spam-provider.com) (required)" }, { "key": "type", "value": "disposable", "type": "text", "description": "Listentyp" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"added\": true,\n \"domain\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Check email", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Check Single Email Check if a single email address is fake, disposable, or temporary. --- When to Use - User registration validation - Lead verification - Single email verification --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | email |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "Email address to check" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Check Single Email Check if a single email address is fake, disposable, or temporary. --- When to Use - User registration validation - Lead verification - Single email verification --- Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | email |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "Email address to check" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"is_fake\": true,\n \"score\": 0,\n \"reason\": \"string\",\n \"domain_info\": {},\n \"status\": \"success\"\n}" } ] }, { "name": "Check emails", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bulk Check Multiple Emails Check up to 100 email addresses in a single request. --- When to Use - Clean email lists - Validate imported contacts - Bulk lead verification --- Parameters JSON Body | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | emails |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "emails", "value": "", "type": "text", "description": "Liste von E-Mail-Adressen zur Pruefung (max. 100) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bulk Check Multiple Emails Check up to 100 email addresses in a single request. --- When to Use - Clean email lists - Validate imported contacts - Bulk lead verification --- Parameters JSON Body | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | emails |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "emails", "value": "", "type": "text", "description": "Liste von E-Mail-Adressen zur Pruefung (max. 100) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"results\": [\n {\n \"email\": \"string\",\n \"is_fake\": true,\n \"score\": 0\n }\n ],\n \"total_checked\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Get statistics", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Detection Statistics Retrieve statistics about your fake email detection usage. --- When to Use - Monitor detection rates - Track usage patterns - Generate reports --- Parameters No parameters required. --- Response json { \"stats\": { \"total_checks\": 15420, \"fake_detected\": 2341, \"legitimate\":...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Detection Statistics Retrieve statistics about your fake email detection usage. --- When to Use - Monitor detection rates - Track usage patterns - Generate reports --- Parameters No parameters required. --- Response json { \"stats\": { \"total_checks\": 15420, \"fake_detected\": 2341, \"legitimate\":...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"total_checks\": 0,\n \"fake_detected\": 0,\n \"legitimate\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "🔄 Substitutes", "item": [ { "name": "Active Substitutes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/get_active", "host": [ "{{base_url}}" ], "path": [ "substitutes", "get_active" ] }, "description": "Get active substitutes.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/get_active", "host": [ "{{base_url}}" ], "path": [ "substitutes", "get_active" ] }, "description": "Get active substitutes.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"error\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Create Substitute", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/create", "host": [ "{{base_url}}" ], "path": [ "substitutes", "create" ] }, "description": "Erstellt eine neue Stellvertretungs-Regel mit Zeitraum und Berechtigungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "substitute_user_id", "value": "", "type": "text", "description": "Benutzer-ID des Stellvertreters, der die Vertretung uebernimmt (required)" }, { "key": "start_date", "value": "", "type": "text", "description": "Startdatum der Vertretung (ISO 8601, optional)" }, { "key": "end_date", "value": "", "type": "text", "description": "Enddatum der Vertretung (ISO 8601, optional)" }, { "key": "substitute_id", "value": "", "type": "text", "description": "Substitute id" }, { "key": "valid_from", "value": "", "type": "text", "description": "Valid from" }, { "key": "valid_until", "value": "", "type": "text", "description": "Valid until" }, { "key": "scope", "value": "", "type": "text", "description": "Scope" }, { "key": "scope_filter", "value": "", "type": "text", "description": "Scope filter" }, { "key": "can_approve", "value": "", "type": "text", "description": "Can approve (required)" }, { "key": "notify_original", "value": "", "type": "text", "description": "Notify original (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Reason" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/create", "host": [ "{{base_url}}" ], "path": [ "substitutes", "create" ] }, "description": "Erstellt eine neue Stellvertretungs-Regel mit Zeitraum und Berechtigungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "substitute_user_id", "value": "", "type": "text", "description": "Benutzer-ID des Stellvertreters, der die Vertretung uebernimmt (required)" }, { "key": "start_date", "value": "", "type": "text", "description": "Startdatum der Vertretung (ISO 8601, optional)" }, { "key": "end_date", "value": "", "type": "text", "description": "Enddatum der Vertretung (ISO 8601, optional)" }, { "key": "substitute_id", "value": "", "type": "text", "description": "Substitute id" }, { "key": "valid_from", "value": "", "type": "text", "description": "Valid from" }, { "key": "valid_until", "value": "", "type": "text", "description": "Valid until" }, { "key": "scope", "value": "", "type": "text", "description": "Scope" }, { "key": "scope_filter", "value": "", "type": "text", "description": "Scope filter" }, { "key": "can_approve", "value": "", "type": "text", "description": "Can approve (required)" }, { "key": "notify_original", "value": "", "type": "text", "description": "Notify original (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Reason" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"error\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Delegated To Me", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/list_delegated_to_me", "host": [ "{{base_url}}" ], "path": [ "substitutes", "list_delegated_to_me" ] }, "description": "Delegations where I am substitute.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/list_delegated_to_me", "host": [ "{{base_url}}" ], "path": [ "substitutes", "list_delegated_to_me" ] }, "description": "Delegations where I am substitute.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"delegations\": [\n \"string\"\n ],\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Delete Substitute", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/delete", "host": [ "{{base_url}}" ], "path": [ "substitutes", "delete" ] }, "description": "Entfernt eine bestehende Stellvertretungs-Regel.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Vertretungsregelung, die geloescht werden soll (required)" }, { "key": "substitute_id", "value": "", "type": "text", "description": "Substitute id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/delete", "host": [ "{{base_url}}" ], "path": [ "substitutes", "delete" ] }, "description": "Entfernt eine bestehende Stellvertretungs-Regel.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Vertretungsregelung, die geloescht werden soll (required)" }, { "key": "substitute_id", "value": "", "type": "text", "description": "Substitute id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"deleted\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List Substitutes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/list", "host": [ "{{base_url}}" ], "path": [ "substitutes", "list" ] }, "description": "List configured substitutes.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/list", "host": [ "{{base_url}}" ], "path": [ "substitutes", "list" ] }, "description": "List configured substitutes.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"substitutes\": [\n \"string\"\n ],\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Update Substitute", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/update", "host": [ "{{base_url}}" ], "path": [ "substitutes", "update" ] }, "description": "Aktualisiert eine bestehende Stellvertretungs-Regel (Zeitraum, Berechtigungen, Status).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Vertretungsregelung, die aktualisiert werden soll (required)" }, { "key": "substitute_id", "value": "", "type": "text", "description": "Substitute id" }, { "key": "valid_from", "value": "", "type": "text", "description": "Valid from (required)" }, { "key": "valid_until", "value": "", "type": "text", "description": "Valid until (required)" }, { "key": "scope", "value": "", "type": "text", "description": "Scope (required)" }, { "key": "scope_filter", "value": "", "type": "text", "description": "Scope filter (required)" }, { "key": "can_approve", "value": "", "type": "text", "description": "Can approve (required)" }, { "key": "notify_original", "value": "", "type": "text", "description": "Notify original (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Reason (required)" }, { "key": "is_active", "value": "", "type": "text", "description": "Is active (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/substitutes/update", "host": [ "{{base_url}}" ], "path": [ "substitutes", "update" ] }, "description": "Aktualisiert eine bestehende Stellvertretungs-Regel (Zeitraum, Berechtigungen, Status).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID der Vertretungsregelung, die aktualisiert werden soll (required)" }, { "key": "substitute_id", "value": "", "type": "text", "description": "Substitute id" }, { "key": "valid_from", "value": "", "type": "text", "description": "Valid from (required)" }, { "key": "valid_until", "value": "", "type": "text", "description": "Valid until (required)" }, { "key": "scope", "value": "", "type": "text", "description": "Scope (required)" }, { "key": "scope_filter", "value": "", "type": "text", "description": "Scope filter (required)" }, { "key": "can_approve", "value": "", "type": "text", "description": "Can approve (required)" }, { "key": "notify_original", "value": "", "type": "text", "description": "Notify original (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Reason (required)" }, { "key": "is_active", "value": "", "type": "text", "description": "Is active (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"error\": \"string\",\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"updated\": true\n}" } ] } ] }, { "name": "🌐 IP Services", "item": [ { "name": "All information", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Full IP Information Get complete IP geolocation and ISP data. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | ip | string | No | IP address default: caller's IP | Response: Location, ISP, timezone, currency, etc.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "IP address to look up. If omitted, the callers IP is used." }, { "key": "locale", "value": "en", "type": "text", "description": "Response locale (en, de, fr, es, etc.)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Full IP Information Get complete IP geolocation and ISP data. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | ip | string | No | IP address default: caller's IP | Response: Location, ISP, timezone, currency, etc.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "IP address to look up. If omitted, the callers IP is used." }, { "key": "locale", "value": "en", "type": "text", "description": "Response locale (en, de, fr, es, etc.)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"ip\": {\n \"ip\": \"string\",\n \"location\": {},\n \"provider\": {},\n \"status\": \"string\",\n \"locale\": {}\n },\n \"vpn\": {\n \"is_vpn\": true,\n \"is_proxy\": true,\n \"is_relay\": true,\n \"is_datacenter\": true,\n \"is_tor\": true\n },\n \"device\": {},\n \"fingerprint\": {},\n \"weather\": {},\n \"exchangecurrency\": {}\n}" } ] }, { "name": "Country details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Full country intelligence for an IP address. Returns comprehensive country data: - VAT rates, B2B reverse charge rules - Economic zones EU, SEPA, Schengen - Legal system, GDPR status - Address/postal formats - IBAN/SWIFT bank details - Emergency phone numbers - National & regional holidays - Docu...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "Query parameter: ip" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Full country intelligence for an IP address. Returns comprehensive country data: - VAT rates, B2B reverse charge rules - Economic zones EU, SEPA, Schengen - Legal system, GDPR status - Address/postal formats - IBAN/SWIFT bank details - Emergency phone numbers - National & regional holidays - Docu...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "Query parameter: ip" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"capital\": \"string\",\n \"currency\": \"string\",\n \"languages\": [\n \"string\"\n ],\n \"status\": \"success\"\n}" } ] }, { "name": "Country list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get list of all supported countries with basic info. Returns: - Country codes ISO 2-letter - Country names - Currency codes - Primary languages\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "language", "value": "en", "type": "text", "description": "Sprache der Laendernamen (z.B. 'de', 'en', 'fr')." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get list of all supported countries with basic info. Returns: - Country codes ISO 2-letter - Country names - Currency codes - Primary languages\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "language", "value": "en", "type": "text", "description": "Sprache der Laendernamen (z.B. 'de', 'en', 'fr')." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"countries\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\",\n \"jobs\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"templates\": \"string\"\n}" } ] }, { "name": "Device fingerprint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get device fingerprint information. Returns: - device_id - Unique device hash - confidence_score - Fingerprint confidence 0-100 - trust_score - Trust level 0-100 - total_visits - Visit count - first_seen / last_seen - Visit history - known_device - Previously seen device Use for: - Return visitor...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "IP address to analyze for device fingerprint" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get device fingerprint information. Returns: - device_id - Unique device hash - confidence_score - Fingerprint confidence 0-100 - trust_score - Trust level 0-100 - total_visits - Visit count - first_seen / last_seen - Visit history - known_device - Previously seen device Use for: - Return visitor...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "IP address to analyze for device fingerprint" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"fingerprint\": \"string\",\n \"confidence\": 0,\n \"device_info\": {},\n \"status\": \"success\"\n}" } ] }, { "name": "Location only", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "IP Location Only Get basic location data for an IP. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | ip | string | No | IP address default: caller's IP | Response: Country, city, coordinates\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "Query parameter: ip" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "IP Location Only Get basic location data for an IP. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | ip | string | No | IP address default: caller's IP | Response: Country, city, coordinates\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "Query parameter: ip" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"ip\": \"string\",\n \"country\": \"string\",\n \"city\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Vpn detection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Detect VPN, proxy, and anonymization services. Returns: - is_vpn - VPN detected - is_proxy - Proxy server detected - is_tor - TOR exit node - is_datacenter - Datacenter IP cloud hosting - is_relay - Apple Private Relay - score - Risk percentage 0-100% - last_crawl - Last database update Use for: ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "Query parameter: ip" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Detect VPN, proxy, and anonymization services. Returns: - is_vpn - VPN detected - is_proxy - Proxy server detected - is_tor - TOR exit node - is_datacenter - Datacenter IP cloud hosting - is_relay - Apple Private Relay - score - Risk percentage 0-100% - last_crawl - Last database update Use for: ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "ip", "value": "", "type": "text", "description": "Query parameter: ip" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"ip\": \"string\",\n \"is_vpn\": true,\n \"is_proxy\": true,\n \"is_tor\": true,\n \"provider\": \"poai-job_xxx\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "✅ Validation", "item": [ { "name": "Validate All (Email + Phone + Website)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/all", "host": [ "{{base_url}}" ], "path": [ "validate", "all" ] }, "description": "Validate All (Email + Phone + Website)\\n\\nRun all validations at once: email, phone, and website. Only provided fields are validated. Returns combined results with individual risk scores.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| email | string | No | Email address to validate |\\n| phone | string | No | Phone number to validate |\\n| url | string | No | Website URL to validate |\n\n💰 **Kosten**: 20 Credits/request (0.02€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "Email address to validate" }, { "key": "phone", "value": "", "type": "text", "description": "Phone number to validate" }, { "key": "url", "value": "", "type": "text", "description": "Website URL to validate" }, { "key": "website", "value": "", "type": "text", "description": "Website" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/all", "host": [ "{{base_url}}" ], "path": [ "validate", "all" ] }, "description": "Validate All (Email + Phone + Website)\\n\\nRun all validations at once: email, phone, and website. Only provided fields are validated. Returns combined results with individual risk scores.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| email | string | No | Email address to validate |\\n| phone | string | No | Phone number to validate |\\n| url | string | No | Website URL to validate |\n\n💰 **Kosten**: 20 Credits/request (0.02€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "Email address to validate" }, { "key": "phone", "value": "", "type": "text", "description": "Phone number to validate" }, { "key": "url", "value": "", "type": "text", "description": "Website URL to validate" }, { "key": "website", "value": "", "type": "text", "description": "Website" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"results\": [\n \"string\"\n ],\n \"all_valid\": true,\n \"status\": {\n \"code\": 0,\n \"message\": \"string\",\n \"success\": true\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Validate Email Address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/email", "host": [ "{{base_url}}" ], "path": [ "validate", "email" ] }, "description": "Validate Email Address\\n\\nCheck if an email address is valid, fake, disposable, or temporary. Uses format validation, DNS/MX record checks, and the PaperOffice Fake Email Detector database.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| email | string | Yes | Email address to validate |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "Email address to validate (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/email", "host": [ "{{base_url}}" ], "path": [ "validate", "email" ] }, "description": "Validate Email Address\\n\\nCheck if an email address is valid, fake, disposable, or temporary. Uses format validation, DNS/MX record checks, and the PaperOffice Fake Email Detector database.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| email | string | Yes | Email address to validate |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "Email address to validate (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"result\": {\n \"email\": \"string\",\n \"domain\": \"string\",\n \"is_fake\": true,\n \"is_legitimate\": true,\n \"risk_score\": 0,\n \"risk_level\": \"string\",\n \"detection_method\": \"string\",\n \"recommendation\": \"string\",\n \"checks\": {\n \"disposable_domain\": {\n \"is_disposable\": true,\n \"domain\": \"string\"\n },\n \"mx_records\": {\n \"has_mx\": true,\n \"mx_count\": 0,\n \"mx_records\": [\n \"string\"\n ]\n },\n \"patterns\": {\n \"suspicious\": true,\n \"pattern_matches\": [\n \"string\"\n ],\n \"heuristics\": [\n \"string\"\n ]\n },\n \"domain_reputation\": {\n \"risk_addition\": 0,\n \"flags\": [\n \"string\"\n ],\n \"domain\": \"string\"\n }\n },\n \"processing_time\": \"string\",\n \"from_cache\": true\n },\n \"status\": {\n \"code\": 0,\n \"message\": \"string\",\n \"success\": true\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Validate Phone Number", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/phone", "host": [ "{{base_url}}" ], "path": [ "validate", "phone" ] }, "description": "Validate Phone Number\\n\\nValidate a phone number format, detect country, carrier type (mobile/landline), and check if it is a valid number.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| phone | string | Yes | Phone number to validate (with or without country code) |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "", "type": "text", "description": "Phone number to validate (with or without country code, e.g. +49171123456) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/phone", "host": [ "{{base_url}}" ], "path": [ "validate", "phone" ] }, "description": "Validate Phone Number\\n\\nValidate a phone number format, detect country, carrier type (mobile/landline), and check if it is a valid number.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| phone | string | Yes | Phone number to validate (with or without country code) |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "", "type": "text", "description": "Phone number to validate (with or without country code, e.g. +49171123456) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"result\": {\n \"valid\": true,\n \"original\": \"string\",\n \"cleaned\": \"string\",\n \"digits_only\": \"string\",\n \"country_code\": \"string\",\n \"format\": \"string\",\n \"error\": \"string\"\n },\n \"status\": {\n \"code\": 0,\n \"message\": \"string\",\n \"success\": true\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Validate Website URL", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/website", "host": [ "{{base_url}}" ], "path": [ "validate", "website" ] }, "description": "Validate Website URL\\n\\nComprehensive website validation including DNS resolution, HTTP reachability, SSL certificate check, redirect analysis, and risk scoring.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| url | string | Yes | Website URL to validate |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "", "type": "text", "description": "Website URL to validate (e.g. https://example.com) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/validate/website", "host": [ "{{base_url}}" ], "path": [ "validate", "website" ] }, "description": "Validate Website URL\\n\\nComprehensive website validation including DNS resolution, HTTP reachability, SSL certificate check, redirect analysis, and risk scoring.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| url | string | Yes | Website URL to validate |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "", "type": "text", "description": "Website URL to validate (e.g. https://example.com) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"result\": {\n \"url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"valid\": true,\n \"risk_level\": \"string\",\n \"recommendation\": \"string\",\n \"checks\": {\n \"format\": {\n \"passed\": true,\n \"error\": \"string\"\n }\n }\n },\n \"status\": {\n \"code\": 0,\n \"message\": \"string\",\n \"success\": true\n },\n \"processing_time\": \"string\"\n}" } ] } ] }, { "name": "🔏 Fingerprint", "item": [ { "name": "Api stats", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/fingerprint/stats", "host": [ "{{base_url}}" ], "path": [ "fingerprint", "stats" ] }, "description": "Get API Statistics V2 Enhanced! Check available features, storage info, and detailed metrics. Response: json { \"status\": \"success\", \"version\": \"2.0.0\", \"stats\": { \"totalFingerprints\": 12345, \"todayNew\": 150, \"todayActive\": 890, \"vpnDetected\": 23, \"botsDetected\": 5, \"avgConfidence\": 87.5 }, \"featu...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/fingerprint/stats", "host": [ "{{base_url}}" ], "path": [ "fingerprint", "stats" ] }, "description": "Get API Statistics V2 Enhanced! Check available features, storage info, and detailed metrics. Response: json { \"status\": \"success\", \"version\": \"2.0.0\", \"stats\": { \"totalFingerprints\": 12345, \"todayNew\": 150, \"todayActive\": 890, \"vpnDetected\": 23, \"botsDetected\": 5, \"avgConfidence\": 87.5 }, \"featu...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"total_requests\": 0,\n \"unique_devices\": 0,\n \"blocked_attempts\": 0\n }\n }\n}" } ] }, { "name": "Device details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Device Details Retrieve details about a known device. Response: json { \"status\": \"success\", \"device\": { \"visitorId\": \"abc123...\", \"firstSeen\": \"2025-12-19T10:00:00Z\", \"lastSeen\": \"2025-12-19T18:30:00Z\", \"visits\": 42, \"browser\": \"Chrome\", \"platform\": \"Windows\", \"country\": \"DE\" } }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Visitor-ID des Geraets (32 Zeichen) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Device Details Retrieve details about a known device. Response: json { \"status\": \"success\", \"device\": { \"visitorId\": \"abc123...\", \"firstSeen\": \"2025-12-19T10:00:00Z\", \"lastSeen\": \"2025-12-19T18:30:00Z\", \"visits\": 42, \"browser\": \"Chrome\", \"platform\": \"Windows\", \"country\": \"DE\" } }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Visitor-ID des Geraets (32 Zeichen) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"device_id\": \"string\",\n \"browser\": \"string\",\n \"os\": \"string\",\n \"last_seen\": \"string\"\n }\n }\n}" } ] }, { "name": "Device v2", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Identify a Device V2! Main endpoint for device identification. Uses vector embeddings, IP clustering, and velocity checks. V2 Features: - Vector embeddings for accurate device matching - Automatic IP clustering for household detection - Velocity tracking for fraud detection - Device linking and s...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "components", "value": "", "type": "text", "description": "Client-seitige Fingerprint-Komponenten vom JavaScript SDK (Canvas, WebGL, Audio, Fonts, Behavioral)" }, { "key": "include", "value": "", "type": "text", "description": "Kommagetrennte Enrichment-Module (z.B. anonymity,currency) oder core fuer minimale Response" }, { "key": "language", "value": "en", "type": "text", "description": "Sprachcode fuer angereicherte Daten (ISO 639-1)" }, { "key": "visitorId", "value": "", "type": "text", "description": "Vom Client vorberechnete Visitor-ID" }, { "key": "confidence", "value": 0, "type": "text", "description": "Client-seitig berechneter Konfidenz-Score (0-100)" }, { "key": "botDetection", "value": "", "type": "text", "description": "Client-seitige Bot-Erkennungsdaten mit signals-Array" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Identify a Device V2! Main endpoint for device identification. Uses vector embeddings, IP clustering, and velocity checks. V2 Features: - Vector embeddings for accurate device matching - Automatic IP clustering for household detection - Velocity tracking for fraud detection - Device linking and s...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "components", "value": "", "type": "text", "description": "Client-seitige Fingerprint-Komponenten vom JavaScript SDK (Canvas, WebGL, Audio, Fonts, Behavioral)" }, { "key": "include", "value": "", "type": "text", "description": "Kommagetrennte Enrichment-Module (z.B. anonymity,currency) oder core fuer minimale Response" }, { "key": "language", "value": "en", "type": "text", "description": "Sprachcode fuer angereicherte Daten (ISO 639-1)" }, { "key": "visitorId", "value": "", "type": "text", "description": "Vom Client vorberechnete Visitor-ID" }, { "key": "confidence", "value": 0, "type": "text", "description": "Client-seitig berechneter Konfidenz-Score (0-100)" }, { "key": "botDetection", "value": "", "type": "text", "description": "Client-seitige Bot-Erkennungsdaten mit signals-Array" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"device_id\": \"string\",\n \"confidence\": 0,\n \"is_known\": true,\n \"risk_score\": 0\n }\n }\n}" } ] }, { "name": "Find Similar Devices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Find Similar Devices V2! Uses vector embeddings to find devices with similar fingerprint components. Use Cases: - Cross-browser detection same user, different browser - Device clustering - Fraud detection Response: json { \"status\": \"success\", \"visitor_id\": \"abc123...\", \"similar_devices\": { \"visit...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Visitor-ID des Referenz-Geraets (32 Zeichen SHA-256 Hash) (required)" }, { "key": "threshold", "value": 0.7, "type": "text", "description": "Schwellenwert fuer Aehnlichkeit (0.0-1.0)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Find Similar Devices V2! Uses vector embeddings to find devices with similar fingerprint components. Use Cases: - Cross-browser detection same user, different browser - Device clustering - Fraud detection Response: json { \"status\": \"success\", \"visitor_id\": \"abc123...\", \"similar_devices\": { \"visit...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Visitor-ID des Referenz-Geraets (32 Zeichen SHA-256 Hash) (required)" }, { "key": "threshold", "value": 0.7, "type": "text", "description": "Schwellenwert fuer Aehnlichkeit (0.0-1.0)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"devices\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Get Linked Devices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Linked Devices via IP Clustering V2! Finds all devices that have been seen on the same IP address same network/household. Use Cases: - Household detection - Account sharing detection - Family plan verification Response: json { \"status\": \"success\", \"visitor_id\": \"abc123...\", \"same_network\": \"d...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Visitor-ID fuer Netzwerk-Verknuepfungssuche (32 Zeichen) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Linked Devices via IP Clustering V2! Finds all devices that have been seen on the same IP address same network/household. Use Cases: - Household detection - Account sharing detection - Family plan verification Response: json { \"status\": \"success\", \"visitor_id\": \"abc123...\", \"same_network\": \"d...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Visitor-ID fuer Netzwerk-Verknuepfungssuche (32 Zeichen) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"devices\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Sdk esm", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get JavaScript SDK ES Module Version Returns the ES Module version of the SDK for modern JavaScript bundlers Vite, Webpack, etc.. Usage with ES Modules: javascript import PaperOfficeFingerprint from 'https://api.paperoffice.ai/latest/fingerprint/sdk.esm'; const fp = await PaperOfficeFingerprint.load...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get JavaScript SDK ES Module Version Returns the ES Module version of the SDK for modern JavaScript bundlers Vite, Webpack, etc.. Usage with ES Modules: javascript import PaperOfficeFingerprint from 'https://api.paperoffice.ai/latest/fingerprint/sdk.esm'; const fp = await PaperOfficeFingerprint.load...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"content_type\": \"string\",\n \"body\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Sdk global", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get JavaScript SDK Global/IIFE Version Returns the JavaScript SDK for browser integration via tag. Usage: html PaperOfficeFingerprint.load.thenfp => { fp.get.thenresult => console.logresult; }; Also available: - /fingerprint/sdk.esm - ES Module version - /fingerprint/sdk.min - Minified version\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get JavaScript SDK Global/IIFE Version Returns the JavaScript SDK for browser integration via tag. Usage: html PaperOfficeFingerprint.load.thenfp => { fp.get.thenresult => console.logresult; }; Also available: - /fingerprint/sdk.esm - ES Module version - /fingerprint/sdk.min - Minified version\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"content_type\": \"string\",\n \"body\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Sdk minified", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get JavaScript SDK Minified Version Returns the minified, production-ready SDK with 24-hour browser caching. Recommended for Production: html Benefits: - Smaller file size - Longer cache duration 24h vs 1h - Faster loading times\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get JavaScript SDK Minified Version Returns the minified, production-ready SDK with 24-hour browser caching. Recommended for Production: html Benefits: - Smaller file size - Longer cache duration 24h vs 1h - Faster loading times\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"content_type\": \"string\",\n \"body\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Verify fingerprint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Verify Fingerprint Check if current visitor matches a known fingerprint. Response: json { \"status\": \"success\", \"verified\": true, \"matchScore\": 85, \"confidence\": \"high\", \"visitorId\": \"abc123...\", \"lastSeen\": \"2025-12-19T18:30:00Z\", \"visits\": 42 }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "visitorId", "value": "abc123def456...", "type": "text", "description": "Expected visitor ID to verify against" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Verify Fingerprint Check if current visitor matches a known fingerprint. Response: json { \"status\": \"success\", \"verified\": true, \"matchScore\": 85, \"confidence\": \"high\", \"visitorId\": \"abc123...\", \"lastSeen\": \"2025-12-19T18:30:00Z\", \"visits\": 42 }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "visitorId", "value": "abc123def456...", "type": "text", "description": "Expected visitor ID to verify against" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"verified\": true,\n \"confidence\": 0\n }\n }\n}" } ] } ] }, { "name": "🌐 Translation", "item": [ { "name": "Get Supported Languages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/translate/languages", "host": [ "{{base_url}}" ], "path": [ "translate", "languages" ] }, "description": "Get Supported Translation Languages\\n\\nReturns a list of all supported languages for AI-powered translation. Includes language codes (ISO 639-1) and native names.\\n\\n--- When to Use\\n- Before translating, to check available target languages\\n- To build language selectors in your UI\\n- To validate language codes before calling translate/single or translate/batch\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/translate/languages", "host": [ "{{base_url}}" ], "path": [ "translate", "languages" ] }, "description": "Get Supported Translation Languages\\n\\nReturns a list of all supported languages for AI-powered translation. Includes language codes (ISO 639-1) and native names.\\n\\n--- When to Use\\n- Before translating, to check available target languages\\n- To build language selectors in your UI\\n- To validate language codes before calling translate/single or translate/batch\n\n💰 **Kosten**: 1 Credits/request (0.001€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"processing_time\": \"string\",\n \"data\": {\n \"languages\": {},\n \"default_base\": \"string\",\n \"total\": 0,\n \"model\": \"string\"\n },\n \"languages\": \"string\",\n \"default_base\": \"string\",\n \"total\": \"string\",\n \"model\": \"string\"\n}" } ] }, { "name": "Translate Batch", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/translate/batch", "host": [ "{{base_url}}" ], "path": [ "translate", "batch" ] }, "description": "Translate Batch\\n\\nTranslate multiple texts into multiple target languages at once. Maximum 50 items and 10 target languages per request.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| items | array | Yes | Array of strings or objects with key+text (max 50) |\\n| target_languages | array | Yes | Array of target language codes (max 10) |\\n| source_language | string | No | Source language code (default: auto) |\\n| context | string | No | Translation context (default: general) |\n\n💰 **Kosten**: 50 Credits/request (0.05€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "items", "value": "", "type": "text", "description": "Array of texts to translate (max 50) (required)" }, { "key": "target_languages", "value": "", "type": "text", "description": "Array of target language ISO codes (max 10) (required)" }, { "key": "source_language", "value": "auto", "type": "text", "description": "Source language ISO code or auto" }, { "key": "context", "value": "general", "type": "text", "description": "Translation context" }, { "key": "model", "value": "", "type": "text", "description": "Model" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/translate/batch", "host": [ "{{base_url}}" ], "path": [ "translate", "batch" ] }, "description": "Translate Batch\\n\\nTranslate multiple texts into multiple target languages at once. Maximum 50 items and 10 target languages per request.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| items | array | Yes | Array of strings or objects with key+text (max 50) |\\n| target_languages | array | Yes | Array of target language codes (max 10) |\\n| source_language | string | No | Source language code (default: auto) |\\n| context | string | No | Translation context (default: general) |\n\n💰 **Kosten**: 50 Credits/request (0.05€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "items", "value": "", "type": "text", "description": "Array of texts to translate (max 50) (required)" }, { "key": "target_languages", "value": "", "type": "text", "description": "Array of target language ISO codes (max 10) (required)" }, { "key": "source_language", "value": "auto", "type": "text", "description": "Source language ISO code or auto" }, { "key": "context", "value": "general", "type": "text", "description": "Translation context" }, { "key": "model", "value": "", "type": "text", "description": "Model" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"translations\": [\n {\n \"original\": \"string\",\n \"translated\": \"string\"\n }\n ],\n \"source_language\": \"string\",\n \"target_language\": \"string\",\n \"processing_time\": \"string\",\n \"data\": \"string\",\n \"target_languages\": \"string\",\n \"items_count\": \"string\",\n \"languages_count\": \"string\",\n \"context\": \"string\",\n \"model\": \"string\",\n \"total_processing_time\": \"string\"\n}" } ] }, { "name": "Translate Single Text", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/translate/single", "host": [ "{{base_url}}" ], "path": [ "translate", "single" ] }, "description": "Translate Single Text\\n\\nTranslate a single text from one language to another using AI (LLM-powered). Supports auto-detection of source language. Maximum 50,000 characters.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| text | string | Yes | Text to translate (max 50,000 chars) |\\n| target_language | string | Yes | Target language code (e.g. en, de, fr, es) |\\n| source_language | string | No | Source language code (default: auto-detect) |\\n| context | string | No | Translation context: general, legal, medical, technical (default: general) |\n\n💰 **Kosten**: 30 Credits/request (0.03€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "", "type": "text", "description": "Text to translate (max 50000 chars) (required)" }, { "key": "target_language", "value": "", "type": "text", "description": "Target language ISO code (e.g. en, de, fr, es, it, pt, nl, pl, ru, ja, zh, ko, ar) (required)" }, { "key": "source_language", "value": "auto", "type": "text", "description": "Source language ISO code or auto for auto-detection" }, { "key": "context", "value": "general", "type": "text", "description": "Translation context for better quality" }, { "key": "model", "value": "", "type": "text", "description": "Model" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/translate/single", "host": [ "{{base_url}}" ], "path": [ "translate", "single" ] }, "description": "Translate Single Text\\n\\nTranslate a single text from one language to another using AI (LLM-powered). Supports auto-detection of source language. Maximum 50,000 characters.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| text | string | Yes | Text to translate (max 50,000 chars) |\\n| target_language | string | Yes | Target language code (e.g. en, de, fr, es) |\\n| source_language | string | No | Source language code (default: auto-detect) |\\n| context | string | No | Translation context: general, legal, medical, technical (default: general) |\n\n💰 **Kosten**: 30 Credits/request (0.03€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "text", "value": "", "type": "text", "description": "Text to translate (max 50000 chars) (required)" }, { "key": "target_language", "value": "", "type": "text", "description": "Target language ISO code (e.g. en, de, fr, es, it, pt, nl, pl, ru, ja, zh, ko, ar) (required)" }, { "key": "source_language", "value": "auto", "type": "text", "description": "Source language ISO code or auto for auto-detection" }, { "key": "context", "value": "general", "type": "text", "description": "Translation context for better quality" }, { "key": "model", "value": "", "type": "text", "description": "Model" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"translated_text\": \"string\",\n \"source_language\": \"string\",\n \"target_language\": \"string\",\n \"confidence\": 0,\n \"processing_time\": \"string\",\n \"data\": {\n \"translated_text\": \"string\",\n \"source_language\": \"string\",\n \"target_language\": \"string\",\n \"confidence\": 0\n },\n \"translation\": \"string\"\n}" } ] } ] }, { "name": "⚡ Job Management", "item": [ { "name": "Get pricelist", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job/pricelist", "host": [ "{{base_url}}" ], "path": [ "job", "pricelist" ] }, "description": "Get API Pricelist Returns all available API methods with their credit costs. Cost: 10 Credits Response: json { \"pricelist\": { \"paperoffice_llm___generate___basic\": { \"credits\": 30, \"unit\": \"page\", \"description\": \"PaperOffice Basic - OCR + Vision\" }, \"ip2location___full\": { \"credits\": 0.01, \"unit\"...\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job/pricelist", "host": [ "{{base_url}}" ], "path": [ "job", "pricelist" ] }, "description": "Get API Pricelist Returns all available API methods with their credit costs. Cost: 10 Credits Response: json { \"pricelist\": { \"paperoffice_llm___generate___basic\": { \"credits\": 30, \"unit\": \"page\", \"description\": \"PaperOffice Basic - OCR + Vision\" }, \"ip2location___full\": { \"credits\": 0.01, \"unit\"...\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"pricelist\": {},\n \"tiers\": {\n \"app_tiers\": {},\n \"api_tiers\": {},\n \"sla_tiers\": {},\n \"free_tiers\": {},\n \"app_free\": {}\n },\n \"resource_billing\": {},\n \"priority_system\": {},\n \"priority_boost_calculator\": {\n \"_formula\": \"string\",\n \"_description\": \"string\",\n \"priority_levels\": {}\n },\n \"support_actions\": {},\n \"global_addons\": {},\n \"units\": {},\n \"meta\": {\n \"pricing_rule\": \"string\",\n \"last_updated\": \"string\"\n },\n \"_billing\": {},\n \"processing_time\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"job_type\": \"poai-job_xxx\",\n \"pipeline\": \"string\",\n \"operation\": \"string\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Health check", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/health/infrastructure", "host": [ "{{base_url}}" ], "path": [ "health", "infrastructure" ] }, "description": "API Health Check Returns the current status of the API and all connected services. No Authentication Required Response: json { \"status\": \"healthy\", \"version\": \"3.0.0\", \"timestamp\": \"2025-01-15T12:00:00Z\", \"services\": { \"redis\": \"connected\", \"database\": \"connected\", \"llm_pipeline\": \"running\", \"PDF...\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/health/infrastructure", "host": [ "{{base_url}}" ], "path": [ "health", "infrastructure" ] }, "description": "API Health Check Returns the current status of the API and all connected services. No Authentication Required Response: json { \"status\": \"healthy\", \"version\": \"3.0.0\", \"timestamp\": \"2025-01-15T12:00:00Z\", \"services\": { \"redis\": \"connected\", \"database\": \"connected\", \"llm_pipeline\": \"running\", \"PDF...\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"status\": \"healthy\",\n \"services\": {},\n \"uptime\": 0,\n \"job_id\": \"poai-job_xxx\",\n \"job_type\": \"poai-job_xxx\",\n \"pipeline\": \"string\",\n \"operation\": \"string\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Job generic", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job/add/{pipeline_name}", "host": [ "{{base_url}}" ], "path": [ "job", "add", "{pipeline_name}" ] }, "description": "Create a new processing job. Pipelines: paperoffice_llm___generate, paperoffice_aiocr___generate, pdfstudio___pdf_to_word, etc. Priority: - ≥900 = Synchronous waits for result - Default: 900 -\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File to process" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync waits for result," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job/add/{pipeline_name}", "host": [ "{{base_url}}" ], "path": [ "job", "add", "{pipeline_name}" ] }, "description": "Create a new processing job. Pipelines: paperoffice_llm___generate, paperoffice_aiocr___generate, pdfstudio___pdf_to_word, etc. Priority: - ≥900 = Synchronous waits for result - Default: 900 -\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File to process" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync waits for result," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {}\n },\n \"job_type\": \"poai-job_xxx\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] }, { "name": "Management ping", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/health", "host": [ "{{base_url}}" ], "path": [ "health" ] }, "description": "Simple Ping Basic connectivity check. Returns \"pong\" if API is reachable. No Authentication Required Response: json { \"status\": \"pong\", \"timestamp\": 1736942400 }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/health", "host": [ "{{base_url}}" ], "path": [ "health" ] }, "description": "Simple Ping Basic connectivity check. Returns \"pong\" if API is reachable. No Authentication Required Response: json { \"status\": \"pong\", \"timestamp\": 1736942400 }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"pong\": true,\n \"timestamp\": \"string\",\n \"server\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Status result", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Job Status / Result Retrieve the status and result of an async job. URL Parameter: | Parameter | Type | Description | |-----------|------|-------------| | job_id | string | The job ID returned from the create job request | Response Processing: json { \"status\": \"processing\", \"job_id\": \"poai-jo...\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "The job ID returned by a previous tool call (format: poai-job_XXX_TIMESTAMP_HASH) (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Job Status / Result Retrieve the status and result of an async job. URL Parameter: | Parameter | Type | Description | |-----------|------|-------------| | job_id | string | The job ID returned from the create job request | Response Processing: json { \"status\": \"processing\", \"job_id\": \"poai-jo...\n\n💰 **Kosten**: 10 Credits/poll (0.01€/poll)", "body": { "mode": "formdata", "formdata": [ { "key": "job_id", "value": "", "type": "text", "description": "The job ID returned by a previous tool call (format: poai-job_XXX_TIMESTAMP_HASH) (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"job_status\": \"waiting\",\n \"progress\": 0,\n \"result\": {},\n \"queue_position\": 0,\n \"estimated_time_ms\": 0,\n \"processing_time\": \"string\",\n \"job_type\": \"poai-job_xxx\",\n \"pipeline\": \"string\",\n \"operation\": \"string\",\n \"model\": \"string\",\n \"current_step\": \"string\"\n}" } ] } ] }, { "name": "🧾 VAT Validation", "item": [ { "name": "Get EU VAT Rates", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/vat/rates", "host": [ "{{base_url}}" ], "path": [ "vat", "rates" ] }, "description": "Get EU VAT Rates\\n\\nReturns current VAT rates for all 27 EU member states including standard and reduced rates.\\n\\n--- Parameters\\nNo parameters required.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/vat/rates", "host": [ "{{base_url}}" ], "path": [ "vat", "rates" ] }, "description": "Get EU VAT Rates\\n\\nReturns current VAT rates for all 27 EU member states including standard and reduced rates.\\n\\n--- Parameters\\nNo parameters required.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"rates\": {\n \"AT\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"BE\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"BG\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"CY\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"CZ\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"DE\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"DK\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"EE\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"EL\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"ES\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"FI\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"FR\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"HR\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"HU\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"IE\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"IT\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"LT\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"LU\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"LV\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"MT\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"NL\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"PL\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"PT\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"RO\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"SE\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"SI\": {\n \"standard\": 0,\n \"reduced\": 0\n },\n \"SK\": {\n \"standard\": 0,\n \"reduced\": 0\n }\n },\n \"count\": 0,\n \"_billing\": {\n \"credits\": {\n \"used\": 0,\n \"remaining\": \"string\",\n \"monthly\": \"string\"\n },\n \"job\": {\n \"name\": \"string\",\n \"cost\": 0\n },\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n },\n \"_note\": \"string\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Validate EU VAT ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/vat/validate", "host": [ "{{base_url}}" ], "path": [ "vat", "validate" ] }, "description": "Validate EU VAT ID\\n\\nValidate a European VAT identification number against the EU VIES database. Returns company name, address, validity status, tax context (VAT rates), and optional fraud risk assessment.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| vat_id | string | Yes | EU VAT ID (e.g. DE123456789, FR12345678901, NL123456789B01) |\\n| ip | string | No | IP for fraud cross-check |\\n| email | string | No | Email for fraud cross-check |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "vat_id", "value": "", "type": "text", "description": "EU VAT identification number (e.g. DE123456789, FR12345678901) (required)" }, { "key": "ip", "value": "", "type": "text", "description": "IP address for fraud cross-check (optional)" }, { "key": "email", "value": "", "type": "text", "description": "Email for fraud cross-check (optional)" }, { "key": "force_recheck", "value": "", "type": "text", "description": "Force recheck" }, { "key": "geocoding", "value": "", "type": "text", "description": "Geocoding" }, { "key": "vat_ids", "value": "", "type": "text", "description": "Vat ids" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/vat/validate", "host": [ "{{base_url}}" ], "path": [ "vat", "validate" ] }, "description": "Validate EU VAT ID\\n\\nValidate a European VAT identification number against the EU VIES database. Returns company name, address, validity status, tax context (VAT rates), and optional fraud risk assessment.\\n\\n--- Parameters\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| vat_id | string | Yes | EU VAT ID (e.g. DE123456789, FR12345678901, NL123456789B01) |\\n| ip | string | No | IP for fraud cross-check |\\n| email | string | No | Email for fraud cross-check |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "vat_id", "value": "", "type": "text", "description": "EU VAT identification number (e.g. DE123456789, FR12345678901) (required)" }, { "key": "ip", "value": "", "type": "text", "description": "IP address for fraud cross-check (optional)" }, { "key": "email", "value": "", "type": "text", "description": "Email for fraud cross-check (optional)" }, { "key": "force_recheck", "value": "", "type": "text", "description": "Force recheck" }, { "key": "geocoding", "value": "", "type": "text", "description": "Geocoding" }, { "key": "vat_ids", "value": "", "type": "text", "description": "Vat ids" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"vat_id\": \"poai-job_xxx\",\n \"format_valid\": true,\n \"error\": \"string\",\n \"message\": \"string\",\n \"layer\": \"string\",\n \"processing_time_ms\": 0,\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"processing_time\": \"string\",\n \"count\": \"string\",\n \"results\": \"string\"\n}" } ] } ] }, { "name": "🏷️ Meta Fields", "item": [ { "name": "Meta fields", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/meta_fields/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "meta_fields", "{document_id}" ] }, "description": "Get all AI-IDP extracted meta fields for a document by category: financial, parties, dates, classification, analysis.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/meta_fields/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "meta_fields", "{document_id}" ] }, "description": "Get all AI-IDP extracted meta fields for a document by category: financial, parties, dates, classification, analysis.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"fields\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Crm", "item": [ { "name": "CRM: Dashboard-Übersicht", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=dashboard", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=dashboard" ] }, "description": "Gibt die CRM-Dashboard-Daten zurück: Pipeline-Statistiken (Anzahl/Wert pro Stage), Gesamtübersicht (Leads, Accounts, Contacts, Opportunities, Cases), Conversion-Rate und Top-Leads.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=dashboard", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=dashboard" ] }, "description": "Gibt die CRM-Dashboard-Daten zurück: Pipeline-Statistiken (Anzahl/Wert pro Stage), Gesamtübersicht (Leads, Accounts, Contacts, Opportunities, Cases), Conversion-Rate und Top-Leads.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"accounts\": 0,\n \"contacts\": 0,\n \"leads\": {\n \"total\": 0,\n \"new\": 0\n },\n \"opportunities\": {\n \"total\": 0,\n \"pipeline_value\": 0\n },\n \"cases\": {\n \"open\": 0\n },\n \"conversion_rate\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Pipeline-Zusammenfassung", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=pipeline-summary", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=pipeline-summary" ] }, "description": "Gibt eine detaillierte Pipeline-Zusammenfassung mit Opportunities pro Stage (Anzahl und Gesamtwert) zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=pipeline-summary", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=pipeline-summary" ] }, "description": "Gibt eine detaillierte Pipeline-Zusammenfassung mit Opportunities pro Stage (Anzahl und Gesamtwert) zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"leads_by_status\": [\n \"string\"\n ],\n \"leads_by_grade\": [\n \"string\"\n ],\n \"opportunities_by_stage\": [\n \"string\"\n ],\n \"totals\": {\n \"leads\": 0,\n \"contacts\": 0,\n \"accounts\": 0,\n \"opportunities\": 0,\n \"pipeline_value\": 0,\n \"won_value\": 0\n },\n \"conversion_rates\": {\n \"lead_to_opportunity\": 0,\n \"opportunity_to_won\": 0\n }\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: KI-Insights", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=insights", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=insights" ] }, "description": "Gibt KI-basierte Insights zurück: Top Leads (nach AI-Score), Pipeline-Forecast, Churn-Risk-Accounts und Sentiment-Analyse.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=insights", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=insights" ] }, "description": "Gibt KI-basierte Insights zurück: Top Leads (nach AI-Score), Pipeline-Forecast, Churn-Risk-Accounts und Sentiment-Analyse.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"churn_risk\": [\n \"string\"\n ],\n \"sentiment\": {\n \"total_accounts\": 0,\n \"avg_score\": \"string\",\n \"healthy\": \"string\",\n \"neutral\": \"string\",\n \"critical\": \"string\",\n \"sentiment_label\": \"string\",\n \"sentiment_emoji\": \"string\"\n },\n \"top_leads\": [\n \"string\"\n ],\n \"pipeline\": {\n \"total_open\": 0,\n \"total_value\": \"string\",\n \"avg_probability\": \"string\",\n \"weighted_value\": \"string\"\n }\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Funnel-KPIs", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=funnel_kpis", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=funnel_kpis" ] }, "description": "Gibt KPI-Daten für den Vertriebs-Funnel zurück: Conversion-Raten, Durchlaufzeiten, Drop-Off-Raten pro Stage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=funnel_kpis", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=funnel_kpis" ] }, "description": "Gibt KPI-Daten für den Vertriebs-Funnel zurück: Conversion-Raten, Durchlaufzeiten, Drop-Off-Raten pro Stage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"period\": \"string\",\n \"period_label\": \"string\",\n \"generated_at\": \"string\",\n \"daily\": {\n \"new_leads\": 0,\n \"appointments_booked\": 0,\n \"appointments_completed\": 0,\n \"deals_won\": 0,\n \"revenue\": 0,\n \"no_shows\": 0\n },\n \"weekly\": {\n \"lead_to_appointment_conversion\": 0,\n \"appointment_to_demo_conversion\": 0,\n \"demo_to_customer_conversion\": 0,\n \"payment_conversion\": 0,\n \"no_show_rate\": 0,\n \"avg_response_time_minutes\": 0,\n \"channel_preference\": {\n \"phone\": 0,\n \"video\": 0,\n \"email\": 0,\n \"chat\": 0\n }\n },\n \"monthly\": {\n \"total_revenue\": 0,\n \"paid_appointments_revenue\": 0,\n \"deals_revenue\": 0,\n \"average_lead_score\": 0,\n \"paid_appointment_roi\": 0,\n \"credit_usage_rate\": 0\n },\n \"funnel\": {\n \"top\": 0,\n \"middle\": 0,\n \"bottom\": 0,\n \"overall_conversion\": 0\n },\n \"trends\": [\n \"string\"\n ]\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Leads auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_leads", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_leads" ] }, "description": "Listet alle CRM-Leads mit Paginierung, Suche und Sortierung auf. Jeder Lead enthält Name, E-Mail, Firma, Status, AI-Score und Quelle.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_leads", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_leads" ] }, "description": "Listet alle CRM-Leads mit Paginierung, Suche und Sortierung auf. Jeder Lead enthält Name, E-Mail, Firma, Status, AI-Score und Quelle.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"stats\": {\n \"total\": 0,\n \"new\": 0,\n \"contacted\": 0,\n \"qualified\": 0,\n \"disqualified\": 0,\n \"archived\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Lead-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_lead" ] }, "description": "Gibt alle Details eines einzelnen Leads zurück, inklusive Notizen, Aufgaben und zugehöriger Aktivitäten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_lead" ] }, "description": "Gibt alle Details eines einzelnen Leads zurück, inklusive Notizen, Aufgaben und zugehöriger Aktivitäten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Lead erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_lead" ] }, "description": "Erstellt einen neuen Lead im CRM. Mindestens Name oder E-Mail erforderlich.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Leads (required)" }, { "key": "email", "value": "", "type": "text", "description": "E-Mail-Adresse" }, { "key": "company", "value": "", "type": "text", "description": "Firmenname" }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer" }, { "key": "source", "value": "", "type": "text", "description": "Lead-Quelle" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "notes", "value": "", "type": "text", "description": "Notizen" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_lead" ] }, "description": "Erstellt einen neuen Lead im CRM. Mindestens Name oder E-Mail erforderlich.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Leads (required)" }, { "key": "email", "value": "", "type": "text", "description": "E-Mail-Adresse" }, { "key": "company", "value": "", "type": "text", "description": "Firmenname" }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer" }, { "key": "source", "value": "", "type": "text", "description": "Lead-Quelle" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "notes", "value": "", "type": "text", "description": "Notizen" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": \"poai-job_xxx\"\n }\n}" } ] }, { "name": "CRM: Lead aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_lead" ] }, "description": "Aktualisiert einen bestehenden Lead. Nur übergebene Felder werden geändert.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Lead-ID (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "company", "value": "", "type": "text", "description": "Company" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "source", "value": "", "type": "text", "description": "Source" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "notes", "value": "", "type": "text", "description": "Notes" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_lead" ] }, "description": "Aktualisiert einen bestehenden Lead. Nur übergebene Felder werden geändert.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Lead-ID (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "company", "value": "", "type": "text", "description": "Company" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "source", "value": "", "type": "text", "description": "Source" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "notes", "value": "", "type": "text", "description": "Notes" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Lead konvertieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=convert_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=convert_lead" ] }, "description": "Konvertiert einen qualifizierten Lead in einen Account, Kontakt und optional eine Opportunity.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Lead-ID (required)" }, { "key": "create_opportunity", "value": "", "type": "text", "description": "Auch Opportunity erstellen?" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=convert_lead", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=convert_lead" ] }, "description": "Konvertiert einen qualifizierten Lead in einen Account, Kontakt und optional eine Opportunity.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Lead-ID (required)" }, { "key": "create_opportunity", "value": "", "type": "text", "description": "Auch Opportunity erstellen?" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Lead-Score berechnen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=calculate_lead_score", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=calculate_lead_score" ] }, "description": "Berechnet den AI-Score für einen Lead basierend auf Profildaten, Verhalten und Interaktionen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Lead-ID (required)" }, { "key": "lead_id", "value": "", "type": "text", "description": "Lead id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=calculate_lead_score", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=calculate_lead_score" ] }, "description": "Berechnet den AI-Score für einen Lead basierend auf Profildaten, Verhalten und Interaktionen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Lead-ID (required)" }, { "key": "lead_id", "value": "", "type": "text", "description": "Lead id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Accounts auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_accounts", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_accounts" ] }, "description": "Listet alle CRM-Accounts (Firmen/Kunden) mit Paginierung und Suche auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_accounts", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_accounts" ] }, "description": "Listet alle CRM-Accounts (Firmen/Kunden) mit Paginierung und Suche auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Account-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_account", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_account" ] }, "description": "Gibt alle Details eines Accounts zurück, inklusive zugehöriger Kontakte, Opportunities und Aktivitäten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_account", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_account" ] }, "description": "Gibt alle Details eines Accounts zurück, inklusive zugehöriger Kontakte, Opportunities und Aktivitäten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Account erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_account", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_account" ] }, "description": "Erstellt einen neuen Account (Firma/Kunde) im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_name", "value": "", "type": "text", "description": "Firmenname (required)" }, { "key": "account_type", "value": "", "type": "text", "description": "Account type" }, { "key": "industry", "value": "", "type": "text", "description": "Industry" }, { "key": "website", "value": "", "type": "text", "description": "Website" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "street", "value": "", "type": "text", "description": "Street" }, { "key": "billing_address_street", "value": "", "type": "text", "description": "Billing address street" }, { "key": "city", "value": "", "type": "text", "description": "City" }, { "key": "billing_address_city", "value": "", "type": "text", "description": "Billing address city" }, { "key": "postal_code", "value": "", "type": "text", "description": "Postal code" }, { "key": "billing_address_postal_code", "value": "", "type": "text", "description": "Billing address postal code" }, { "key": "country", "value": "", "type": "text", "description": "Country" }, { "key": "billing_address_country", "value": "", "type": "text", "description": "Billing address country" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "assigned_user_id", "value": "", "type": "text", "description": "Assigned user id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_account", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_account" ] }, "description": "Erstellt einen neuen Account (Firma/Kunde) im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_name", "value": "", "type": "text", "description": "Firmenname (required)" }, { "key": "account_type", "value": "", "type": "text", "description": "Account type" }, { "key": "industry", "value": "", "type": "text", "description": "Industry" }, { "key": "website", "value": "", "type": "text", "description": "Website" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "street", "value": "", "type": "text", "description": "Street" }, { "key": "billing_address_street", "value": "", "type": "text", "description": "Billing address street" }, { "key": "city", "value": "", "type": "text", "description": "City" }, { "key": "billing_address_city", "value": "", "type": "text", "description": "Billing address city" }, { "key": "postal_code", "value": "", "type": "text", "description": "Postal code" }, { "key": "billing_address_postal_code", "value": "", "type": "text", "description": "Billing address postal code" }, { "key": "country", "value": "", "type": "text", "description": "Country" }, { "key": "billing_address_country", "value": "", "type": "text", "description": "Billing address country" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "assigned_user_id", "value": "", "type": "text", "description": "Assigned user id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": \"poai-job_xxx\",\n \"uuid\": \"poai-job_xxx\"\n }\n}" } ] }, { "name": "CRM: Account aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_account", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_account" ] }, "description": "Aktualisiert einen bestehenden Account.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Account-ID (required)" }, { "key": "account_name", "value": "", "type": "text", "description": "Account name" }, { "key": "account_type", "value": "", "type": "text", "description": "Account type" }, { "key": "industry", "value": "", "type": "text", "description": "Industry" }, { "key": "website", "value": "", "type": "text", "description": "Website" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "street", "value": "", "type": "text", "description": "Street" }, { "key": "billing_address_street", "value": "", "type": "text", "description": "Billing address street" }, { "key": "city", "value": "", "type": "text", "description": "City" }, { "key": "billing_address_city", "value": "", "type": "text", "description": "Billing address city" }, { "key": "postal_code", "value": "", "type": "text", "description": "Postal code" }, { "key": "billing_address_postal_code", "value": "", "type": "text", "description": "Billing address postal code" }, { "key": "country", "value": "", "type": "text", "description": "Country" }, { "key": "billing_address_country", "value": "", "type": "text", "description": "Billing address country" }, { "key": "description", "value": "", "type": "text", "description": "Description" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_account", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_account" ] }, "description": "Aktualisiert einen bestehenden Account.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Account-ID (required)" }, { "key": "account_name", "value": "", "type": "text", "description": "Account name" }, { "key": "account_type", "value": "", "type": "text", "description": "Account type" }, { "key": "industry", "value": "", "type": "text", "description": "Industry" }, { "key": "website", "value": "", "type": "text", "description": "Website" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "street", "value": "", "type": "text", "description": "Street" }, { "key": "billing_address_street", "value": "", "type": "text", "description": "Billing address street" }, { "key": "city", "value": "", "type": "text", "description": "City" }, { "key": "billing_address_city", "value": "", "type": "text", "description": "Billing address city" }, { "key": "postal_code", "value": "", "type": "text", "description": "Postal code" }, { "key": "billing_address_postal_code", "value": "", "type": "text", "description": "Billing address postal code" }, { "key": "country", "value": "", "type": "text", "description": "Country" }, { "key": "billing_address_country", "value": "", "type": "text", "description": "Billing address country" }, { "key": "description", "value": "", "type": "text", "description": "Description" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": 0\n }\n}" } ] }, { "name": "CRM: Kontakte auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_contacts", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_contacts" ] }, "description": "Listet alle CRM-Kontakte (Personen) mit Paginierung und Suche auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_contacts", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_contacts" ] }, "description": "Listet alle CRM-Kontakte (Personen) mit Paginierung und Suche auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Kontakt-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_contact", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_contact" ] }, "description": "Gibt alle Details eines Kontakts zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_contact", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_contact" ] }, "description": "Gibt alle Details eines Kontakts zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Kontakt erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_contact", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_contact" ] }, "description": "Erstellt einen neuen Kontakt (Person) im CRM. Kann einem Account zugewiesen werden.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "", "type": "text", "description": "First name (required)" }, { "key": "last_name", "value": "", "type": "text", "description": "Last name" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "account_id", "value": "", "type": "text", "description": "Zugehöriger Account" }, { "key": "position", "value": "", "type": "text", "description": "Position" }, { "key": "department", "value": "", "type": "text", "description": "Department" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_contact", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_contact" ] }, "description": "Erstellt einen neuen Kontakt (Person) im CRM. Kann einem Account zugewiesen werden.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "", "type": "text", "description": "First name (required)" }, { "key": "last_name", "value": "", "type": "text", "description": "Last name" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "account_id", "value": "", "type": "text", "description": "Zugehöriger Account" }, { "key": "position", "value": "", "type": "text", "description": "Position" }, { "key": "department", "value": "", "type": "text", "description": "Department" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": \"poai-job_xxx\"\n }\n}" } ] }, { "name": "CRM: Kontakt aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_contact", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_contact" ] }, "description": "Aktualisiert einen bestehenden Kontakt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kontakt-ID (required)" }, { "key": "first_name", "value": "", "type": "text", "description": "First name" }, { "key": "last_name", "value": "", "type": "text", "description": "Last name" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" }, { "key": "position", "value": "", "type": "text", "description": "Position" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_contact", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_contact" ] }, "description": "Aktualisiert einen bestehenden Kontakt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kontakt-ID (required)" }, { "key": "first_name", "value": "", "type": "text", "description": "First name" }, { "key": "last_name", "value": "", "type": "text", "description": "Last name" }, { "key": "email", "value": "", "type": "text", "description": "Email" }, { "key": "phone", "value": "", "type": "text", "description": "Phone" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" }, { "key": "position", "value": "", "type": "text", "description": "Position" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Opportunities auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_opportunities", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_opportunities" ] }, "description": "Listet alle Opportunities (Verkaufschancen) mit Paginierung, Suche und Stage-Filter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_opportunities", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_opportunities" ] }, "description": "Listet alle Opportunities (Verkaufschancen) mit Paginierung, Suche und Stage-Filter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Opportunity-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_opportunity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_opportunity" ] }, "description": "Gibt alle Details einer Opportunity zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_opportunity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_opportunity" ] }, "description": "Gibt alle Details einer Opportunity zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Opportunity erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_opportunity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_opportunity" ] }, "description": "Erstellt eine neue Opportunity (Verkaufschance) im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Opportunity-Name (required)" }, { "key": "amount", "value": "", "type": "text", "description": "Wert in EUR" }, { "key": "stage", "value": "", "type": "text", "description": "Stage" }, { "key": "close_date", "value": "", "type": "text", "description": "Erwartetes Abschlussdatum (YYYY-MM-DD)" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" }, { "key": "probability", "value": "", "type": "text", "description": "Gewinnwahrscheinlichkeit (0-100)" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_opportunity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_opportunity" ] }, "description": "Erstellt eine neue Opportunity (Verkaufschance) im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Opportunity-Name (required)" }, { "key": "amount", "value": "", "type": "text", "description": "Wert in EUR" }, { "key": "stage", "value": "", "type": "text", "description": "Stage" }, { "key": "close_date", "value": "", "type": "text", "description": "Erwartetes Abschlussdatum (YYYY-MM-DD)" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" }, { "key": "probability", "value": "", "type": "text", "description": "Gewinnwahrscheinlichkeit (0-100)" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": \"poai-job_xxx\"\n }\n}" } ] }, { "name": "CRM: Opportunity aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_opportunity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_opportunity" ] }, "description": "Aktualisiert eine bestehende Opportunity.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Opportunity-ID (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "amount", "value": "", "type": "text", "description": "Amount" }, { "key": "stage", "value": "", "type": "text", "description": "Stage" }, { "key": "close_date", "value": "", "type": "text", "description": "Close date" }, { "key": "probability", "value": "", "type": "text", "description": "Probability (Ganzzahl)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_opportunity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_opportunity" ] }, "description": "Aktualisiert eine bestehende Opportunity.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Opportunity-ID (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "amount", "value": "", "type": "text", "description": "Amount" }, { "key": "stage", "value": "", "type": "text", "description": "Stage" }, { "key": "close_date", "value": "", "type": "text", "description": "Close date" }, { "key": "probability", "value": "", "type": "text", "description": "Probability (Ganzzahl)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Cases auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_cases", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_cases" ] }, "description": "Listet alle B2B-Support-Cases (interne Fälle) mit Paginierung, Suche und Status-Filter auf. Enthält auch Stats (offen, in Bearbeitung, gelöst).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_cases", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_cases" ] }, "description": "Listet alle B2B-Support-Cases (interne Fälle) mit Paginierung, Suche und Status-Filter auf. Enthält auch Stats (offen, in Bearbeitung, gelöst).\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"stats\": {\n \"open\": 0,\n \"in_progress\": 0,\n \"resolved\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Case-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_case", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_case" ] }, "description": "Gibt alle Details eines Cases zurück, inklusive Kommentare und zugehörigem Account.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_case", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_case" ] }, "description": "Gibt alle Details eines Cases zurück, inklusive Kommentare und zugehörigem Account.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Case erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_case", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_case" ] }, "description": "Erstellt einen neuen Support-Case im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subject", "value": "", "type": "text", "description": "Betreff (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_case", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_case" ] }, "description": "Erstellt einen neuen Support-Case im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "subject", "value": "", "type": "text", "description": "Betreff (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": \"poai-job_xxx\"\n }\n}" } ] }, { "name": "CRM: Case aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_case", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_case" ] }, "description": "Aktualisiert einen bestehenden Case.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Case-ID (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Subject" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_case", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_case" ] }, "description": "Aktualisiert einen bestehenden Case.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Case-ID (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Subject" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "priority", "value": "", "type": "text", "description": "Priority" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id (Ganzzahl)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Aktivitäten auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_activities", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_activities" ] }, "description": "Listet alle CRM-Aktivitäten (Anrufe, E-Mails, Meetings, Aufgaben, Notizen) mit Paginierung, Suche, Typ- und Zeitraum-Filter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_activities", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_activities" ] }, "description": "Listet alle CRM-Aktivitäten (Anrufe, E-Mails, Meetings, Aufgaben, Notizen) mit Paginierung, Suche, Typ- und Zeitraum-Filter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Aktivität-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_activity" ] }, "description": "Gibt alle Details einer Aktivität zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_activity" ] }, "description": "Gibt alle Details einer Aktivität zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Aktivität erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_activity" ] }, "description": "Erstellt eine neue Aktivität (Anruf, E-Mail, Meeting, Aufgabe, Notiz) im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "activity_type", "value": "", "type": "text", "description": "Activity type (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Subject (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "due_date", "value": "", "type": "text", "description": "Fälligkeitsdatum (YYYY-MM-DD)" }, { "key": "related_type", "value": "", "type": "text", "description": "Related type" }, { "key": "related_id", "value": "", "type": "text", "description": "Related id (Ganzzahl)" }, { "key": "id", "value": "", "type": "text", "description": "Id" }, { "key": "entity_type", "value": "", "type": "text", "description": "Entity type" }, { "key": "parent_type", "value": "", "type": "text", "description": "Parent type" }, { "key": "entity_id", "value": "", "type": "text", "description": "Entity id" }, { "key": "parent_id", "value": "", "type": "text", "description": "Parent id" }, { "key": "lead_id", "value": "", "type": "text", "description": "Lead id" }, { "key": "contact_id", "value": "", "type": "text", "description": "Contact id" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "date_start", "value": "", "type": "text", "description": "Date start" }, { "key": "date_end", "value": "", "type": "text", "description": "Date end" }, { "key": "duration_minutes", "value": "", "type": "text", "description": "Duration minutes" }, { "key": "location", "value": "", "type": "text", "description": "Location" }, { "key": "meeting_url", "value": "", "type": "text", "description": "Meeting url" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_activity" ] }, "description": "Erstellt eine neue Aktivität (Anruf, E-Mail, Meeting, Aufgabe, Notiz) im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "activity_type", "value": "", "type": "text", "description": "Activity type (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Subject (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "due_date", "value": "", "type": "text", "description": "Fälligkeitsdatum (YYYY-MM-DD)" }, { "key": "related_type", "value": "", "type": "text", "description": "Related type" }, { "key": "related_id", "value": "", "type": "text", "description": "Related id (Ganzzahl)" }, { "key": "id", "value": "", "type": "text", "description": "Id" }, { "key": "entity_type", "value": "", "type": "text", "description": "Entity type" }, { "key": "parent_type", "value": "", "type": "text", "description": "Parent type" }, { "key": "entity_id", "value": "", "type": "text", "description": "Entity id" }, { "key": "parent_id", "value": "", "type": "text", "description": "Parent id" }, { "key": "lead_id", "value": "", "type": "text", "description": "Lead id" }, { "key": "contact_id", "value": "", "type": "text", "description": "Contact id" }, { "key": "account_id", "value": "", "type": "text", "description": "Account id" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "date_start", "value": "", "type": "text", "description": "Date start" }, { "key": "date_end", "value": "", "type": "text", "description": "Date end" }, { "key": "duration_minutes", "value": "", "type": "text", "description": "Duration minutes" }, { "key": "location", "value": "", "type": "text", "description": "Location" }, { "key": "meeting_url", "value": "", "type": "text", "description": "Meeting url" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"data\": {\n \"id\": \"poai-job_xxx\"\n }\n}" } ] }, { "name": "CRM: Aktivität aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_activity" ] }, "description": "Aktualisiert eine bestehende Aktivität.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Activity ID to update (REQUIRED) (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Activity subject/title" }, { "key": "description", "value": "", "type": "text", "description": "Detailed description" }, { "key": "activity_type", "value": "", "type": "text", "description": "Type: call, meeting, task, email, note" }, { "key": "status", "value": "", "type": "text", "description": "Status: planned, held, not_held, completed, cancelled" }, { "key": "priority", "value": "", "type": "text", "description": "Priority: low, normal, high, urgent" }, { "key": "date_start", "value": "", "type": "text", "description": "Start date/time (YYYY-MM-DD HH:MM:SS)" }, { "key": "date_end", "value": "", "type": "text", "description": "End date/time (YYYY-MM-DD HH:MM:SS)" }, { "key": "duration_minutes", "value": "", "type": "text", "description": "Duration in minutes" }, { "key": "location", "value": "", "type": "text", "description": "Meeting location or URL" }, { "key": "related_type", "value": "", "type": "text", "description": "Related entity type" }, { "key": "related_id", "value": "", "type": "text", "description": "Related entity ID" }, { "key": "result", "value": "", "type": "text", "description": "Activity result/outcome" }, { "key": "assigned_user_id", "value": "", "type": "text", "description": "Assigned user ID" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_activity" ] }, "description": "Aktualisiert eine bestehende Aktivität.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Activity ID to update (REQUIRED) (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Activity subject/title" }, { "key": "description", "value": "", "type": "text", "description": "Detailed description" }, { "key": "activity_type", "value": "", "type": "text", "description": "Type: call, meeting, task, email, note" }, { "key": "status", "value": "", "type": "text", "description": "Status: planned, held, not_held, completed, cancelled" }, { "key": "priority", "value": "", "type": "text", "description": "Priority: low, normal, high, urgent" }, { "key": "date_start", "value": "", "type": "text", "description": "Start date/time (YYYY-MM-DD HH:MM:SS)" }, { "key": "date_end", "value": "", "type": "text", "description": "End date/time (YYYY-MM-DD HH:MM:SS)" }, { "key": "duration_minutes", "value": "", "type": "text", "description": "Duration in minutes" }, { "key": "location", "value": "", "type": "text", "description": "Meeting location or URL" }, { "key": "related_type", "value": "", "type": "text", "description": "Related entity type" }, { "key": "related_id", "value": "", "type": "text", "description": "Related entity ID" }, { "key": "result", "value": "", "type": "text", "description": "Activity result/outcome" }, { "key": "assigned_user_id", "value": "", "type": "text", "description": "Assigned user ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Aktivität löschen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=delete_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=delete_activity" ] }, "description": "Löscht eine Aktivität aus dem CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Aktivitäts-ID (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=delete_activity", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=delete_activity" ] }, "description": "Löscht eine Aktivität aus dem CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Aktivitäts-ID (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Kampagnen auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_campaigns", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_campaigns" ] }, "description": "Listet alle Marketing-Kampagnen mit Paginierung, Suche und Status-Filter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_campaigns", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_campaigns" ] }, "description": "Listet alle Marketing-Kampagnen mit Paginierung, Suche und Status-Filter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Kampagne-Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_campaign" ] }, "description": "Gibt alle Details einer Kampagne zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_campaign" ] }, "description": "Gibt alle Details einer Kampagne zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Kampagne erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_campaign" ] }, "description": "Erstellt eine neue Marketing-Kampagne im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Kampagnenname (required)" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "subject", "value": "", "type": "text", "description": "Subject" }, { "key": "content", "value": "", "type": "text", "description": "HTML-Inhalt" }, { "key": "budget", "value": "", "type": "text", "description": "Budget" }, { "key": "start_date", "value": "", "type": "text", "description": "Start date" }, { "key": "end_date", "value": "", "type": "text", "description": "End date" }, { "key": "expected_revenue", "value": "", "type": "text", "description": "Expected revenue" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_campaign" ] }, "description": "Erstellt eine neue Marketing-Kampagne im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Kampagnenname (required)" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "subject", "value": "", "type": "text", "description": "Subject" }, { "key": "content", "value": "", "type": "text", "description": "HTML-Inhalt" }, { "key": "budget", "value": "", "type": "text", "description": "Budget" }, { "key": "start_date", "value": "", "type": "text", "description": "Start date" }, { "key": "end_date", "value": "", "type": "text", "description": "End date" }, { "key": "expected_revenue", "value": "", "type": "text", "description": "Expected revenue" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": \"poai-job_xxx\"\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Kampagne aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_campaign" ] }, "description": "Aktualisiert eine bestehende Kampagne.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kampagne-ID (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "subject", "value": "", "type": "text", "description": "Subject" }, { "key": "content", "value": "", "type": "text", "description": "Content" }, { "key": "budget", "value": "", "type": "text", "description": "Budget" }, { "key": "start_date", "value": "", "type": "text", "description": "Start date" }, { "key": "end_date", "value": "", "type": "text", "description": "End date" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=update_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=update_campaign" ] }, "description": "Aktualisiert eine bestehende Kampagne.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kampagne-ID (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name" }, { "key": "type", "value": "", "type": "text", "description": "Type" }, { "key": "status", "value": "", "type": "text", "description": "Status" }, { "key": "subject", "value": "", "type": "text", "description": "Subject" }, { "key": "content", "value": "", "type": "text", "description": "Content" }, { "key": "budget", "value": "", "type": "text", "description": "Budget" }, { "key": "start_date", "value": "", "type": "text", "description": "Start date" }, { "key": "end_date", "value": "", "type": "text", "description": "End date" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Kampagne löschen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=delete_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=delete_campaign" ] }, "description": "Löscht eine Kampagne aus dem CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kampagne-ID (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=delete_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=delete_campaign" ] }, "description": "Löscht eine Kampagne aus dem CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kampagne-ID (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Kampagne duplizieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=clone_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=clone_campaign" ] }, "description": "Erstellt eine Kopie einer bestehenden Kampagne mit dem Prefix \"Kopie von\".\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kampagne-ID (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=clone_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=clone_campaign" ] }, "description": "Erstellt eine Kopie einer bestehenden Kampagne mit dem Prefix \"Kopie von\".\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Kampagne-ID (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Kampagne senden", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=send_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=send_campaign" ] }, "description": "Sendet eine Kampagne an alle zugewiesenen Zielgruppen-Empfänger. Unterstützt auch Test-E-Mails an eine einzelne Adresse.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "campaign_id", "value": "", "type": "text", "description": "Kampagne-ID (required)" }, { "key": "test_email", "value": "", "type": "text", "description": "Test-E-Mail-Adresse (optional)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=send_campaign", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=send_campaign" ] }, "description": "Sendet eine Kampagne an alle zugewiesenen Zielgruppen-Empfänger. Unterstützt auch Test-E-Mails an eine einzelne Adresse.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "campaign_id", "value": "", "type": "text", "description": "Kampagne-ID (required)" }, { "key": "test_email", "value": "", "type": "text", "description": "Test-E-Mail-Adresse (optional)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Kampagnen-Statistiken", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_campaign_stats", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_campaign_stats" ] }, "description": "Gibt detaillierte Versand- und Tracking-Statistiken einer Kampagne zurück: Empfänger, Gesendet, Geöffnet, Geklickt, Konvertiert, Bounce-Rate.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_campaign_stats", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_campaign_stats" ] }, "description": "Gibt detaillierte Versand- und Tracking-Statistiken einer Kampagne zurück: Empfänger, Gesendet, Geöffnet, Geklickt, Konvertiert, Bounce-Rate.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Zielgruppen auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_target_lists", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_target_lists" ] }, "description": "Listet alle Zielgruppen (Verteilerlisten) für Kampagnen auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_target_lists", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_target_lists" ] }, "description": "Listet alle Zielgruppen (Verteilerlisten) für Kampagnen auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"pages\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Zielgruppe erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_target_list", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_target_list" ] }, "description": "Erstellt eine neue Zielgruppe für Kampagnen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name der Zielgruppe (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "id", "value": "", "type": "text", "description": "Id" }, { "key": "type", "value": "", "type": "text", "description": "Type" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_target_list", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_target_list" ] }, "description": "Erstellt eine neue Zielgruppe für Kampagnen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name der Zielgruppe (required)" }, { "key": "description", "value": "", "type": "text", "description": "Description" }, { "key": "id", "value": "", "type": "text", "description": "Id" }, { "key": "type", "value": "", "type": "text", "description": "Type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Einträge zu Zielgruppe hinzufügen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=add_target_list_entry", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=add_target_list_entry" ] }, "description": "Fügt Kontakte, Leads oder Accounts einer Zielgruppe hinzu.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "target_list_id", "value": "", "type": "text", "description": "ID der Zielgruppe (required)" }, { "key": "entity_type", "value": "", "type": "text", "description": "Typ des hinzuzufuegenden Eintrags (required)" }, { "key": "entity_id", "value": "", "type": "text", "description": "ID des Eintrags (einzeln)" }, { "key": "entity_ids", "value": "", "type": "text", "description": "IDs fuer Batch-Einfuegung (mehrere Eintraege)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=add_target_list_entry", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=add_target_list_entry" ] }, "description": "Fügt Kontakte, Leads oder Accounts einer Zielgruppe hinzu.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "target_list_id", "value": "", "type": "text", "description": "ID der Zielgruppe (required)" }, { "key": "entity_type", "value": "", "type": "text", "description": "Typ des hinzuzufuegenden Eintrags (required)" }, { "key": "entity_id", "value": "", "type": "text", "description": "ID des Eintrags (einzeln)" }, { "key": "entity_ids", "value": "", "type": "text", "description": "IDs fuer Batch-Einfuegung (mehrere Eintraege)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Zielgruppe an Kampagne zuweisen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=assign_target_list", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=assign_target_list" ] }, "description": "Weist eine Zielgruppe einer Kampagne zu.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "campaign_id", "value": "", "type": "text", "description": "ID der Kampagne (required)" }, { "key": "target_list_id", "value": "", "type": "text", "description": "ID der zuzuweisenden Zielgruppe (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=assign_target_list", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=assign_target_list" ] }, "description": "Weist eine Zielgruppe einer Kampagne zu.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "campaign_id", "value": "", "type": "text", "description": "ID der Kampagne (required)" }, { "key": "target_list_id", "value": "", "type": "text", "description": "ID der zuzuweisenden Zielgruppe (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Globale Suche", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=search", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=search" ] }, "description": "Durchsucht alle CRM-Entitäten (Leads, Accounts, Kontakte, Opportunities, Cases) nach einem Suchbegriff.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=search", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=search" ] }, "description": "Durchsucht alle CRM-Entitäten (Leads, Accounts, Kontakte, Opportunities, Cases) nach einem Suchbegriff.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Booking-Pipeline Statistiken", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_pipeline_stats", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_pipeline_stats" ] }, "description": "Gibt Statistiken der Booking-Pipeline zurück: Anfragen nach Status, Konversionsraten, Umsätze.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_pipeline_stats", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_pipeline_stats" ] }, "description": "Gibt Statistiken der Booking-Pipeline zurück: Anfragen nach Status, Konversionsraten, Umsätze.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"total\": 0,\n \"by_status\": [\n \"string\"\n ]\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Booking-Anfragen auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_requests_list", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_requests_list" ] }, "description": "Listet alle Booking-Anfragen mit Paginierung und Statusfilter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_requests_list", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_requests_list" ] }, "description": "Listet alle Booking-Anfragen mit Paginierung und Statusfilter auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"pagination\": {\n \"total\": 0,\n \"limit\": 0,\n \"offset\": 0\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Booking-Anfrage Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_get", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_get" ] }, "description": "Gibt die Details einer einzelnen Booking-Anfrage zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_get", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_get" ] }, "description": "Gibt die Details einer einzelnen Booking-Anfrage zurück.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": \"2026-02-07T12:00:00Z\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Booking-Anfrage erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_create", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_create" ] }, "description": "Erstellt eine neue Booking-Anfrage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Anfragenden" }, { "key": "email", "value": "", "type": "text", "description": "E-Mail des Anfragenden (Pflicht) (required)" }, { "key": "company", "value": "", "type": "text", "description": "Firma des Anfragenden" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht/Anliegen" }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer" }, { "key": "request_type", "value": "", "type": "text", "description": "Art der Anfrage" }, { "key": "preferred_datetime", "value": "", "type": "text", "description": "Gewuenschter Termin (ISO-8601)" }, { "key": "source", "value": "", "type": "text", "description": "Quelle der Anfrage (z.B. website, widget)" }, { "key": "position", "value": "", "type": "text", "description": "Position/Titel des Anfragenden" }, { "key": "website", "value": "", "type": "text", "description": "Website des Anfragenden" }, { "key": "create_lead", "value": true, "type": "text", "description": "Automatisch CRM-Lead erstellen" }, { "key": "requester_email", "value": "", "type": "text", "description": "Requester email (required)" }, { "key": "requester_name", "value": "", "type": "text", "description": "Requester name" }, { "key": "requester_phone", "value": "", "type": "text", "description": "Requester phone" }, { "key": "requester_company", "value": "", "type": "text", "description": "Requester company" }, { "key": "requester_website", "value": "", "type": "text", "description": "Requester website" }, { "key": "requested_product", "value": "", "type": "text", "description": "Requested product" }, { "key": "requested_duration_minutes", "value": "", "type": "text", "description": "Requested duration minutes" }, { "key": "preferred_timezone", "value": "", "type": "text", "description": "Preferred timezone" }, { "key": "requester_position", "value": "", "type": "text", "description": "Requester position" }, { "key": "requester_message", "value": "", "type": "text", "description": "Requester message" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_create", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_create" ] }, "description": "Erstellt eine neue Booking-Anfrage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Anfragenden" }, { "key": "email", "value": "", "type": "text", "description": "E-Mail des Anfragenden (Pflicht) (required)" }, { "key": "company", "value": "", "type": "text", "description": "Firma des Anfragenden" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht/Anliegen" }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer" }, { "key": "request_type", "value": "", "type": "text", "description": "Art der Anfrage" }, { "key": "preferred_datetime", "value": "", "type": "text", "description": "Gewuenschter Termin (ISO-8601)" }, { "key": "source", "value": "", "type": "text", "description": "Quelle der Anfrage (z.B. website, widget)" }, { "key": "position", "value": "", "type": "text", "description": "Position/Titel des Anfragenden" }, { "key": "website", "value": "", "type": "text", "description": "Website des Anfragenden" }, { "key": "create_lead", "value": true, "type": "text", "description": "Automatisch CRM-Lead erstellen" }, { "key": "requester_email", "value": "", "type": "text", "description": "Requester email (required)" }, { "key": "requester_name", "value": "", "type": "text", "description": "Requester name" }, { "key": "requester_phone", "value": "", "type": "text", "description": "Requester phone" }, { "key": "requester_company", "value": "", "type": "text", "description": "Requester company" }, { "key": "requester_website", "value": "", "type": "text", "description": "Requester website" }, { "key": "requested_product", "value": "", "type": "text", "description": "Requested product" }, { "key": "requested_duration_minutes", "value": "", "type": "text", "description": "Requested duration minutes" }, { "key": "preferred_timezone", "value": "", "type": "text", "description": "Preferred timezone" }, { "key": "requester_position", "value": "", "type": "text", "description": "Requester position" }, { "key": "requester_message", "value": "", "type": "text", "description": "Requester message" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: Booking-Anfrage genehmigen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_approve", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_approve" ] }, "description": "Genehmigt eine Booking-Anfrage und setzt deren Status auf \"approved\".\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Anfrage-ID (required)" }, { "key": "event_uuid", "value": "", "type": "text", "description": "Event uuid" }, { "key": "product", "value": "", "type": "text", "description": "Product" }, { "key": "send_email", "value": "", "type": "text", "description": "Send email" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_approve", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_approve" ] }, "description": "Genehmigt eine Booking-Anfrage und setzt deren Status auf \"approved\".\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Anfrage-ID (required)" }, { "key": "event_uuid", "value": "", "type": "text", "description": "Event uuid" }, { "key": "product", "value": "", "type": "text", "description": "Product" }, { "key": "send_email", "value": "", "type": "text", "description": "Send email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Booking-Anfrage ablehnen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_reject", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_reject" ] }, "description": "Lehnt eine Booking-Anfrage ab und setzt deren Status auf \"rejected\".\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Anfrage-ID (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Ablehnungsgrund" }, { "key": "event_uuid", "value": "", "type": "text", "description": "Event uuid" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=booking_request_reject", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=booking_request_reject" ] }, "description": "Lehnt eine Booking-Anfrage ab und setzt deren Status auf \"rejected\".\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Anfrage-ID (required)" }, { "key": "reason", "value": "", "type": "text", "description": "Ablehnungsgrund" }, { "key": "event_uuid", "value": "", "type": "text", "description": "Event uuid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": 0,\n \"status\": \"string\"\n },\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: E-Mail-Vorlagen auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_templates", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_templates" ] }, "description": "Listet alle E-Mail-Vorlagen auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=list_templates", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=list_templates" ] }, "description": "Listet alle E-Mail-Vorlagen auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": [\n \"string\"\n ],\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\",\n \"error\": \"string\",\n \"message\": \"string\"\n}" } ] }, { "name": "CRM: E-Mail-Vorlage erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_template", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_template" ] }, "description": "Erstellt eine neue E-Mail-Vorlage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name der Antwortvorlage (Pflicht) (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Betreff der Vorlage" }, { "key": "content", "value": "", "type": "text", "description": "Inhalt der Vorlage (HTML oder Text)" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie der Vorlage" }, { "key": "variables", "value": "", "type": "text", "description": "Verfuegbare Variablen (z.B. {{name}}, {{company}})" }, { "key": "shortcut", "value": "", "type": "text", "description": "Tastenkuerzel fuer Schnellzugriff" }, { "key": "is_active", "value": true, "type": "text", "description": "Vorlage aktiv schalten" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=create_template", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=create_template" ] }, "description": "Erstellt eine neue E-Mail-Vorlage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name der Antwortvorlage (Pflicht) (required)" }, { "key": "subject", "value": "", "type": "text", "description": "Betreff der Vorlage" }, { "key": "content", "value": "", "type": "text", "description": "Inhalt der Vorlage (HTML oder Text)" }, { "key": "category", "value": "", "type": "text", "description": "Kategorie der Vorlage" }, { "key": "variables", "value": "", "type": "text", "description": "Verfuegbare Variablen (z.B. {{name}}, {{company}})" }, { "key": "shortcut", "value": "", "type": "text", "description": "Tastenkuerzel fuer Schnellzugriff" }, { "key": "is_active", "value": true, "type": "text", "description": "Vorlage aktiv schalten" }, { "key": "id", "value": "", "type": "text", "description": "Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"data\": {\n \"id\": \"poai-job_xxx\"\n },\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "CRM: Verwandte Entities abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_related_entities", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_related_entities" ] }, "description": "Ruft alle verwandten Entities (Kontakte, Opportunities, Cases, Aktivitäten) für einen gegebenen Account, Kontakt oder Lead ab. Ideal für Detail-Seiten und Cross-Navigation im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/relations?API_COMMAND=get_related_entities", "host": [ "{{base_url}}" ], "path": [ "relations?API_COMMAND=get_related_entities" ] }, "description": "Ruft alle verwandten Entities (Kontakte, Opportunities, Cases, Aktivitäten) für einen gegebenen Account, Kontakt oder Lead ab. Ideal für Detail-Seiten und Cross-Navigation im CRM.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"error\": \"string\",\n \"message\": \"string\",\n \"success\": true,\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Faq", "item": [ { "name": "Add faq", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Add FAQ Create a new FAQ entry.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "entries", "value": "", "type": "text", "description": "Mehrsprachige FAQ-Eintraege. Schluessel = ISO-Sprachcode, Wert = Objekt mit question und answer (required)" }, { "key": "category", "value": "general", "type": "text", "description": "FAQ-Kategorie" }, { "key": "priority", "value": 0, "type": "text", "description": "Sortierprioritaet (hoeher = weiter oben)" }, { "key": "is_active", "value": true, "type": "text", "description": "FAQ sofort aktiv schalten" }, { "key": "is_exact_match", "value": false, "type": "text", "description": "Nur bei exakter Uebereinstimmung matchen" }, { "key": "action", "value": "", "type": "text", "description": "Automatische Aktion bei Match (z.B. HANGUP, TRANSFER, ESCALATE)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Add FAQ Create a new FAQ entry.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "entries", "value": "", "type": "text", "description": "Mehrsprachige FAQ-Eintraege. Schluessel = ISO-Sprachcode, Wert = Objekt mit question und answer (required)" }, { "key": "category", "value": "general", "type": "text", "description": "FAQ-Kategorie" }, { "key": "priority", "value": 0, "type": "text", "description": "Sortierprioritaet (hoeher = weiter oben)" }, { "key": "is_active", "value": true, "type": "text", "description": "FAQ sofort aktiv schalten" }, { "key": "is_exact_match", "value": false, "type": "text", "description": "Nur bei exakter Uebereinstimmung matchen" }, { "key": "action", "value": "", "type": "text", "description": "Automatische Aktion bei Match (z.B. HANGUP, TRANSFER, ESCALATE)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"faq_id\": \"poai-job_xxx\",\n \"created\": true,\n \"status\": \"success\"\n}" } ] }, { "name": "Get faq", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get FAQ Get a specific FAQ entry.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Query parameter: id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get FAQ Get a specific FAQ entry.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "Query parameter: id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"faq_id\": \"poai-job_xxx\",\n \"question\": \"string\",\n \"answer\": \"string\",\n \"category\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List faqs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List FAQs Retrieve all FAQs.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "category", "value": "", "type": "text", "description": "Filter nach FAQ-Kategorie (z.B. general, billing)" }, { "key": "language", "value": "", "type": "text", "description": "Filter nach Sprache (ISO-Code)" }, { "key": "is_active", "value": "", "type": "text", "description": "Filter nach Aktiv-Status" }, { "key": "search", "value": "", "type": "text", "description": "Volltext-Suchbegriff in Frage und Antwort" }, { "key": "limit", "value": 50, "type": "text", "description": "Max. FAQs pro Seite" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List FAQs Retrieve all FAQs.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "category", "value": "", "type": "text", "description": "Filter nach FAQ-Kategorie (z.B. general, billing)" }, { "key": "language", "value": "", "type": "text", "description": "Filter nach Sprache (ISO-Code)" }, { "key": "is_active", "value": "", "type": "text", "description": "Filter nach Aktiv-Status" }, { "key": "search", "value": "", "type": "text", "description": "Volltext-Suchbegriff in Frage und Antwort" }, { "key": "limit", "value": 50, "type": "text", "description": "Max. FAQs pro Seite" }, { "key": "offset", "value": 0, "type": "text", "description": "Pagination-Offset" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"faqs\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Search faqs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Search FAQs Search FAQs by keyword.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "q", "value": "", "type": "text", "description": "Query parameter: q" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Search FAQs Search FAQs by keyword.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "q", "value": "", "type": "text", "description": "Query parameter: q" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"results\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Lead", "item": [ { "name": "Score lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Score Lead Calculate lead score using AI.\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "E-Mail-Adresse des Leads (Pflichtfeld). Wird fuer Domain-Analyse verwendet. (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name des Leads." }, { "key": "company", "value": "", "type": "text", "description": "Firmenname des Leads." }, { "key": "website", "value": "", "type": "text", "description": "Website-URL des Unternehmens (fuer Branchen-Analyse)." }, { "key": "position", "value": "", "type": "text", "description": "Position/Jobtitel (wird gegen Entscheidungstraeger-Liste geprueft)." }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer." }, { "key": "linkedin", "value": "", "type": "text", "description": "LinkedIn-Profil-URL." }, { "key": "country", "value": "", "type": "text", "description": "Land des Leads." }, { "key": "employees", "value": "", "type": "text", "description": "Anzahl Mitarbeiter (z.B. '50-200')." }, { "key": "language", "value": "de", "type": "text", "description": "Sprache der Analyse-Ergebnisse." }, { "key": "ip_address", "value": "", "type": "text", "description": "IP-Adresse fuer VPN/Proxy-Erkennung." }, { "key": "request_type", "value": "demo", "type": "text", "description": "Art der Anfrage: Demo, Beratung oder Support." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Score Lead Calculate lead score using AI.\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "email", "value": "", "type": "text", "description": "E-Mail-Adresse des Leads (Pflichtfeld). Wird fuer Domain-Analyse verwendet. (required)" }, { "key": "name", "value": "", "type": "text", "description": "Name des Leads." }, { "key": "company", "value": "", "type": "text", "description": "Firmenname des Leads." }, { "key": "website", "value": "", "type": "text", "description": "Website-URL des Unternehmens (fuer Branchen-Analyse)." }, { "key": "position", "value": "", "type": "text", "description": "Position/Jobtitel (wird gegen Entscheidungstraeger-Liste geprueft)." }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer." }, { "key": "linkedin", "value": "", "type": "text", "description": "LinkedIn-Profil-URL." }, { "key": "country", "value": "", "type": "text", "description": "Land des Leads." }, { "key": "employees", "value": "", "type": "text", "description": "Anzahl Mitarbeiter (z.B. '50-200')." }, { "key": "language", "value": "de", "type": "text", "description": "Sprache der Analyse-Ergebnisse." }, { "key": "ip_address", "value": "", "type": "text", "description": "IP-Adresse fuer VPN/Proxy-Erkennung." }, { "key": "request_type", "value": "demo", "type": "text", "description": "Art der Anfrage: Demo, Beratung oder Support." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"score\": 0,\n \"factors\": [\n \"string\"\n ],\n \"recommendation\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Risk", "item": [ { "name": "Atrisk accounts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Accounts mit hohem Churn-Risiko. Sortiert nach Risiko-Score, inkl. Faktoren und Empfehlungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "threshold", "value": "", "type": "text", "description": "Churn risk threshold (default: 0.5)" }, { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 20, max: 100)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Accounts mit hohem Churn-Risiko. Sortiert nach Risiko-Score, inkl. Faktoren und Empfehlungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "threshold", "value": "", "type": "text", "description": "Churn risk threshold (default: 0.5)" }, { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 20, max: 100)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"accounts\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Sync", "item": [ { "name": "Sync stats", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Sync Statistics Get detailed statistics about indexed knowledge. Response: json { \"status\": \"success\", \"data\": { \"connector_type\": \"zammad\", \"documents\": { \"ticket\": 120, \"kb_article\": 45, \"macro\": 12, \"total\": 177 }, \"embeddings\": 1542, \"last_sync\": \"2025-12-17T10:30:00Z\", \"last_sync_status\"...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "connector_type", "value": "", "type": "text", "description": "Query parameter: connector_type" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Sync Statistics Get detailed statistics about indexed knowledge. Response: json { \"status\": \"success\", \"data\": { \"connector_type\": \"zammad\", \"documents\": { \"ticket\": 120, \"kb_article\": 45, \"macro\": 12, \"total\": 177 }, \"embeddings\": 1542, \"last_sync\": \"2025-12-17T10:30:00Z\", \"last_sync_status\"...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "connector_type", "value": "", "type": "text", "description": "Query parameter: connector_type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"last_sync\": \"string\",\n \"items_synced\": 0,\n \"status\": \"string\"\n}" } ] }, { "name": "Trigger sync", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Trigger Manual Sync Start a manual synchronization for a connector. Parameters: | Parameter | Default | Description | |-----------|---------|-------------| | connector_type | required | Which connector to sync | | full | false | Full re-sync re-indexes everything | Response: json { \"status\": \"suc...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "connector_type", "value": "zammad", "type": "text", "description": "Connector to sync" }, { "key": "full", "value": "false", "type": "text", "description": "Full re-sync deletes existing data" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Trigger Manual Sync Start a manual synchronization for a connector. Parameters: | Parameter | Default | Description | |-----------|---------|-------------| | connector_type | required | Which connector to sync | | full | false | Full re-sync re-indexes everything | Response: json { \"status\": \"suc...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "connector_type", "value": "zammad", "type": "text", "description": "Connector to sync" }, { "key": "full", "value": "false", "type": "text", "description": "Full re-sync deletes existing data" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"triggered\": true,\n \"sync_id\": \"poai-job_xxx\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Hotel", "item": [ { "name": "Hotel invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Hotel Invoice Extract data from hotel bills and folio statements. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collect...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "hotel_invoice", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Hotel Invoice Extract data from hotel bills and folio statements. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collect...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "hotel_invoice", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"hotel_name\": \"string\",\n \"guest_name\": \"string\",\n \"check_in\": \"string\",\n \"check_out\": \"string\",\n \"room_type\": \"string\",\n \"total_amount\": 0,\n \"tax_amount\": 0\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Orders", "item": [ { "name": "Delivery note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delivery Note Extract data from delivery notes and packing slips. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collect...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "delivery_note", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delivery Note Extract data from delivery notes and packing slips. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collect...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "delivery_note", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"delivery_number\": \"string\",\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"delivery_date\": \"string\",\n \"items\": [\n {}\n ]\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Purchase order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Purchase Order Extract purchase order data. Fields: order_number, date, vendor, buyer, items, delivery_date, total Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "order", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Purchase Order Extract purchase order data. Fields: order_number, date, vendor, buyer, items, delivery_date, total Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "order", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"order_number\": \"string\",\n \"vendor\": \"string\",\n \"order_date\": \"string\",\n \"total_amount\": 0,\n \"items\": [\n {}\n ]\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Shipping waybill", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Shipping Waybill Extract data from shipping waybills and freight documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | i...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "shipping_waybill", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Shipping Waybill Extract data from shipping waybills and freight documents. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | i...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "shipping_waybill", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"tracking_number\": \"string\",\n \"carrier\": \"string\",\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"weight\": 0\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Topics", "item": [ { "name": "All topics", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle verfügbaren Topics mit hierarchischer Struktur. Inklusive Anzahl der Dokumente pro Topic.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Filter by workspace" }, { "key": "include_stats", "value": "", "type": "text", "description": "Include document counts" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle verfügbaren Topics mit hierarchischer Struktur. Inklusive Anzahl der Dokumente pro Topic.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Filter by workspace" }, { "key": "include_stats", "value": "", "type": "text", "description": "Include document counts" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"topics\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Document topics", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Themen-Klassifizierung eines Dokuments. Zeigt welche Themen dem Dokument zugeordnet wurden und mit welcher Confidence.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "Numerische Dokument-ID. Wird als URL-Parameter uebergeben (/topics/{document_id}). (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Themen-Klassifizierung eines Dokuments. Zeigt welche Themen dem Dokument zugeordnet wurden und mit welcher Confidence.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "Numerische Dokument-ID. Wird als URL-Parameter uebergeben (/topics/{document_id}). (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"topics\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Vision", "item": [ { "name": "Vision data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Vision-extrahierte Daten Ultra-Tier. Includes: - Tables - Strukturierte Tabellendaten mit Rows/Cols - Charts - Erkannte Diagramme mit Daten - Form Fields - Formularfelder mit Werten - Barcodes - QR-Codes und Barcodes - Layout - Dokumentstruktur Headers, Paragraphs, etc.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "include", "value": "", "type": "text", "description": "all, tables, charts, forms, barcodes, layout" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Vision-extrahierte Daten Ultra-Tier. Includes: - Tables - Strukturierte Tabellendaten mit Rows/Cols - Charts - Erkannte Diagramme mit Daten - Form Fields - Formularfelder mit Werten - Barcodes - QR-Codes und Barcodes - Layout - Dokumentstruktur Headers, Paragraphs, etc.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "include", "value": "", "type": "text", "description": "all, tables, charts, forms, barcodes, layout" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"description\": \"string\",\n \"objects\": [\n {}\n ],\n \"text_detected\": \"string\",\n \"labels\": [\n \"string\"\n ]\n }\n }\n}" } ] } ] }, { "name": "📁 Letters", "item": [ { "name": "Letter mail", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Letter / Mail Extract letter metadata and content. Fields: sender, recipient, date, subject, body_summary\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "letter_mail", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Letter / Mail Extract letter metadata and content. Fields: sender, recipient, date, subject, body_summary\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "letter_mail", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"sender\": \"string\",\n \"recipient\": \"string\",\n \"date\": \"string\",\n \"subject\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Receipts receipt", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Receipt Extract data from receipts. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | string | Yes | receipt |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "receipt", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Receipt Extract data from receipts. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | string | Yes | receipt |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "receipt", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"merchant_name\": \"string\",\n \"date\": \"string\",\n \"total_amount\": 0,\n \"items\": [\n {}\n ]\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Meeting", "item": [ { "name": "List Meeting Types", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Meeting Types Retrieve all meeting type templates.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Meeting Types Retrieve all meeting type templates.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"meeting_types\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Meeting type", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Meeting Type Create a new meeting type template.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Meeting-Typs (Slug wird automatisch generiert) (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung" }, { "key": "duration_minutes", "value": 30, "type": "text", "description": "Dauer in Minuten" }, { "key": "color", "value": "#6366f1", "type": "text", "description": "Farbe als Hex-Code" }, { "key": "location_type", "value": "video", "type": "text", "description": "Art des Ortes" }, { "key": "location_details", "value": "", "type": "text", "description": "Details zum Ort (Zoom-Link, Adresse etc.)" }, { "key": "buffer_before_minutes", "value": 0, "type": "text", "description": "Puffer vor Termin in Minuten" }, { "key": "buffer_after_minutes", "value": 0, "type": "text", "description": "Puffer nach Termin in Minuten" }, { "key": "min_notice_hours", "value": 24, "type": "text", "description": "Mindest-Vorlaufzeit in Stunden" }, { "key": "max_days_in_advance", "value": 60, "type": "text", "description": "Max. Vorausbuchung in Tagen" }, { "key": "requires_confirmation", "value": 0, "type": "text", "description": "Manuelle Bestaetigung noetig (0=nein, 1=ja)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Meeting Type Create a new meeting type template.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Meeting-Typs (Slug wird automatisch generiert) (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung" }, { "key": "duration_minutes", "value": 30, "type": "text", "description": "Dauer in Minuten" }, { "key": "color", "value": "#6366f1", "type": "text", "description": "Farbe als Hex-Code" }, { "key": "location_type", "value": "video", "type": "text", "description": "Art des Ortes" }, { "key": "location_details", "value": "", "type": "text", "description": "Details zum Ort (Zoom-Link, Adresse etc.)" }, { "key": "buffer_before_minutes", "value": 0, "type": "text", "description": "Puffer vor Termin in Minuten" }, { "key": "buffer_after_minutes", "value": 0, "type": "text", "description": "Puffer nach Termin in Minuten" }, { "key": "min_notice_hours", "value": 24, "type": "text", "description": "Mindest-Vorlaufzeit in Stunden" }, { "key": "max_days_in_advance", "value": 60, "type": "text", "description": "Max. Vorausbuchung in Tagen" }, { "key": "requires_confirmation", "value": 0, "type": "text", "description": "Manuelle Bestaetigung noetig (0=nein, 1=ja)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"meeting_type_id\": \"poai-job_xxx\",\n \"created\": true,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Message", "item": [ { "name": "Delete notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/delete", "host": [ "{{base_url}}" ], "path": [ "message_center", "delete" ] }, "description": "Löscht eine Benachrichtigung\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "notification_id", "value": "", "type": "text", "description": "ID der Benachrichtigung" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/delete", "host": [ "{{base_url}}" ], "path": [ "message_center", "delete" ] }, "description": "Löscht eine Benachrichtigung\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "notification_id", "value": "", "type": "text", "description": "ID der Benachrichtigung" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"deleted\": true,\n \"notification_id\": 0\n }\n }\n}" } ] }, { "name": "Get preferences", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/preferences", "host": [ "{{base_url}}" ], "path": [ "message_center", "preferences" ] }, "description": "Benachrichtigungs-Einstellungen abrufen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/preferences", "host": [ "{{base_url}}" ], "path": [ "message_center", "preferences" ] }, "description": "Benachrichtigungs-Einstellungen abrufen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"preferences\": {}\n }\n }\n}" } ] }, { "name": "List notifications", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/list", "host": [ "{{base_url}}" ], "path": [ "message_center", "list" ] }, "description": "Listet alle Benachrichtigungen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/list", "host": [ "{{base_url}}" ], "path": [ "message_center", "list" ] }, "description": "Listet alle Benachrichtigungen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"notifications\": [\n {\n \"id\": 0,\n \"title\": \"string\",\n \"message\": \"string\",\n \"category\": \"string\",\n \"priority\": \"string\",\n \"is_read\": true,\n \"created_at\": \"string\"\n }\n ],\n \"total\": 0,\n \"unread\": 0\n }\n }\n}" } ] }, { "name": "Mark All Notifications Read", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/mark_all_read", "host": [ "{{base_url}}" ], "path": [ "message_center", "mark_all_read" ] }, "description": "Markiert alle Benachrichtigungen als gelesen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "category", "value": "", "type": "text", "description": "Nur Benachrichtigungen dieser Kategorie markieren (ohne = alle)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/mark_all_read", "host": [ "{{base_url}}" ], "path": [ "message_center", "mark_all_read" ] }, "description": "Markiert alle Benachrichtigungen als gelesen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "category", "value": "", "type": "text", "description": "Nur Benachrichtigungen dieser Kategorie markieren (ohne = alle)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"marked_count\": 0\n }\n }\n}" } ] }, { "name": "Mark Notification Read", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/mark_read", "host": [ "{{base_url}}" ], "path": [ "message_center", "mark_read" ] }, "description": "Markiert eine Benachrichtigung als gelesen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "notification_id", "value": "", "type": "text", "description": "ID der Benachrichtigung" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/mark_read", "host": [ "{{base_url}}" ], "path": [ "message_center", "mark_read" ] }, "description": "Markiert eine Benachrichtigung als gelesen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "notification_id", "value": "", "type": "text", "description": "ID der Benachrichtigung" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"notification_id\": 0,\n \"is_read\": true\n }\n }\n}" } ] }, { "name": "Unread count", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/unread_count", "host": [ "{{base_url}}" ], "path": [ "message_center", "unread_count" ] }, "description": "Anzahl ungelesener Benachrichtigungen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/message_center/unread_count", "host": [ "{{base_url}}" ], "path": [ "message_center", "unread_count" ] }, "description": "Anzahl ungelesener Benachrichtigungen\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"count\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Summary", "item": [ { "name": "Document summary", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Kompakte Zusammenfassung aller Document Intelligence Daten. Ein Endpoint für alle wichtigen Metriken und API-Links.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "Numerische Dokument-ID (documents_id). Wird als URL-Parameter uebergeben (/summary/{document_id}). (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Kompakte Zusammenfassung aller Document Intelligence Daten. Ein Endpoint für alle wichtigen Metriken und API-Links.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "Numerische Dokument-ID (documents_id). Wird als URL-Parameter uebergeben (/summary/{document_id}). (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"summary\": \"string\",\n \"key_points\": [\n \"string\"\n ],\n \"word_count\": 0\n }\n }\n}" } ] }, { "name": "Global stats", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Globale Document Intelligence Statistiken. Übersicht über alle verarbeiteten Dokumente, Entities, Embeddings, etc.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Filter by workspace" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Globale Document Intelligence Statistiken. Übersicht über alle verarbeiteten Dokumente, Entities, Embeddings, etc.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Optional: Filter by workspace" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"total_documents\": 0,\n \"total_workspaces\": 0,\n \"total_storage_bytes\": 0,\n \"documents_this_month\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Analysis", "item": [ { "name": "Whitepage scan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Scan documents for empty/whitepages and detect codes. Features: - Detect blank pages configurable threshold - Find barcodes and QR codes - Identify pages with only minimal content Use cases: - Clean up scanned documents - Automated document processing - Quality control\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "PDF or image to scan" }, { "key": "whitepage_threshold", "value": "0.95", "type": "text", "description": "Whitespace threshold 0.0-1.0, default: 0.95" }, { "key": "detect_code", "value": "true", "type": "text", "description": "Detect barcodes and QR codes" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Scan documents for empty/whitepages and detect codes. Features: - Detect blank pages configurable threshold - Find barcodes and QR codes - Identify pages with only minimal content Use cases: - Clean up scanned documents - Automated document processing - Quality control\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "PDF or image to scan" }, { "key": "whitepage_threshold", "value": "0.95", "type": "text", "description": "Whitespace threshold 0.0-1.0, default: 0.95" }, { "key": "detect_code", "value": "true", "type": "text", "description": "Detect barcodes and QR codes" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"is_whitepage\": true,\n \"confidence\": 0,\n \"content_detected\": true\n }\n }\n}" } ] } ] }, { "name": "📁 Currency", "item": [ { "name": "Convert currency", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/currency_exchange/get_rates", "host": [ "{{base_url}}" ], "path": [ "currency_exchange", "get_rates" ] }, "description": "Convert Currency Convert an amount from one currency to another. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | from | string | ✅ Yes | Source currency code EUR, USD, GBP, etc. | | to | string | ✅ Yes | Target currency code | | amount ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "from", "value": "", "type": "text", "description": "Source currency code (ISO 4217)" }, { "key": "to", "value": "", "type": "text", "description": "Target currency code (ISO 4217)" }, { "key": "amount", "value": "", "type": "text", "description": "Amount to convert (default: 1)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/currency_exchange/get_rates", "host": [ "{{base_url}}" ], "path": [ "currency_exchange", "get_rates" ] }, "description": "Convert Currency Convert an amount from one currency to another. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | from | string | ✅ Yes | Source currency code EUR, USD, GBP, etc. | | to | string | ✅ Yes | Target currency code | | amount ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "from", "value": "", "type": "text", "description": "Source currency code (ISO 4217)" }, { "key": "to", "value": "", "type": "text", "description": "Target currency code (ISO 4217)" }, { "key": "amount", "value": "", "type": "text", "description": "Amount to convert (default: 1)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"from\": \"string\",\n \"to\": \"string\",\n \"amount\": 0,\n \"converted\": 0,\n \"rate\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Exchange rates", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/currency_exchange/get_rates", "host": [ "{{base_url}}" ], "path": [ "currency_exchange", "get_rates" ] }, "description": "Get Exchange Rates Get exchange rates for all 150+ currencies based on a source currency. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | from | string | ✅ Yes | Base currency code EUR, USD, GBP, etc. | | amount | float | No | Base amount...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/currency_exchange/get_rates", "host": [ "{{base_url}}" ], "path": [ "currency_exchange", "get_rates" ] }, "description": "Get Exchange Rates Get exchange rates for all 150+ currencies based on a source currency. Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | from | string | ✅ Yes | Base currency code EUR, USD, GBP, etc. | | amount | float | No | Base amount...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"base\": \"string\",\n \"rates\": {},\n \"updated_at\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Document", "item": [ { "name": "Analysis dms", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Document Analysis DMS General document classification and metadata extraction. Fields: document_type, date, sender, recipient, subject, keywords Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "document_analysis", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Document Analysis DMS General document classification and metadata extraction. Fields: document_type, date, sender, recipient, subject, keywords Parameter: | Param | Type | Required | |-------|------|----------| | file_1 | file | Yes | | model | string | Yes |\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "document_analysis", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"document_keywords\": [\n \"string\"\n ],\n \"document_name\": \"string\",\n \"document_type_classification\": \"string\",\n \"document_save_paths\": [\n \"string\"\n ],\n \"document_summary_short\": \"string\"\n }\n }\n}" } ] }, { "name": "Dissolve unstaple", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder Dissolve Unstaple Dissolve a document folder - unstaple the documents. --- When to Use - Remove document grouping - Split a bundle back into individual documents - Reorganize documents into different folders - Workflow: auto-dissolve after processing --- How It Works 1. Identi...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "folder_id", "value": "", "type": "text", "description": "ID der aufzuloesenden Dokumentmappe (z.B. 'folder_abc123...'). Entweder folder_id oder pofid erforderlich." }, { "key": "pofid", "value": "", "type": "text", "description": "POFID eines Dokuments in der Mappe. Die zugehoerige Mappe wird aufgeloest. Alternativ zu folder_id." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder Dissolve Unstaple Dissolve a document folder - unstaple the documents. --- When to Use - Remove document grouping - Split a bundle back into individual documents - Reorganize documents into different folders - Workflow: auto-dissolve after processing --- How It Works 1. Identi...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "folder_id", "value": "", "type": "text", "description": "ID der aufzuloesenden Dokumentmappe (z.B. 'folder_abc123...'). Entweder folder_id oder pofid erforderlich." }, { "key": "pofid", "value": "", "type": "text", "description": "POFID eines Dokuments in der Mappe. Die zugehoerige Mappe wird aufgeloest. Alternativ zu folder_id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"status\": \"string\",\n \"released_pofids\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Document metadata", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Document Metadata Extract general document metadata. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | string ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "document_metadata", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Document Metadata Extract general document metadata. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collection | string ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "document_metadata", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"metadata\": {},\n \"document_type\": \"string\",\n \"language\": \"string\",\n \"page_count\": 0\n }\n }\n}" } ] }, { "name": "Documents export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Export Documents Bulk export documents as ZIP archive. Options: - Specific POFIDs - All from workspace\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "selected_pofids", "value": "", "type": "text", "description": "JSON-Array der zu exportierenden Dokument-POFIDs. (required)" }, { "key": "export_format", "value": "", "type": "text", "description": "Exportformat: xlsx (Excel), csv, json oder zip. (required)" }, { "key": "selected_fields", "value": "", "type": "text", "description": "JSON-Array der zu exportierenden Felder (z.B. ['file_name', 'created_datetime', 'file_size']). (required)" }, { "key": "field_order", "value": "", "type": "text", "description": "Optionale Reihenfolge der Spalten im Export." }, { "key": "include_original_files", "value": false, "type": "text", "description": "Original-Dateien in den Export einschliessen (nur bei ZIP-Format)." }, { "key": "include_ocr_text", "value": false, "type": "text", "description": "OCR-extrahierten Text mit exportieren." }, { "key": "include_ocr_bounding_boxes", "value": false, "type": "text", "description": "OCR-Bounding-Boxes (Positionsdaten) mit exportieren." }, { "key": "archive_format", "value": "zip", "type": "text", "description": "Archiv-Format bei Datei-Exporten." }, { "key": "excel_options", "value": "", "type": "text", "description": "Optionale Excel-spezifische Einstellungen (Spaltenbreite, Header-Formatierung etc.)." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Export Documents Bulk export documents as ZIP archive. Options: - Specific POFIDs - All from workspace\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "selected_pofids", "value": "", "type": "text", "description": "JSON-Array der zu exportierenden Dokument-POFIDs. (required)" }, { "key": "export_format", "value": "", "type": "text", "description": "Exportformat: xlsx (Excel), csv, json oder zip. (required)" }, { "key": "selected_fields", "value": "", "type": "text", "description": "JSON-Array der zu exportierenden Felder (z.B. ['file_name', 'created_datetime', 'file_size']). (required)" }, { "key": "field_order", "value": "", "type": "text", "description": "Optionale Reihenfolge der Spalten im Export." }, { "key": "include_original_files", "value": false, "type": "text", "description": "Original-Dateien in den Export einschliessen (nur bei ZIP-Format)." }, { "key": "include_ocr_text", "value": false, "type": "text", "description": "OCR-extrahierten Text mit exportieren." }, { "key": "include_ocr_bounding_boxes", "value": false, "type": "text", "description": "OCR-Bounding-Boxes (Positionsdaten) mit exportieren." }, { "key": "archive_format", "value": "zip", "type": "text", "description": "Archiv-Format bei Datei-Exporten." }, { "key": "excel_options", "value": "", "type": "text", "description": "Optionale Excel-spezifische Einstellungen (Spaltenbreite, Header-Formatierung etc.)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"total_exported\": 0,\n \"format\": \"string\"\n }\n }\n}" } ] }, { "name": "Folder list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder List List all document folders staples in a workspace. --- When to Use - Display document bundles in UI - Find folder_id to add/remove documents - Get overview of grouped documents - Check which documents are stapled together --- How It Works 1. Query all folders in specified ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Required: Workspace ID to list folders from" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder List List all document folders staples in a workspace. --- When to Use - Display document bundles in UI - Find folder_id to add/remove documents - Get overview of grouped documents - Check which documents are stapled together --- How It Works 1. Query all folders in specified ...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Required: Workspace ID to list folders from" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"folders\": [\n {}\n ],\n \"total\": 0\n }\n },\n \"jobs\": \"poai-job_xxx\",\n \"templates\": \"string\"\n}" } ] }, { "name": "Folder update", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder Update Update a document folder's metadata name, description, icon, color. --- When to Use - Rename a document bundle - Add or update folder description - Change folder icon or color for visual organization - Workflow: auto-update folder name based on status --- How It Works 1...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "folder_id", "value": "", "type": "text", "description": "ID der zu aktualisierenden Dokumentmappe. (required)" }, { "key": "folder_name", "value": "", "type": "text", "description": "Neuer Name der Dokumentmappe." }, { "key": "folder_description", "value": "", "type": "text", "description": "Neue Beschreibung der Dokumentmappe." }, { "key": "folder_icon", "value": "", "type": "text", "description": "Neues Icon fuer die Dokumentmappe (Emoji oder Icon-Name)." }, { "key": "folder_color", "value": "", "type": "text", "description": "Neue Farbe fuer die Dokumentmappe (Hex-Farbcode, z.B. '#3b82f6')." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder Update Update a document folder's metadata name, description, icon, color. --- When to Use - Rename a document bundle - Add or update folder description - Change folder icon or color for visual organization - Workflow: auto-update folder name based on status --- How It Works 1...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "folder_id", "value": "", "type": "text", "description": "ID der zu aktualisierenden Dokumentmappe. (required)" }, { "key": "folder_name", "value": "", "type": "text", "description": "Neuer Name der Dokumentmappe." }, { "key": "folder_description", "value": "", "type": "text", "description": "Neue Beschreibung der Dokumentmappe." }, { "key": "folder_icon", "value": "", "type": "text", "description": "Neues Icon fuer die Dokumentmappe (Emoji oder Icon-Name)." }, { "key": "folder_color", "value": "", "type": "text", "description": "Neue Farbe fuer die Dokumentmappe (Hex-Farbcode, z.B. '#3b82f6')." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"status\": \"string\",\n \"document_count\": 0\n }\n }\n}" } ] }, { "name": "Llm model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Suggest LLM Model Analyze document and suggest optimal model. Response: json { \"suggested_model\": \"premium-pro\", \"document_type\": \"invoice\", \"complexity\": \"medium\" }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "suggest_paperoffice_llm_model", "type": "text", "description": "Idp collection" }, { "key": "prompt", "value": "I want to extract invoice number, date, vendor name, and total amount", "type": "text", "description": "Prompt (required)" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Suggest LLM Model Analyze document and suggest optimal model. Response: json { \"suggested_model\": \"premium-pro\", \"document_type\": \"invoice\", \"complexity\": \"medium\" }\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "suggest_paperoffice_llm_model", "type": "text", "description": "Idp collection" }, { "key": "prompt", "value": "I want to extract invoice number, date, vendor name, and total amount", "type": "text", "description": "Prompt (required)" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"suggested_model\": \"string\",\n \"reason\": \"string\",\n \"alternatives\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Max extraction", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Variable Metadata Max Extraction Extract all possible metadata and content from any document. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vis...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "variable_metadata", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Variable Metadata Max Extraction Extract all possible metadata and content from any document. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vis...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "Model (required)" }, { "key": "idp_collection", "value": "variable_metadata", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "≥900=sync," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"fields\": {},\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Staple documents", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder Create Staple Documents Staple multiple documents together into a document folder. --- When to Use - Group related documents invoice + payment + delivery note - Create document bundles for projects - Organize multi-part documents contract + appendices - Workflow: auto-staple d...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofids", "value": "", "type": "text", "description": "Liste der PaperOffice-Dokument-IDs (POFIDs), die zur Mappe zusammengefasst werden sollen. Mindestens 2 erforderlich. (required)" }, { "key": "folder_name", "value": "", "type": "text", "description": "Name der Dokumentmappe. Falls leer, wird automatisch generiert (z.B. '3 zusammengehängte Dokumente')." }, { "key": "folder_type", "value": "staple", "type": "text", "description": "Typ der Mappe: 'staple' (geheftete Dokumente) oder 'folder' (Ordner)." }, { "key": "folder_description", "value": "", "type": "text", "description": "Optionale Beschreibung der Dokumentmappe." }, { "key": "parent_pofid", "value": "", "type": "text", "description": "POFID des Eltern-Dokuments. Standard: erstes Dokument in der Liste." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Folder Create Staple Documents Staple multiple documents together into a document folder. --- When to Use - Group related documents invoice + payment + delivery note - Create document bundles for projects - Organize multi-part documents contract + appendices - Workflow: auto-staple d...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofids", "value": "", "type": "text", "description": "Liste der PaperOffice-Dokument-IDs (POFIDs), die zur Mappe zusammengefasst werden sollen. Mindestens 2 erforderlich. (required)" }, { "key": "folder_name", "value": "", "type": "text", "description": "Name der Dokumentmappe. Falls leer, wird automatisch generiert (z.B. '3 zusammengehängte Dokumente')." }, { "key": "folder_type", "value": "staple", "type": "text", "description": "Typ der Mappe: 'staple' (geheftete Dokumente) oder 'folder' (Ordner)." }, { "key": "folder_description", "value": "", "type": "text", "description": "Optionale Beschreibung der Dokumentmappe." }, { "key": "parent_pofid", "value": "", "type": "text", "description": "POFID des Eltern-Dokuments. Standard: erstes Dokument in der Liste." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"folder_id\": \"string\",\n \"document_count\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Entities", "item": [ { "name": "Extract Document Entities", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle extrahierten Entitäten eines Dokuments. Entity Types: - company, person, location, date, amount, iban, product, email, phone, invoice_number, order_number, tax_id, url\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "", "type": "text", "description": "Optional: company, person, iban, amount, date, email, phone, invoice_number, etc." }, { "key": "min_confidence", "value": "", "type": "text", "description": "Optional: Minimum confidence score (0.0-1.0)" }, { "key": "include_positions", "value": "", "type": "text", "description": "Optional: Include bounding box positions" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle extrahierten Entitäten eines Dokuments. Entity Types: - company, person, location, date, amount, iban, product, email, phone, invoice_number, order_number, tax_id, url\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "", "type": "text", "description": "Optional: company, person, iban, amount, date, email, phone, invoice_number, etc." }, { "key": "min_confidence", "value": "", "type": "text", "description": "Optional: Minimum confidence score (0.0-1.0)" }, { "key": "include_positions", "value": "", "type": "text", "description": "Optional: Include bounding box positions" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"entities\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Get Canonical Entities", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/canonical", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "canonical" ] }, "description": "Kanonische deduplizierte Entitäten über alle Dokumente. Zeigt wie oft eine Entity in verschiedenen Dokumenten vorkommt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/canonical", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "canonical" ] }, "description": "Kanonische deduplizierte Entitäten über alle Dokumente. Zeigt wie oft eine Entity in verschiedenen Dokumenten vorkommt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"entities\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Search entities", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/search", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "search" ] }, "description": "Suche nach Entitäten über alle Dokumente. Findet Entitäten die den Suchbegriff enthalten und zeigt das zugehörige Dokument.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/search", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "search" ] }, "description": "Suche nach Entitäten über alle Dokumente. Findet Entitäten die den Suchbegriff enthalten und zeigt das zugehörige Dokument.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"results\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Insights", "item": [ { "name": "Account insights", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle AI Insights für einen spezifischen CRM-Account. Inklusive Overall Health Score und Risk Level.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Optionale CRM-Account-ID fuer gezielte Insights." }, { "key": "type", "value": "", "type": "text", "description": "Filter nach Insight-Typ (z.B. 'churn_risk', 'sentiment')." }, { "key": "min_score", "value": "", "type": "text", "description": "Minimaler Score-Wert fuer Filterung." }, { "key": "max_score", "value": "", "type": "text", "description": "Maximaler Score-Wert fuer Filterung." }, { "key": "limit", "value": 50, "type": "text", "description": "Maximale Anzahl Ergebnisse." }, { "key": "offset", "value": 0, "type": "text", "description": "Offset fuer Paginierung." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle AI Insights für einen spezifischen CRM-Account. Inklusive Overall Health Score und Risk Level.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Optionale CRM-Account-ID fuer gezielte Insights." }, { "key": "type", "value": "", "type": "text", "description": "Filter nach Insight-Typ (z.B. 'churn_risk', 'sentiment')." }, { "key": "min_score", "value": "", "type": "text", "description": "Minimaler Score-Wert fuer Filterung." }, { "key": "max_score", "value": "", "type": "text", "description": "Maximaler Score-Wert fuer Filterung." }, { "key": "limit", "value": 50, "type": "text", "description": "Maximale Anzahl Ergebnisse." }, { "key": "offset", "value": 0, "type": "text", "description": "Offset fuer Paginierung." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"insights\": [\n {}\n ],\n \"generated_at\": \"string\"\n }\n }\n}" } ] }, { "name": "All insights", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle AI Insights Account-übergreifend oder gefiltert. Insight Types: - sentiment - Kommunikations-Sentiment - health_score - Beziehungs-Gesundheit - churn_risk - Abwanderungsrisiko - engagement - Engagement-Level - upsell_potential - Upselling-Potenzial - support_satisfaction - Support-Zufrieden...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Optional: Filter by CRM account" }, { "key": "type", "value": "", "type": "text", "description": "Optional: sentiment, health_score, churn_risk, engagement, upsell_potential" }, { "key": "min_score", "value": "", "type": "text", "description": "Optional: Minimum score" }, { "key": "max_score", "value": "", "type": "text", "description": "Optional: Maximum score" }, { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 50, max: 200)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Alle AI Insights Account-übergreifend oder gefiltert. Insight Types: - sentiment - Kommunikations-Sentiment - health_score - Beziehungs-Gesundheit - churn_risk - Abwanderungsrisiko - engagement - Engagement-Level - upsell_potential - Upselling-Potenzial - support_satisfaction - Support-Zufrieden...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Optional: Filter by CRM account" }, { "key": "type", "value": "", "type": "text", "description": "Optional: sentiment, health_score, churn_risk, engagement, upsell_potential" }, { "key": "min_score", "value": "", "type": "text", "description": "Optional: Minimum score" }, { "key": "max_score", "value": "", "type": "text", "description": "Optional: Maximum score" }, { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 50, max: 200)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"insights\": [\n {}\n ],\n \"categories\": [\n \"string\"\n ]\n }\n }\n}" } ] } ] }, { "name": "📁 Vehicles", "item": [ { "name": "Plan blueprint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Construction Plan / Blueprint Extract data from construction plans and technical drawings. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "construction_plan", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Construction Plan / Blueprint Extract data from construction plans and technical drawings. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "construction_plan", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {},\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Vehicle registration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Vehicle Registration Extract vehicle registration data. Fields: plate_number, make, model, VIN, owner, registration_date\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "vehicle_license", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Vehicle Registration Extract vehicle registration data. Fields: plate_number, make, model, VIN, owner, registration_date\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "vehicle_license", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"plate_number\": \"string\",\n \"vehicle_type\": \"string\",\n \"make\": \"string\",\n \"model\": \"string\",\n \"vin\": \"string\",\n \"registration_date\": \"string\",\n \"owner_name\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Workflow", "item": [ { "name": "Decide on Approval", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/approvals/decide", "host": [ "{{base_url}}" ], "path": [ "approvals", "decide" ] }, "description": "Trifft eine Freigabe-Entscheidung (genehmigt oder abgelehnt) fuer einen Approval-Schritt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "approval_id", "value": "", "type": "text", "description": "Approval-ID (z.B. appr_abc123) (required)" }, { "key": "decision", "value": "", "type": "text", "description": "Entscheidung: approved oder rejected (required)" }, { "key": "comment", "value": "", "type": "text", "description": "Kommentar zur Entscheidung (bei Ablehnung ggf. erforderlich)" }, { "key": "user_id", "value": "", "type": "text", "description": "Approver user_id (optional, Agent handelt im Auftrag eines Users)" }, { "key": "step_order", "value": "", "type": "text", "description": "Step-Nummer (optional, fuer Admin/Agent-Zugriff auf bestimmten Step)" } ] } } }, { "name": "Get Approval Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/approvals/status", "host": [ "{{base_url}}" ], "path": [ "approvals", "status" ] }, "description": "Gibt den vollstaendigen Status einer Freigabeanfrage zurueck inkl. aller Schritte, Audit-Trail und Deadline-Info.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "approval_id", "value": "", "type": "text", "description": "Approval-ID (required)" } ] } } }, { "name": "List Approvals", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/approvals/list", "host": [ "{{base_url}}" ], "path": [ "approvals", "list" ] }, "description": "Listet alle Freigabeanfragen des Accounts auf, optional gefiltert nach Status.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "", "type": "text", "description": "Status-Filter" }, { "key": "limit", "value": 50, "type": "text", "description": "" }, { "key": "offset", "value": 0, "type": "text", "description": "" } ] } } }, { "name": "Submit Document for Approval", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/approvals/submit", "host": [ "{{base_url}}" ], "path": [ "approvals", "submit" ] }, "description": "Reicht ein Dokument zur Freigabe ein. Definiert Freigeber, Typ (sequentiell/parallel/beliebig) und Deadline.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "", "type": "text", "description": "Dokument-ID fuer die Freigabe" }, { "key": "document_pofid", "value": "", "type": "text", "description": "Alternativ: POFID des Dokuments" }, { "key": "approval_type", "value": "sequential", "type": "text", "description": "sequential=nacheinander, parallel=alle gleichzeitig, any=einer reicht" }, { "key": "approvers", "value": "", "type": "text", "description": "Liste der Freigeber (required)" }, { "key": "deadline_hours", "value": 48, "type": "text", "description": "Frist in Stunden" }, { "key": "escalation_user_id", "value": "", "type": "text", "description": "User-ID fuer Eskalation bei Fristueberschreitung" }, { "key": "message", "value": "", "type": "text", "description": "Nachricht an die Freigeber" }, { "key": "title", "value": "", "type": "text", "description": "Titel der Freigabeanfrage" }, { "key": "require_comment_on_reject", "value": false, "type": "text", "description": "Kommentar bei Ablehnung erzwingen" } ] } } }, { "name": "Workflow AI: Agent-Templates auflisten", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_list", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_list" ] }, "description": "Listet alle aktiven Agent-First Workflow-Templates des Accounts auf. Zeigt Name, Beschreibung, Trigger-Typ, Ausfuehrungs-Statistiken und Guardrails.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Workflow AI: Agent-Template Details abrufen", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_get/{uuid}", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_get", "{uuid}" ] }, "description": "Gibt ein einzelnes Agent-Workflow-Template mit allen Details zurueck: Instruktionstext, Trigger-Konfiguration, Tool-Whitelist, HITL-Regeln, Validierungsregeln, Statistiken.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" } }, { "name": "Workflow AI: Agent-Template erstellen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_add", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_add" ] }, "description": "Erstellt ein neues Agent-First Workflow-Template. Definiert den Workflow ueber natuerliche Sprache (instruction_text) statt visueller Konfiguration. Unterstuetzt Trigger, Tool-Whitelists, Cost Caps, HITL-Regeln und Validierung.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Agent-Workflow-Templates (required)" }, { "key": "instruction_text", "value": "", "type": "text", "description": "Natuerlichsprachliche Workflow-Anweisung fuer den Agent (required)" }, { "key": "description", "value": "", "type": "text", "description": "Optionale Beschreibung" }, { "key": "trigger_type", "value": "", "type": "text", "description": "Trigger-Typ: manual, document_uploaded, document_edited, document_moved, document_deleted, document_copied, version_created, aidms_completed, agent_completed, classification_done, metafield_changed, status_changed, task_completed, approval_completed, signature_completed, schedule, due_date, retention_expired, storage_mount_sync, connector_import, webhook_received, email_received, bulk_action" }, { "key": "trigger_config", "value": "", "type": "text", "description": "Trigger-Konfiguration: workspace_id, cron_expression, timezone, document_type, field_name, target_status, mount_path, file_extensions, webhook_secret, sender_filter, subject_filter, connector_id" }, { "key": "llm_tier", "value": "", "type": "text", "description": "AI-Modell: basic-pro-max (200cr/5K), premium-pro-max (300cr/5K, default), ultra-pro-max (500cr/5K)" }, { "key": "allowed_tools", "value": "", "type": "text", "description": "Tool-Whitelist (Array von tool_ids). NULL = alle Tools erlaubt." }, { "key": "max_iterations", "value": "", "type": "text", "description": "Max Agent-Loop Iterationen (default: 25)" }, { "key": "max_credits_per_execution", "value": "", "type": "text", "description": "Cost Cap pro Ausfuehrung in Credits" }, { "key": "require_confirmation", "value": "", "type": "text", "description": "1 = Copilot-Modus (Mensch muss jeden Step freigeben)" }, { "key": "hitl_rules", "value": "", "type": "text", "description": "Human-in-the-Loop Regeln (z.B. bei Betrag > 5000 pausieren)" }, { "key": "validation_rules", "value": "", "type": "text", "description": "Output-Validierung pro Step" } ] } } }, { "name": "Workflow AI: Agent-Template aktualisieren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_update/{uuid}", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_update", "{uuid}" ] }, "description": "Aktualisiert ein bestehendes Agent-Workflow-Template. Nur uebergebene Felder werden geaendert (Partial Update). Version wird automatisch hochgezaehlt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu aendernden Templates (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name" }, { "key": "instruction_text", "value": "", "type": "text", "description": "Neue Workflow-Anweisung" }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung" }, { "key": "trigger_type", "value": "", "type": "text", "description": "Neuer Trigger-Typ" }, { "key": "trigger_config", "value": "", "type": "text", "description": "Neue Trigger-Konfiguration" }, { "key": "llm_tier", "value": "", "type": "text", "description": "Neues AI-Modell: basic-pro-max, premium-pro-max, ultra-pro-max" }, { "key": "allowed_tools", "value": "", "type": "text", "description": "Neue Tool-Whitelist" }, { "key": "max_iterations", "value": "", "type": "text", "description": "Neue max Iterationen" }, { "key": "max_credits_per_execution", "value": "", "type": "text", "description": "Neues Cost Cap" }, { "key": "require_confirmation", "value": "", "type": "text", "description": "Copilot-Modus 0/1" }, { "key": "hitl_rules", "value": "", "type": "text", "description": "Neue HITL-Regeln" }, { "key": "validation_rules", "value": "", "type": "text", "description": "Neue Validierungsregeln" }, { "key": "is_active", "value": "", "type": "text", "description": "0 = deaktivieren, 1 = aktivieren" } ] } } }, { "name": "Workflow AI: Agent-Template loeschen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_delete/{uuid}", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_delete", "{uuid}" ] }, "description": "Loescht (deaktiviert) ein Agent-Workflow-Template per Soft-Delete (is_active = 0). Template bleibt fuer Audit-Zwecke erhalten.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des zu loeschenden Templates (required)" } ] } } }, { "name": "Workflow AI: Agent-Workflow ausfuehren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_execute", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_execute" ] }, "description": "Startet die Ausfuehrung eines Agent-Workflow-Templates. Erstellt eine Execution, pusht den Job in die Queue und gibt sofort die execution_uuid zurueck. Der Agent fuehrt den Workflow asynchron anhand der instruction_text aus.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "uuid", "value": "", "type": "text", "description": "UUID des Agent-Templates (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice File ID des Dokuments" }, { "key": "pofids", "value": "", "type": "text", "description": "Mehrere POFIDs fuer Batch-Ausfuehrung" }, { "key": "aidms_data", "value": "", "type": "text", "description": "Recycled AI-DMS Ergebnisse (classification, extracted_fields, ocr_text, idp_result)" }, { "key": "trigger_context", "value": "", "type": "text", "description": "Zusaetzlicher Trigger-Kontext" }, { "key": "webhook_payload", "value": "", "type": "text", "description": "Webhook-Payload (bei webhook_received Trigger)" }, { "key": "metadata", "value": "", "type": "text", "description": "Zusaetzliche Metadaten" } ] } } }, { "name": "Workflow AI: Agent-Workflow testen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_test", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_test" ] }, "description": "Startet einen Test-Lauf eines Agent-Workflows. Kann mit einer Inline-Instruktion oder einer Template-UUID ausgefuehrt werden. Template-Constraints (Tool-Whitelist, HITL-Regeln) werden uebernommen, Input-Overrides haben Vorrang. Reduziertes Iterations- und Credit-Limit.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "instruction_text", "value": "", "type": "text", "description": "Inline Workflow-Anweisung (alternativ zu uuid)" }, { "key": "uuid", "value": "", "type": "text", "description": "Template-UUID (Constraints werden uebernommen)" }, { "key": "pofid", "value": "", "type": "text", "description": "Test-Dokument POFID" }, { "key": "trigger_type", "value": "", "type": "text", "description": "Simulierter Trigger-Typ" }, { "key": "llm_tier", "value": "", "type": "text", "description": "AI-Modell fuer den Test: basic-pro-max, premium-pro-max, ultra-pro-max" }, { "key": "max_iterations", "value": "", "type": "text", "description": "Max Iterationen (default: 15)" }, { "key": "max_credits", "value": "", "type": "text", "description": "Max Credits (default: 10)" } ] } } }, { "name": "Workflow AI: Agent-Workflow auf Dokument(e) ausfuehren", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/workflow_templates/agent_run_on_document", "host": [ "{{base_url}}" ], "path": [ "workflow_templates", "agent_run_on_document" ] }, "description": "Fuehrt einen Agent-Workflow direkt auf ein oder mehrere Dokumente aus. Erstellt pro Dokument (POFID) eine separate Execution. Recycled vorhandene AI-DMS Daten (Klassifikation, OCR, extrahierte Felder). Ideal fuer Batch-Verarbeitung.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workflow_uuid", "value": "", "type": "text", "description": "UUID des Agent-Templates (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "Einzelne PaperOffice File ID" }, { "key": "pofids", "value": "", "type": "text", "description": "Mehrere POFIDs (Array oder kommasepariert)" }, { "key": "aidms_data", "value": "", "type": "text", "description": "AI-DMS Ergebnisse zum Recyclen" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace/Ordner-ID" }, { "key": "priority", "value": "", "type": "text", "description": "Job-Prioritaet (default: 800)" } ] } } } ] }, { "name": "📁 Contracts", "item": [ { "name": "Id cardpassport", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Identity Document Extract data from ID cards, passports, and driver licenses. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "identity_document", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Identity Document Extract data from ID cards, passports, and driver licenses. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | |...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "identity_document", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"document_type\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"date_of_birth\": \"string\",\n \"place_of_birth\": \"string\",\n \"nationality\": \"string\",\n \"document_number\": \"string\",\n \"issue_date\": \"string\",\n \"expiry_date\": \"string\",\n \"address\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Insurance policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Insurance Policy Extract data from insurance policies and certificates. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_c...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "insurance_policy", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Insurance Policy Extract data from insurance policies and certificates. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_c...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "insurance_policy", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"policy_number\": \"string\",\n \"policy_holder\": \"string\",\n \"insurance_type\": \"string\",\n \"coverage_amount\": 0,\n \"premium\": 0,\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"provider\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] }, { "name": "Legal document", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Legal Document Extract data from legal documents and contracts. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collectio...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "legal_document", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Legal Document Extract data from legal documents and contracts. Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file_1 | file | Yes | Document file PDF, PNG, JPG | | model | string | Yes | premium or ultra vision required | | idp_collectio...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "legal_document", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"data\": {\n \"contract_type\": \"string\",\n \"parties\": \"string\",\n \"contract_date\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"value\": 0,\n \"notice_period\": \"string\"\n },\n \"text\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Documents", "item": [ { "name": "Create Document from Content", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/create-from-content", "host": [ "{{base_url}}" ], "path": [ "document_generation", "create-from-content" ] }, "description": "Generiert ein PDF-Dokument aus Markdown- oder HTML-Content und speichert es direkt im DMS. Unterstuetzt Tabellen, Listen, Code-Blocks, Bilder und automatische Metadaten-Zuweisung.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "content", "value": "", "type": "text", "description": "Markdown oder HTML Content fuer das Dokument (erforderlich) (required)" }, { "key": "content_type", "value": "markdown", "type": "text", "description": "Typ des Contents: markdown oder html" }, { "key": "output_format", "value": "pdf", "type": "text", "description": "Ausgabeformat (aktuell nur pdf)" }, { "key": "title", "value": "", "type": "text", "description": "Dokumenttitel (wird auch als Dateiname verwendet)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Ziel-Workspace ID (required). Use po_workspaces_list to find valid workspace IDs. (required)" }, { "key": "metadata", "value": "", "type": "text", "description": "Metadaten als Key-Value Paare (werden als IDP-Felder gespeichert)" }, { "key": "language", "value": "de", "type": "text", "description": "Sprache fuer Formatierung (de/en)" }, { "key": "auto_classify", "value": false, "type": "text", "description": "Automatische Klassifikation nach Erstellung" }, { "key": "custom_css", "value": "", "type": "text", "description": "Zusaetzliches CSS fuer das PDF-Layout" }, { "key": "header_html", "value": "", "type": "text", "description": "HTML fuer Seitenkopf" }, { "key": "footer_html", "value": "", "type": "text", "description": "HTML fuer Seitenfuss" } ] } } }, { "name": "Create Document from Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/create-from-template", "host": [ "{{base_url}}" ], "path": [ "document_generation", "create-from-template" ] }, "description": "Generiert ein PDF-Dokument aus einem gespeicherten Template mit Variablen-Ersetzung und speichert es im DMS.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "ID des Templates (z.B. tpl_rechnung_standard) (required)" }, { "key": "variables", "value": "", "type": "text", "description": "Variablen-Werte fuer die Platzhalter im Template. Arrays fuer {{#each}} Bloecke. (required)" }, { "key": "output_format", "value": "pdf", "type": "text", "description": "" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Ziel-Workspace ID (required). Use po_workspaces_list to find valid workspace IDs. (required)" }, { "key": "title", "value": "", "type": "text", "description": "Dokumenttitel (ueberschreibt Template-Name). Kann {{variable}} Platzhalter enthalten." }, { "key": "metadata", "value": "", "type": "text", "description": "Zusaetzliche Metadaten" }, { "key": "auto_classify", "value": false, "type": "text", "description": "" } ] } } }, { "name": "Create Document Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/template-create", "host": [ "{{base_url}}" ], "path": [ "document_generation", "template-create" ] }, "description": "Erstellt eine neue Dokumentvorlage mit HTML-Content und Platzhalter-Definitionen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Eindeutige Template-ID (wird auto-generiert wenn leer)" }, { "key": "name", "value": "", "type": "text", "description": "Name des Templates (required)" }, { "key": "html_content", "value": "", "type": "text", "description": "HTML-Content mit {{variable}} Platzhaltern (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Templates" }, { "key": "category", "value": "general", "type": "text", "description": "Kategorie (z.B. invoices, contracts, reports)" }, { "key": "variables_schema", "value": "", "type": "text", "description": "JSON-Schema der erwarteten Variablen" }, { "key": "page_format", "value": "A4", "type": "text", "description": "Seitenformat (A4, A3, Letter)" }, { "key": "page_orientation", "value": "portrait", "type": "text", "description": "" }, { "key": "margin_top", "value": 20, "type": "text", "description": "" }, { "key": "margin_right", "value": 15, "type": "text", "description": "" }, { "key": "margin_bottom", "value": 20, "type": "text", "description": "" }, { "key": "margin_left", "value": 15, "type": "text", "description": "" }, { "key": "header_html", "value": "", "type": "text", "description": "HTML fuer Seitenkopf" }, { "key": "footer_html", "value": "", "type": "text", "description": "HTML fuer Seitenfuss" } ] } } }, { "name": "Delete Document Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/template-delete", "host": [ "{{base_url}}" ], "path": [ "document_generation", "template-delete" ] }, "description": "Loescht (deaktiviert) eine Dokumentvorlage. Soft-Delete — kann reaktiviert werden.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Template-ID (required)" } ] } } }, { "name": "Document Vision Analysis", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/vision/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "vision", "{document_id}" ] }, "description": "Liefert die Vision-Analyse-Daten eines Dokuments: Extrahierte Tabellen, Charts, Formulare, Barcodes, Layout-Informationen. Vom Harvester automatisch per KI-Vision erstellt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/vision/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "vision", "{document_id}" ] }, "description": "Liefert die Vision-Analyse-Daten eines Dokuments: Extrahierte Tabellen, Charts, Formulare, Barcodes, Layout-Informationen. Vom Harvester automatisch per KI-Vision erstellt.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"analysis\": {\n \"description\": \"string\",\n \"objects\": [\n \"string\"\n ],\n \"text_detected\": \"string\",\n \"confidence\": 0\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Documents List - Ultimate Search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/documents-list", "host": [ "{{base_url}}" ], "path": [ "documents", "documents-list" ] }, "description": "ULTIMATE SEARCH ENGINE - Intelligente Multi-Source Dokumentensuche (31.01.2026)\n\nDurchsucht Dokumente mit 4 parallelen Suchquellen und RRF-Fusion:\n1. **Fulltext Search**: Dateiname + Meta-Fields (MATCH AGAINST)\n2. **OCR-Text Search**: Extrahierter Text aus allen Dokumentseiten\n3. **Entity Search**: Firmen, Personen, IBAN, Betraege, Daten (inkl. Canonical Resolution)\n4. **Semantic Search**: Embeddings mit Contextual Retrieval (qwen3-embedding:8b)\n\n**INTELLIGENT MODE**: Query-Typ wird automatisch erkannt:\n- short_keyword (1-2 Woerter): NUR Fulltext/OCR/Entity\n- keyword (3-7 Woerter): Hybrid mit BM25-Fokus \n- entity: IBAN, Betraege, Daten erkannt -> Entity Search dominiert\n- question: Fragewort erkannt -> Semantic bevorzugt\n- natural (8+ Woerter): Semantic Search dominant\n\n**Features**:\n- RRF Fusion kombiniert alle Quellen mit konfigurierbarer Gewichtung\n- Knowledge Graph Expansion fuer verwandte Dokumente\n- Cross-Encoder Reranking (LLM-basiert) fuer Top-20 Ergebnisse\n- Enterprise Entity Resolution (Canonical Entities)\n- Embedding-Type-Weights (contextual:1.6x, vision:1.3x, etc.)\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Pflicht: ID des Workspace (required)" }, { "key": "global_search", "value": "", "type": "text", "description": "Suchbegriff fuer Ultimate Search (alle 4 Quellen)" }, { "key": "search_mode", "value": "intelligent", "type": "text", "description": "intelligent=automatische Query-Typ-Erkennung (empfohlen)" }, { "key": "search_preference", "value": "balanced", "type": "text", "description": "keyword=Stichwortsuche, semantic=KI-Suche, balanced=ausgewogen" }, { "key": "search_scope", "value": "current", "type": "text", "description": "current=nur aktueller Workspace, all=alle Workspaces" }, { "key": "similarity_threshold", "value": 0.35, "type": "text", "description": "Minimum Similarity fuer Semantic Search (0.0-1.0)" }, { "key": "page", "value": 1, "type": "text", "description": "Seitennummer fuer Pagination" }, { "key": "limit", "value": 500, "type": "text", "description": "Dokumente pro Seite (max 500)" }, { "key": "sort", "value": "created_datetime", "type": "text", "description": "Sortierfeld" }, { "key": "order", "value": "DESC", "type": "text", "description": "Order" }, { "key": "__document__data__classification__document_type", "value": "", "type": "text", "description": "Filter: Dokumenttypen (JSON Array oder komma-separiert)" }, { "key": "__document__content__extraction__keywords", "value": "", "type": "text", "description": "Filter: Keywords" }, { "key": "__document__data__workflow__state", "value": "", "type": "text", "description": "Filter: Workflow-Status" }, { "key": "__document__data__classification__locale", "value": "", "type": "text", "description": "Filter: Sprache/Locale" }, { "key": "__document__data__metadata__save_paths", "value": "", "type": "text", "description": "Filter: Speicherpfade (PREFIX_WILDCARD:/Pfad oder EXACT:/Pfad)" }, { "key": "ai_dms_status", "value": "", "type": "text", "description": "Filter: AI-DMS Tier" }, { "key": "ai_agent_status", "value": "", "type": "text", "description": "Filter: AI-Agent Status" }, { "key": "date_from", "value": "", "type": "text", "description": "Filter: Datum von (YYYY-MM-DD)" }, { "key": "date_to", "value": "", "type": "text", "description": "Filter: Datum bis (YYYY-MM-DD)" }, { "key": "share_context", "value": "", "type": "text", "description": "Share context" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/documents-list", "host": [ "{{base_url}}" ], "path": [ "documents", "documents-list" ] }, "description": "ULTIMATE SEARCH ENGINE - Intelligente Multi-Source Dokumentensuche (31.01.2026)\n\nDurchsucht Dokumente mit 4 parallelen Suchquellen und RRF-Fusion:\n1. **Fulltext Search**: Dateiname + Meta-Fields (MATCH AGAINST)\n2. **OCR-Text Search**: Extrahierter Text aus allen Dokumentseiten\n3. **Entity Search**: Firmen, Personen, IBAN, Betraege, Daten (inkl. Canonical Resolution)\n4. **Semantic Search**: Embeddings mit Contextual Retrieval (qwen3-embedding:8b)\n\n**INTELLIGENT MODE**: Query-Typ wird automatisch erkannt:\n- short_keyword (1-2 Woerter): NUR Fulltext/OCR/Entity\n- keyword (3-7 Woerter): Hybrid mit BM25-Fokus \n- entity: IBAN, Betraege, Daten erkannt -> Entity Search dominiert\n- question: Fragewort erkannt -> Semantic bevorzugt\n- natural (8+ Woerter): Semantic Search dominant\n\n**Features**:\n- RRF Fusion kombiniert alle Quellen mit konfigurierbarer Gewichtung\n- Knowledge Graph Expansion fuer verwandte Dokumente\n- Cross-Encoder Reranking (LLM-basiert) fuer Top-20 Ergebnisse\n- Enterprise Entity Resolution (Canonical Entities)\n- Embedding-Type-Weights (contextual:1.6x, vision:1.3x, etc.)\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Pflicht: ID des Workspace (required)" }, { "key": "global_search", "value": "", "type": "text", "description": "Suchbegriff fuer Ultimate Search (alle 4 Quellen)" }, { "key": "search_mode", "value": "intelligent", "type": "text", "description": "intelligent=automatische Query-Typ-Erkennung (empfohlen)" }, { "key": "search_preference", "value": "balanced", "type": "text", "description": "keyword=Stichwortsuche, semantic=KI-Suche, balanced=ausgewogen" }, { "key": "search_scope", "value": "current", "type": "text", "description": "current=nur aktueller Workspace, all=alle Workspaces" }, { "key": "similarity_threshold", "value": 0.35, "type": "text", "description": "Minimum Similarity fuer Semantic Search (0.0-1.0)" }, { "key": "page", "value": 1, "type": "text", "description": "Seitennummer fuer Pagination" }, { "key": "limit", "value": 500, "type": "text", "description": "Dokumente pro Seite (max 500)" }, { "key": "sort", "value": "created_datetime", "type": "text", "description": "Sortierfeld" }, { "key": "order", "value": "DESC", "type": "text", "description": "Order" }, { "key": "__document__data__classification__document_type", "value": "", "type": "text", "description": "Filter: Dokumenttypen (JSON Array oder komma-separiert)" }, { "key": "__document__content__extraction__keywords", "value": "", "type": "text", "description": "Filter: Keywords" }, { "key": "__document__data__workflow__state", "value": "", "type": "text", "description": "Filter: Workflow-Status" }, { "key": "__document__data__classification__locale", "value": "", "type": "text", "description": "Filter: Sprache/Locale" }, { "key": "__document__data__metadata__save_paths", "value": "", "type": "text", "description": "Filter: Speicherpfade (PREFIX_WILDCARD:/Pfad oder EXACT:/Pfad)" }, { "key": "ai_dms_status", "value": "", "type": "text", "description": "Filter: AI-DMS Tier" }, { "key": "ai_agent_status", "value": "", "type": "text", "description": "Filter: AI-Agent Status" }, { "key": "date_from", "value": "", "type": "text", "description": "Filter: Datum von (YYYY-MM-DD)" }, { "key": "date_to", "value": "", "type": "text", "description": "Filter: Datum bis (YYYY-MM-DD)" }, { "key": "share_context", "value": "", "type": "text", "description": "Share context" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"applied_filters\": [\n \"string\"\n ],\n \"count\": 0,\n \"documents\": [\n \"string\"\n ],\n \"documents_meta_fields\": [\n {\n \"documents_meta_fields_id\": 0,\n \"field_key\": \"string\"\n }\n ],\n \"filter_values\": {\n \"ai_dms_status\": [\n \"string\"\n ],\n \"ai_agent_status\": [\n \"string\"\n ],\n \"date_range\": [\n \"string\"\n ]\n },\n \"message\": \"string\",\n \"pagination\": {\n \"total\": 0,\n \"current_page\": 0,\n \"total_pages\": 0,\n \"limit\": 0,\n \"showing_from\": 0,\n \"showing_to\": 0,\n \"has_more\": true,\n \"message\": \"string\"\n },\n \"processing_time\": \"string\",\n \"search_stats\": {\n \"mode\": \"string\",\n \"scope\": \"string\",\n \"query_type\": \"string\",\n \"semantic_matches\": 0,\n \"fulltext_matches\": 0,\n \"ocr_matches\": 0,\n \"entity_matches\": 0,\n \"total_sources_used\": 0,\n \"embedding_from_cache\": true,\n \"embedding_time_ms\": 0,\n \"search_time_ms\": 0\n },\n \"stats\": {\n \"all\": 0,\n \"not_indexed\": 0,\n \"indexed\": 0,\n \"agent_processed\": 0,\n \"waiting\": 0,\n \"processing\": 0,\n \"agents_docs\": 0,\n \"workspaces\": 0\n },\n \"storage_status\": {\n \"mode\": \"string\",\n \"is_offline\": true\n },\n \"total\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Get Document Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/template-get", "host": [ "{{base_url}}" ], "path": [ "document_generation", "template-get" ] }, "description": "Gibt Details eines Dokumentvorlagen-Templates zurueck inkl. HTML-Content und Variablen-Schema.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Template-ID (required)" } ] } } }, { "name": "Linked documents", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Dokumente die mit einem CRM-Account verknüpft sind. Link Types: - invoice - Rechnungen - contract - Verträge - quote - Angebote - correspondence - Korrespondenz - related - Sonstige\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 50, max: 200)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Dokumente die mit einem CRM-Account verknüpft sind. Link Types: - invoice - Rechnungen - contract - Verträge - quote - Angebote - correspondence - Korrespondenz - related - Sonstige\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 50, max: 200)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"linked_documents\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "List Document Templates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/templates-list", "host": [ "{{base_url}}" ], "path": [ "document_generation", "templates-list" ] }, "description": "Listet alle verfuegbaren Dokumentvorlagen des Accounts auf.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "category", "value": "", "type": "text", "description": "Kategorie-Filter (z.B. invoices, contracts, reports)" }, { "key": "limit", "value": 50, "type": "text", "description": "Max Ergebnisse (1-200)" }, { "key": "offset", "value": 0, "type": "text", "description": "" } ] } } }, { "name": "Publisher Merge", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/publishers/{source_publisher_id}/merge", "host": [ "{{base_url}}" ], "path": [ "publishers", "{source_publisher_id}", "merge" ] }, "description": "Zwei Publisher zusammenfuehren und Referenzen verschieben\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "source_publisher_id", "value": "", "type": "text", "description": "ID des Publishers der aufgeloest wird (required)" }, { "key": "target_publisher_id", "value": "", "type": "text", "description": "ID des Ziel-Publishers in den gemerged wird (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/publishers/{source_publisher_id}/merge", "host": [ "{{base_url}}" ], "path": [ "publishers", "{source_publisher_id}", "merge" ] }, "description": "Zwei Publisher zusammenfuehren und Referenzen verschieben\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "source_publisher_id", "value": "", "type": "text", "description": "ID des Publishers der aufgeloest wird (required)" }, { "key": "target_publisher_id", "value": "", "type": "text", "description": "ID des Ziel-Publishers in den gemerged wird (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"welcome\": \"string\"\n}" } ] }, { "name": "Publisher Rename", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/publishers/{publisher_id}/rename", "host": [ "{{base_url}}" ], "path": [ "publishers", "{publisher_id}", "rename" ] }, "description": "Publisher umbenennen mit automatischer Alias-Speicherung\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "publisher_id", "value": "", "type": "text", "description": "ID des Publishers (required)" }, { "key": "new_name", "value": "", "type": "text", "description": "Neuer Name fuer den Publisher (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/publishers/{publisher_id}/rename", "host": [ "{{base_url}}" ], "path": [ "publishers", "{publisher_id}", "rename" ] }, "description": "Publisher umbenennen mit automatischer Alias-Speicherung\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "publisher_id", "value": "", "type": "text", "description": "ID des Publishers (required)" }, { "key": "new_name", "value": "", "type": "text", "description": "Neuer Name fuer den Publisher (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"welcome\": \"string\"\n}" } ] }, { "name": "Update Document Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_generation/template-update", "host": [ "{{base_url}}" ], "path": [ "document_generation", "template-update" ] }, "description": "Aktualisiert eine bestehende Dokumentvorlage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template_id", "value": "", "type": "text", "description": "Template-ID (erforderlich) (required)" }, { "key": "name", "value": "", "type": "text", "description": "" }, { "key": "html_content", "value": "", "type": "text", "description": "" }, { "key": "description", "value": "", "type": "text", "description": "" }, { "key": "category", "value": "", "type": "text", "description": "" }, { "key": "variables_schema", "value": "", "type": "text", "description": "" }, { "key": "page_format", "value": "", "type": "text", "description": "" }, { "key": "page_orientation", "value": "", "type": "text", "description": "" }, { "key": "margin_top", "value": "", "type": "text", "description": "" }, { "key": "margin_right", "value": "", "type": "text", "description": "" }, { "key": "margin_bottom", "value": "", "type": "text", "description": "" }, { "key": "margin_left", "value": "", "type": "text", "description": "" }, { "key": "header_html", "value": "", "type": "text", "description": "" }, { "key": "footer_html", "value": "", "type": "text", "description": "" }, { "key": "is_active", "value": "", "type": "text", "description": "1=aktiv, 0=deaktiviert" } ] } } } ] }, { "name": "📁 Relations", "item": [ { "name": "Get Document Relations", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/document_relations", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "document_relations" ] }, "description": "Beziehungen eines Dokuments zu anderen Dokumenten. Relation Types: - same_partner - Gleicher Geschäftspartner - same_reference - Gleiche Referenznummer - business_flow - Geschäftsvorgang - invoice_for, quote_for, delivery_for, contract_with, order_for, payment_for, related_to\n\n💰 **Kosten**: 10 Credits/document (0.01€/document)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/knowledge_graph/document_relations", "host": [ "{{base_url}}" ], "path": [ "knowledge_graph", "document_relations" ] }, "description": "Beziehungen eines Dokuments zu anderen Dokumenten. Relation Types: - same_partner - Gleicher Geschäftspartner - same_reference - Gleiche Referenznummer - business_flow - Geschäftsvorgang - invoice_for, quote_for, delivery_for, contract_with, order_for, payment_for, related_to\n\n💰 **Kosten**: 10 Credits/document (0.01€/document)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"relations\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Revisions", "item": [ { "name": "Document revisions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Versionshistorie eines Dokuments. Zeigt alle Änderungen mit Timestamp, User und Änderungsdetails.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice-Dokument-ID, fuer die Revisionen abgerufen werden sollen. Wird als URL-Parameter uebergeben. (required)" }, { "key": "limit", "value": 50, "type": "text", "description": "Maximale Anzahl zurueckgegebener Revisionen." }, { "key": "offset", "value": 0, "type": "text", "description": "Offset fuer Paginierung." }, { "key": "action", "value": "", "type": "text", "description": "Filter nach Aktionstyp (z.B. 'field_changed', 'folder_created')." }, { "key": "field_key", "value": "", "type": "text", "description": "Filter nach geaendertem Feld (z.B. 'Rechnungsnummer')." }, { "key": "date_from", "value": "", "type": "text", "description": "Revisionen ab diesem Datum (YYYY-MM-DD)." }, { "key": "date_to", "value": "", "type": "text", "description": "Revisionen bis zu diesem Datum (YYYY-MM-DD)." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Versionshistorie eines Dokuments. Zeigt alle Änderungen mit Timestamp, User und Änderungsdetails.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "pofid", "value": "", "type": "text", "description": "PaperOffice-Dokument-ID, fuer die Revisionen abgerufen werden sollen. Wird als URL-Parameter uebergeben. (required)" }, { "key": "limit", "value": 50, "type": "text", "description": "Maximale Anzahl zurueckgegebener Revisionen." }, { "key": "offset", "value": 0, "type": "text", "description": "Offset fuer Paginierung." }, { "key": "action", "value": "", "type": "text", "description": "Filter nach Aktionstyp (z.B. 'field_changed', 'folder_created')." }, { "key": "field_key", "value": "", "type": "text", "description": "Filter nach geaendertem Feld (z.B. 'Rechnungsnummer')." }, { "key": "date_from", "value": "", "type": "text", "description": "Revisionen ab diesem Datum (YYYY-MM-DD)." }, { "key": "date_to", "value": "", "type": "text", "description": "Revisionen bis zu diesem Datum (YYYY-MM-DD)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"revisions\": [\n {\n \"revision_id\": 0,\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"comment\": \"string\",\n \"file_size\": 0\n }\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "📁 Sentiment", "item": [ { "name": "Sentiment history", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Sentiment-Analyse für einen Account über Zeit. Zeigt Sentiment-Verlauf aus E-Mails und Notizen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "days", "value": "", "type": "text", "description": "History period in days (default: 90, max: 365)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Sentiment-Analyse für einen Account über Zeit. Zeigt Sentiment-Verlauf aus E-Mails und Notizen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "days", "value": "", "type": "text", "description": "History period in days (default: 90, max: 365)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"history\": [\n {}\n ],\n \"avg_score\": 0,\n \"trend\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Workspace", "item": [ { "name": "Check access", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Check Workspace Access Verify if the current user session has access to a specific workspace. Returns: Access status and session details.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Required: Workspace ID to check access for" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Check Workspace Access Verify if the current user session has access to a specific workspace. Returns: Access status and session details.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Required: Workspace ID to check access for" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"has_access\": true,\n \"requires_password\": true,\n \"requires_code\": true,\n \"status\": \"success\"\n}" } ] }, { "name": "Send Access Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Send access code to user's email for password-protected workspace access.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer des Empfaengers (internationales Format, z.B. +49171...). (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID fuer den der Code gilt. Nicht erforderlich bei Test-SMS." }, { "key": "is_test", "value": false, "type": "text", "description": "Nur Test-SMS senden (Code wird in Response zurueckgegeben)." }, { "key": "person_number", "value": 1, "type": "text", "description": "Personennummer bei 2-Personen-Freigabe (1 oder 2)." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Send access code to user's email for password-protected workspace access.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer des Empfaengers (internationales Format, z.B. +49171...). (required)" }, { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace-ID fuer den der Code gilt. Nicht erforderlich bei Test-SMS." }, { "key": "is_test", "value": false, "type": "text", "description": "Nur Test-SMS senden (Code wird in Response zurueckgegeben)." }, { "key": "person_number", "value": 1, "type": "text", "description": "Personennummer bei 2-Personen-Freigabe (1 oder 2)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"sent\": true,\n \"expires_in_seconds\": 0,\n \"status\": \"success\"\n}" } ] }, { "name": "Verify Access Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Verify email-sent access code for workspace access.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "ID des Workspaces fuer den der Code verifiziert werden soll. (required)" }, { "key": "code", "value": "", "type": "text", "description": "Der 6-stellige Verifizierungscode aus der SMS. (required)" }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer, an die der Code gesendet wurde. (required)" }, { "key": "person_number", "value": 1, "type": "text", "description": "Personennummer bei 2-Personen-Freigabe." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Verify email-sent access code for workspace access.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "ID des Workspaces fuer den der Code verifiziert werden soll. (required)" }, { "key": "code", "value": "", "type": "text", "description": "Der 6-stellige Verifizierungscode aus der SMS. (required)" }, { "key": "phone", "value": "", "type": "text", "description": "Telefonnummer, an die der Code gesendet wurde. (required)" }, { "key": "person_number", "value": 1, "type": "text", "description": "Personennummer bei 2-Personen-Freigabe." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"verified\": true,\n \"access_token\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Verify password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Verify Workspace Password Authenticate with workspace password to create a session. Use Case: Password-protected workspaces require verification before access.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "ID des Workspaces. (required)" }, { "key": "password", "value": "", "type": "text", "description": "Das zu verifizierende Workspace-Passwort. (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Verify Workspace Password Authenticate with workspace password to create a session. Use Case: Password-protected workspaces require verification before access.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "ID des Workspaces. (required)" }, { "key": "password", "value": "", "type": "text", "description": "Das zu verifizierende Workspace-Passwort. (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"verified\": true,\n \"access_token\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Statistics", "item": [ { "name": "Crm stats", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Globale CRM Intelligence Statistiken. Übersicht über alle Accounts, Insights, Risiken und Chancen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Globale CRM Intelligence Statistiken. Übersicht über alle Accounts, Insights, Risiken und Chancen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"stats\": {},\n \"period\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Workspaces", "item": [ { "name": "Validate Workspace Storage Health", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/workspace-storage-health", "host": [ "{{base_url}}" ], "path": [ "documents", "workspace-storage-health" ] }, "description": "Prueft den Storage-Status eines Workspaces: Cloud-Mode, BYOS-Health, Latenz, Offline-Status, Auto-Lock Grund. Besonders wichtig fuer BYOD/BYOS Workspaces mit externem Storage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace ID to check (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/workspace-storage-health", "host": [ "{{base_url}}" ], "path": [ "documents", "workspace-storage-health" ] }, "description": "Prueft den Storage-Status eines Workspaces: Cloud-Mode, BYOS-Health, Latenz, Offline-Status, Auto-Lock Grund. Besonders wichtig fuer BYOD/BYOS Workspaces mit externem Storage.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "workspace_id", "value": "", "type": "text", "description": "Workspace ID to check (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_billing\": {\n \"credits\": {\n \"total_monthly\": 0,\n \"remaining_monthly\": 0,\n \"renewal_days\": 0\n },\n \"job\": \"poai-job_xxx\",\n \"requests\": {\n \"limits\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"current\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"remaining\": {\n \"per_minute\": 0,\n \"per_hour\": 0,\n \"per_day\": 0\n },\n \"next_possible_request_seconds\": 0,\n \"queue\": {\n \"current_jobs\": 0,\n \"current_credits\": 0,\n \"max_jobs\": 0,\n \"max_credits\": 0,\n \"max_concurrent\": 0,\n \"remaining_jobs\": 0,\n \"remaining_credits\": 0\n }\n },\n \"effective_token\": \"string\",\n \"account_id\": \"poai-job_xxx\",\n \"plan\": {\n \"tier\": \"string\",\n \"name\": \"string\"\n },\n \"user\": {\n \"ip\": \"string\",\n \"is_internal\": true\n }\n },\n \"processing_time\": \"string\",\n \"status\": \"string\",\n \"storage_status\": {\n \"mode\": \"string\",\n \"is_offline\": true\n },\n \"mode\": \"string\",\n \"documents\": \"string\"\n}" } ] }, { "name": "Workspace create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create New Workspace Create a workspace to organize documents. Optional metadata: - data_contact: Contact information - data_address: Address information\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Workspaces (Pflichtfeld, darf nicht leer sein). (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Workspaces." }, { "key": "type", "value": "folder", "type": "text", "description": "Typ des Workspaces." }, { "key": "workspace_tier", "value": "standard", "type": "text", "description": "Sicherheitsstufe: standard, confidential (vertraulich) oder compliance (hoechste Stufe)." }, { "key": "is_revision_secure", "value": false, "type": "text", "description": "Revisionssicherheit aktivieren (WORM-Schutz). Einmal aktiviert, nicht deaktivierbar. Erfordert PaperOffice EU Cloud." }, { "key": "retention_years", "value": 10, "type": "text", "description": "Aufbewahrungsfrist in Jahren (Standard: 10 Jahre, GoBD-konform)." }, { "key": "ai_dms_mode", "value": "disabled", "type": "text", "description": "AI-DMS Verarbeitungsmodus: disabled (aus), basic, premium oder ultra." }, { "key": "storage_mode", "value": "cloud", "type": "text", "description": "Speichermodus: 'cloud' (PaperOffice EU Cloud) oder 'byos' (Bring Your Own Storage). Nach Erstellung nicht aenderbar." }, { "key": "storage_mount_id", "value": "", "type": "text", "description": "ID des Storage Mounts fuer BYOS-Modus." }, { "key": "storage_mount_path", "value": "", "type": "text", "description": "Pfad auf dem Storage Mount fuer BYOS-Modus." }, { "key": "default_locale", "value": "", "type": "text", "description": "Standard-Sprache/Region im Format 'de:DE', 'en:US' etc." }, { "key": "image", "value": "", "type": "text", "description": "Bild-URL des Workspaces." }, { "key": "priority", "value": 500, "type": "text", "description": "Sortierpriorität." }, { "key": "is_default", "value": "", "type": "text", "description": "Als Standard-Workspace markieren." }, { "key": "is_stealth", "value": "", "type": "text", "description": "Workspace im Stealth-Modus (versteckt)." }, { "key": "is_archived", "value": "", "type": "text", "description": "Workspace archivieren." }, { "key": "workspace_password", "value": "", "type": "text", "description": "Passwort fuer den Workspace-Zugang." }, { "key": "color", "value": "", "type": "text", "description": "Farbcode des Workspaces." }, { "key": "icon", "value": "", "type": "text", "description": "Icon des Workspaces." }, { "key": "tags", "value": "", "type": "text", "description": "Tags fuer den Workspace." }, { "key": "contact_salutation", "value": "", "type": "text", "description": "Anrede des Ansprechpartners." }, { "key": "contact_firstname", "value": "", "type": "text", "description": "Vorname des Ansprechpartners." }, { "key": "contact_lastname", "value": "", "type": "text", "description": "Nachname des Ansprechpartners." }, { "key": "contact_email", "value": "", "type": "text", "description": "E-Mail des Ansprechpartners." }, { "key": "contact_phone", "value": "", "type": "text", "description": "Telefon des Ansprechpartners." }, { "key": "company_name", "value": "", "type": "text", "description": "Firmenname." }, { "key": "address_street", "value": "", "type": "text", "description": "Strasse." }, { "key": "address_zip", "value": "", "type": "text", "description": "Postleitzahl." }, { "key": "address_city", "value": "", "type": "text", "description": "Stadt." }, { "key": "address_country", "value": "", "type": "text", "description": "Land." }, { "key": "metadata", "value": "", "type": "text", "description": "Zusaetzliche Metadaten als JSON-Objekt." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create New Workspace Create a workspace to organize documents. Optional metadata: - data_contact: Contact information - data_address: Address information\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "Name des Workspaces (Pflichtfeld, darf nicht leer sein). (required)" }, { "key": "description", "value": "", "type": "text", "description": "Beschreibung des Workspaces." }, { "key": "type", "value": "folder", "type": "text", "description": "Typ des Workspaces." }, { "key": "workspace_tier", "value": "standard", "type": "text", "description": "Sicherheitsstufe: standard, confidential (vertraulich) oder compliance (hoechste Stufe)." }, { "key": "is_revision_secure", "value": false, "type": "text", "description": "Revisionssicherheit aktivieren (WORM-Schutz). Einmal aktiviert, nicht deaktivierbar. Erfordert PaperOffice EU Cloud." }, { "key": "retention_years", "value": 10, "type": "text", "description": "Aufbewahrungsfrist in Jahren (Standard: 10 Jahre, GoBD-konform)." }, { "key": "ai_dms_mode", "value": "disabled", "type": "text", "description": "AI-DMS Verarbeitungsmodus: disabled (aus), basic, premium oder ultra." }, { "key": "storage_mode", "value": "cloud", "type": "text", "description": "Speichermodus: 'cloud' (PaperOffice EU Cloud) oder 'byos' (Bring Your Own Storage). Nach Erstellung nicht aenderbar." }, { "key": "storage_mount_id", "value": "", "type": "text", "description": "ID des Storage Mounts fuer BYOS-Modus." }, { "key": "storage_mount_path", "value": "", "type": "text", "description": "Pfad auf dem Storage Mount fuer BYOS-Modus." }, { "key": "default_locale", "value": "", "type": "text", "description": "Standard-Sprache/Region im Format 'de:DE', 'en:US' etc." }, { "key": "image", "value": "", "type": "text", "description": "Bild-URL des Workspaces." }, { "key": "priority", "value": 500, "type": "text", "description": "Sortierpriorität." }, { "key": "is_default", "value": "", "type": "text", "description": "Als Standard-Workspace markieren." }, { "key": "is_stealth", "value": "", "type": "text", "description": "Workspace im Stealth-Modus (versteckt)." }, { "key": "is_archived", "value": "", "type": "text", "description": "Workspace archivieren." }, { "key": "workspace_password", "value": "", "type": "text", "description": "Passwort fuer den Workspace-Zugang." }, { "key": "color", "value": "", "type": "text", "description": "Farbcode des Workspaces." }, { "key": "icon", "value": "", "type": "text", "description": "Icon des Workspaces." }, { "key": "tags", "value": "", "type": "text", "description": "Tags fuer den Workspace." }, { "key": "contact_salutation", "value": "", "type": "text", "description": "Anrede des Ansprechpartners." }, { "key": "contact_firstname", "value": "", "type": "text", "description": "Vorname des Ansprechpartners." }, { "key": "contact_lastname", "value": "", "type": "text", "description": "Nachname des Ansprechpartners." }, { "key": "contact_email", "value": "", "type": "text", "description": "E-Mail des Ansprechpartners." }, { "key": "contact_phone", "value": "", "type": "text", "description": "Telefon des Ansprechpartners." }, { "key": "company_name", "value": "", "type": "text", "description": "Firmenname." }, { "key": "address_street", "value": "", "type": "text", "description": "Strasse." }, { "key": "address_zip", "value": "", "type": "text", "description": "Postleitzahl." }, { "key": "address_city", "value": "", "type": "text", "description": "Stadt." }, { "key": "address_country", "value": "", "type": "text", "description": "Land." }, { "key": "metadata", "value": "", "type": "text", "description": "Zusaetzliche Metadaten als JSON-Objekt." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"id\": 0,\n \"workspace_tier\": \"standard\",\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Workspace delete", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete Workspace Warning: This will also delete all documents in the workspace!\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des zu loeschenden Workspaces. (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Delete Workspace Warning: This will also delete all documents in the workspace!\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des zu loeschenden Workspaces. (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"documents_queued\": 0,\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Workspace update", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Update Workspace Modify workspace name, description, status, or metadata.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des zu aktualisierenden Workspaces (Pflichtfeld). (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name des Workspaces." }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung." }, { "key": "workspace_tier", "value": "", "type": "text", "description": "Sicherheitsstufe (nur Upgrade erlaubt, kein Downgrade)." }, { "key": "is_revision_secure", "value": "", "type": "text", "description": "Revisionssicherheit aktivieren (einmalig, unwiderruflich)." }, { "key": "retention_years", "value": "", "type": "text", "description": "Aufbewahrungsfrist in Jahren. Bei WORM nur Erhoehung erlaubt." }, { "key": "ai_dms_mode", "value": "", "type": "text", "description": "AI-DMS Modus. Bei Aenderung werden bestehende Dokumente retroaktiv eingeplant." }, { "key": "default_locale", "value": "", "type": "text", "description": "Standard-Sprache/Region." }, { "key": "workspace_password", "value": "", "type": "text", "description": "Neues Workspace-Passwort." }, { "key": "status", "value": "", "type": "text", "description": "Workspace-Status." }, { "key": "type", "value": "", "type": "text", "description": "Workspace-Typ." }, { "key": "image", "value": "", "type": "text", "description": "Bild-URL." }, { "key": "priority", "value": "", "type": "text", "description": "Sortierpriorität." }, { "key": "is_default", "value": "", "type": "text", "description": "Als Standard markieren." }, { "key": "is_stealth", "value": "", "type": "text", "description": "Stealth-Modus." }, { "key": "is_archived", "value": "", "type": "text", "description": "Archiviert." }, { "key": "color", "value": "", "type": "text", "description": "Farbcode." }, { "key": "icon", "value": "", "type": "text", "description": "Icon." }, { "key": "tags", "value": "", "type": "text", "description": "Tags." }, { "key": "contact_salutation", "value": "", "type": "text", "description": "Contact salutation" }, { "key": "contact_firstname", "value": "", "type": "text", "description": "Contact firstname" }, { "key": "contact_lastname", "value": "", "type": "text", "description": "Contact lastname" }, { "key": "contact_email", "value": "", "type": "text", "description": "Contact email" }, { "key": "contact_phone", "value": "", "type": "text", "description": "Contact phone" }, { "key": "company_name", "value": "", "type": "text", "description": "Company name" }, { "key": "address_street", "value": "", "type": "text", "description": "Address street" }, { "key": "address_zip", "value": "", "type": "text", "description": "Address zip" }, { "key": "address_city", "value": "", "type": "text", "description": "Address city" }, { "key": "address_country", "value": "", "type": "text", "description": "Address country" }, { "key": "metadata", "value": "", "type": "text", "description": "Zusaetzliche Metadaten." }, { "key": "password_enabled", "value": "", "type": "text", "description": "Passwortschutz aktivieren/deaktivieren." }, { "key": "sms_enabled", "value": "", "type": "text", "description": "SMS-Verifizierung aktivieren." }, { "key": "sms_phone", "value": "", "type": "text", "description": "Telefonnummer fuer SMS-Verifizierung." }, { "key": "dual_auth_enabled", "value": "", "type": "text", "description": "2-Personen-Freigabe aktivieren." }, { "key": "dual_auth_phone_1", "value": "", "type": "text", "description": "Telefonnummer Person 1." }, { "key": "dual_auth_phone_2", "value": "", "type": "text", "description": "Telefonnummer Person 2." } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Update Workspace Modify workspace name, description, status, or metadata.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": "", "type": "text", "description": "ID des zu aktualisierenden Workspaces (Pflichtfeld). (required)" }, { "key": "name", "value": "", "type": "text", "description": "Neuer Name des Workspaces." }, { "key": "description", "value": "", "type": "text", "description": "Neue Beschreibung." }, { "key": "workspace_tier", "value": "", "type": "text", "description": "Sicherheitsstufe (nur Upgrade erlaubt, kein Downgrade)." }, { "key": "is_revision_secure", "value": "", "type": "text", "description": "Revisionssicherheit aktivieren (einmalig, unwiderruflich)." }, { "key": "retention_years", "value": "", "type": "text", "description": "Aufbewahrungsfrist in Jahren. Bei WORM nur Erhoehung erlaubt." }, { "key": "ai_dms_mode", "value": "", "type": "text", "description": "AI-DMS Modus. Bei Aenderung werden bestehende Dokumente retroaktiv eingeplant." }, { "key": "default_locale", "value": "", "type": "text", "description": "Standard-Sprache/Region." }, { "key": "workspace_password", "value": "", "type": "text", "description": "Neues Workspace-Passwort." }, { "key": "status", "value": "", "type": "text", "description": "Workspace-Status." }, { "key": "type", "value": "", "type": "text", "description": "Workspace-Typ." }, { "key": "image", "value": "", "type": "text", "description": "Bild-URL." }, { "key": "priority", "value": "", "type": "text", "description": "Sortierpriorität." }, { "key": "is_default", "value": "", "type": "text", "description": "Als Standard markieren." }, { "key": "is_stealth", "value": "", "type": "text", "description": "Stealth-Modus." }, { "key": "is_archived", "value": "", "type": "text", "description": "Archiviert." }, { "key": "color", "value": "", "type": "text", "description": "Farbcode." }, { "key": "icon", "value": "", "type": "text", "description": "Icon." }, { "key": "tags", "value": "", "type": "text", "description": "Tags." }, { "key": "contact_salutation", "value": "", "type": "text", "description": "Contact salutation" }, { "key": "contact_firstname", "value": "", "type": "text", "description": "Contact firstname" }, { "key": "contact_lastname", "value": "", "type": "text", "description": "Contact lastname" }, { "key": "contact_email", "value": "", "type": "text", "description": "Contact email" }, { "key": "contact_phone", "value": "", "type": "text", "description": "Contact phone" }, { "key": "company_name", "value": "", "type": "text", "description": "Company name" }, { "key": "address_street", "value": "", "type": "text", "description": "Address street" }, { "key": "address_zip", "value": "", "type": "text", "description": "Address zip" }, { "key": "address_city", "value": "", "type": "text", "description": "Address city" }, { "key": "address_country", "value": "", "type": "text", "description": "Address country" }, { "key": "metadata", "value": "", "type": "text", "description": "Zusaetzliche Metadaten." }, { "key": "password_enabled", "value": "", "type": "text", "description": "Passwortschutz aktivieren/deaktivieren." }, { "key": "sms_enabled", "value": "", "type": "text", "description": "SMS-Verifizierung aktivieren." }, { "key": "sms_phone", "value": "", "type": "text", "description": "Telefonnummer fuer SMS-Verifizierung." }, { "key": "dual_auth_enabled", "value": "", "type": "text", "description": "2-Personen-Freigabe aktivieren." }, { "key": "dual_auth_phone_1", "value": "", "type": "text", "description": "Telefonnummer Person 1." }, { "key": "dual_auth_phone_2", "value": "", "type": "text", "description": "Telefonnummer Person 2." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"workspace_tier\": \"standard\",\n \"ai_dms_backfill\": {\n \"documents_queued\": 0,\n \"documents_tier_updated\": 0,\n \"ai_dms_tier\": \"string\",\n \"source\": \"activation\"\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Workspaces list", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/workspaces-list", "host": [ "{{base_url}}" ], "path": [ "documents", "workspaces-list" ] }, "description": "List All Workspaces Get all workspaces for the authenticated account. Response includes: - id, name, description - type standard/project - status active/inactive - is_default flag\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/documents/workspaces-list", "host": [ "{{base_url}}" ], "path": [ "documents", "workspaces-list" ] }, "description": "List All Workspaces Get all workspaces for the authenticated account. Response includes: - id, name, description - type standard/project - status active/inactive - is_default flag\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"count\": 0,\n \"result\": [\n {}\n ],\n \"status\": \"success\",\n \"jobs\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"job_id\": \"poai-job_xxx\",\n \"templates\": \"string\"\n}" } ] } ] }, { "name": "📁 Handwriting", "item": [ { "name": "Customer form", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Handwritten Document AI-powered handwriting recognition. Fields: extracted_text, confidence, language\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "handwritten_customer_form", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Handwritten Document AI-powered handwriting recognition. Fields: extracted_text, confidence, language\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "handwritten_customer_form", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {},\n \"confidence\": 0\n }\n }\n}" } ] }, { "name": "Government forms", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Form Processing Extract data from filled forms. Fields: all_fields, checkboxes, signatures\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "government_forms", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Form Processing Extract data from filled forms. Fields: all_fields, checkboxes, signatures\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "government_forms", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {},\n \"form_type\": \"string\"\n }\n }\n}" } ] }, { "name": "Handwritten document", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Handwritten Document AI-powered handwriting recognition. Fields: extracted_text, confidence, language\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "handwritten_document", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Handwritten Document AI-powered handwriting recognition. Fields: extracted_text, confidence, language\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "ultra", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "handwritten_document", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {},\n \"confidence\": 0\n }\n }\n}" } ] }, { "name": "Tax forms", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Form Processing Extract data from filled forms. Fields: all_fields, checkboxes, signatures\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "us_tax_forms", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Form Processing Extract data from filled forms. Fields: all_fields, checkboxes, signatures\n\n💰 **Kosten**: 10 Credits/page (0.01€/page)", "body": { "mode": "formdata", "formdata": [ { "key": "file_1", "value": "", "type": "text", "description": "File 1" }, { "key": "model", "value": "premium", "type": "text", "description": "AI processing tier (flat pricing). Basic=OCR+Vision, Premium=+AI Thinking, Ultra=+AI Reasoning. Pro/Pro-Max variants add higher page limits. (required)" }, { "key": "idp_collection", "value": "us_tax_forms", "type": "text", "description": "Idp collection" }, { "key": "idp_fields", "value": "", "type": "text", "description": "OPTIONAL: Extra fields as JSON array" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority. >=900 = synchronous (result inline), <900 = async (poll with po_jobs_get_job_status_result). Default: 900" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"text\": \"string\",\n \"data\": {},\n \"form_number\": \"string\"\n }\n }\n}" } ] } ] }, { "name": "📁 Appointments", "item": [ { "name": "Create appointment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Appointment Create a new appointment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "company", "value": "", "type": "text", "description": "Company name of the person booking (required)" }, { "key": "contact_name", "value": "", "type": "text", "description": "Full name of the contact person (required)" }, { "key": "contact_email", "value": "", "type": "text", "description": "Email address of the contact person (required)" }, { "key": "datetime", "value": "", "type": "text", "description": "Appointment datetime in ISO-8601 format (e.g. 2026-04-10T10:00:00Z). Alternative: use date+time separately" }, { "key": "date", "value": "", "type": "text", "description": "Appointment date (YYYY-MM-DD). Use with time parameter as alternative to datetime" }, { "key": "time", "value": "", "type": "text", "description": "Appointment time (HH:MM). Use with date parameter as alternative to datetime" }, { "key": "meeting_type_id", "value": "", "type": "text", "description": "Meeting type ID (from po_meeting_types_list)" }, { "key": "message", "value": "", "type": "text", "description": "Optional message for the appointment" }, { "key": "phone", "value": "", "type": "text", "description": "Phone number of the contact" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Create Appointment Create a new appointment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "company", "value": "", "type": "text", "description": "Company name of the person booking (required)" }, { "key": "contact_name", "value": "", "type": "text", "description": "Full name of the contact person (required)" }, { "key": "contact_email", "value": "", "type": "text", "description": "Email address of the contact person (required)" }, { "key": "datetime", "value": "", "type": "text", "description": "Appointment datetime in ISO-8601 format (e.g. 2026-04-10T10:00:00Z). Alternative: use date+time separately" }, { "key": "date", "value": "", "type": "text", "description": "Appointment date (YYYY-MM-DD). Use with time parameter as alternative to datetime" }, { "key": "time", "value": "", "type": "text", "description": "Appointment time (HH:MM). Use with date parameter as alternative to datetime" }, { "key": "meeting_type_id", "value": "", "type": "text", "description": "Meeting type ID (from po_meeting_types_list)" }, { "key": "message", "value": "", "type": "text", "description": "Optional message for the appointment" }, { "key": "phone", "value": "", "type": "text", "description": "Phone number of the contact" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"appointment_id\": \"poai-job_xxx\",\n \"confirmed\": true,\n \"start\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "List appointments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Appointments Retrieve all appointments.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "from", "value": "", "type": "text", "description": "Startdatum YYYY-MM-DD. Standard: heute" }, { "key": "to", "value": "", "type": "text", "description": "Enddatum YYYY-MM-DD. Standard: heute + 30 Tage" }, { "key": "source", "value": "", "type": "text", "description": "Filter nach Quelle" }, { "key": "status", "value": "", "type": "text", "description": "Filter nach Status" }, { "key": "search", "value": "", "type": "text", "description": "Volltextsuche in Titel, Beschreibung, Gastname und E-Mail" }, { "key": "limit", "value": 100, "type": "text", "description": "Max. Ergebnisse (1-500)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "List Appointments Retrieve all appointments.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "from", "value": "", "type": "text", "description": "Startdatum YYYY-MM-DD. Standard: heute" }, { "key": "to", "value": "", "type": "text", "description": "Enddatum YYYY-MM-DD. Standard: heute + 30 Tage" }, { "key": "source", "value": "", "type": "text", "description": "Filter nach Quelle" }, { "key": "status", "value": "", "type": "text", "description": "Filter nach Status" }, { "key": "search", "value": "", "type": "text", "description": "Volltextsuche in Titel, Beschreibung, Gastname und E-Mail" }, { "key": "limit", "value": 100, "type": "text", "description": "Max. Ergebnisse (1-500)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"appointments\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Availability", "item": [ { "name": "Get availability", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Availability Retrieve your availability settings.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Availability Retrieve your availability settings.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"available\": true,\n \"schedule\": {},\n \"status\": \"success\"\n}" } ] }, { "name": "Get Available Slots", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Available Slots Calculate available time slots for a meeting type.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "meeting_type", "value": "", "type": "text", "description": "Query parameter: meeting_type" }, { "key": "date", "value": "", "type": "text", "description": "Query parameter: date" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Get Available Slots Calculate available time slots for a meeting type.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "meeting_type", "value": "", "type": "text", "description": "Query parameter: meeting_type" }, { "key": "date", "value": "", "type": "text", "description": "Query parameter: date" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"slots\": {\n \"date\": \"2026-02-07T12:00:00Z\",\n \"slots\": [\n {\n \"time_utc\": \"string\",\n \"time_local\": \"string\",\n \"end_time_utc\": \"string\",\n \"end_time_local\": \"string\",\n \"available\": true\n }\n ]\n },\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Set availability", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Set Availability Configure your availability schedule.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "availability", "value": "", "type": "text", "description": "Array von Tagen mit Zeitslots. Ersetzt die GESAMTE bestehende Verfuegbarkeit. (required)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Set Availability Configure your availability schedule.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "availability", "value": "", "type": "text", "description": "Array von Tagen mit Zeitslots. Ersetzt die GESAMTE bestehende Verfuegbarkeit. (required)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"slots_created\": 0,\n \"processing_time\": \"string\"\n}" } ] } ] }, { "name": "📁 Anonymization", "item": [ { "name": "Anonymize Document (Single-Step)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Vollstaendige DSGVO-konforme Anonymisierung in einem Schritt: PDF Upload → OCR → PII-Erkennung → Schwaerzung → Anonymisiertes PDF. Kombiniert po_anonymization_pii_detect + po_anonymization_redaction_apply ohne Zwischenschritte. Konfigurierbar ueber Kategorien, Whitelist und eigene Anweisungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template", "value": "document_anonymize", "type": "text", "description": "Workflow template" }, { "key": "file", "value": "", "type": "text", "description": "PDF or image file to anonymize (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "Or: existing DMS document POFID" }, { "key": "redact_categories", "value": "all", "type": "text", "description": "Categories: all, none, names, addresses, phone, email, iban, tax_ids, dates, financial, contact, identity" }, { "key": "whitelist", "value": "", "type": "text", "description": "Comma-separated terms to NEVER redact" }, { "key": "custom_redact", "value": "", "type": "text", "description": "Additional terms to ALWAYS redact" }, { "key": "custom_instructions", "value": "", "type": "text", "description": "Free-text AI instructions e.g. Also redact all prices" }, { "key": "priority", "value": "999", "type": "text", "description": ">=900 for synchronous processing" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Vollstaendige DSGVO-konforme Anonymisierung in einem Schritt: PDF Upload → OCR → PII-Erkennung → Schwaerzung → Anonymisiertes PDF. Kombiniert po_anonymization_pii_detect + po_anonymization_redaction_apply ohne Zwischenschritte. Konfigurierbar ueber Kategorien, Whitelist und eigene Anweisungen.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template", "value": "document_anonymize", "type": "text", "description": "Workflow template" }, { "key": "file", "value": "", "type": "text", "description": "PDF or image file to anonymize (required)" }, { "key": "pofid", "value": "", "type": "text", "description": "Or: existing DMS document POFID" }, { "key": "redact_categories", "value": "all", "type": "text", "description": "Categories: all, none, names, addresses, phone, email, iban, tax_ids, dates, financial, contact, identity" }, { "key": "whitelist", "value": "", "type": "text", "description": "Comma-separated terms to NEVER redact" }, { "key": "custom_redact", "value": "", "type": "text", "description": "Additional terms to ALWAYS redact" }, { "key": "custom_instructions", "value": "", "type": "text", "description": "Free-text AI instructions e.g. Also redact all prices" }, { "key": "priority", "value": "999", "type": "text", "description": ">=900 for synchronous processing" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"result\": {\n \"anonymized_file_url\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"pii_found\": 0,\n \"pii_types\": [\n \"string\"\n ]\n }\n}" } ] }, { "name": "Apply redaction", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Step 2: Apply Redaction Applies black boxes to the specified regions and generates the final PDF. Important: Server Affinity! For best results, send this request to the SAME server that processed Step 1. Extract the server from the original_images URL: - https://api-c3.paperoffice.ai:44390/... ??...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "[\"https://api.paperoffice.ai/latest/job/download/YOUR_IMAGE_URL_FROM_STEP1\"]", "type": "text", "description": "JSON array of original_images URLs from Step 1 (required)" }, { "key": "boxes_by_page", "value": "{\"00001\": [0, 1, 2, 5, 7]}", "type": "text", "description": "JSON object: page number 5 digits → array of box indices from redact_box_ids" }, { "key": "redact_color", "value": "#000000", "type": "text", "description": "Redaction color default: black" }, { "key": "output_pdf", "value": "true", "type": "text", "description": "true = output PDF, false = output redacted images" }, { "key": "priority", "value": "999", "type": "text", "description": "Use 999 for immediate processing" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Step 2: Apply Redaction Applies black boxes to the specified regions and generates the final PDF. Important: Server Affinity! For best results, send this request to the SAME server that processed Step 1. Extract the server from the original_images URL: - https://api-c3.paperoffice.ai:44390/... ??...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "[\"https://api.paperoffice.ai/latest/job/download/YOUR_IMAGE_URL_FROM_STEP1\"]", "type": "text", "description": "JSON array of original_images URLs from Step 1 (required)" }, { "key": "boxes_by_page", "value": "{\"00001\": [0, 1, 2, 5, 7]}", "type": "text", "description": "JSON object: page number 5 digits → array of box indices from redact_box_ids" }, { "key": "redact_color", "value": "#000000", "type": "text", "description": "Redaction color default: black" }, { "key": "output_pdf", "value": "true", "type": "text", "description": "true = output PDF, false = output redacted images" }, { "key": "priority", "value": "999", "type": "text", "description": "Use 999 for immediate processing" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {},\n \"output\": {\n \"pii_found\": true,\n \"pii_count\": 0,\n \"redacted_fields\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Full workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Complete Workflow Example This example shows Step 1 Preview. After running this: 1. Copy the original_images URL from the response 2. Copy the redact_box_ids array 3. Use them in Step 2 Apply Redaction Workflow: ┌───────────────────────────?...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template", "value": "document_anonymize_preview", "type": "text", "description": "Template" }, { "key": "file", "value": "", "type": "text", "description": "Upload your PDF here (required)" }, { "key": "redact_categories", "value": "contact", "type": "text", "description": "Only redact contact information" }, { "key": "whitelist", "value": "PaperOffice,ACME Corp", "type": "text", "description": "Keep these company names visible" }, { "key": "priority", "value": "900", "type": "text", "description": "Priority" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Complete Workflow Example This example shows Step 1 Preview. After running this: 1. Copy the original_images URL from the response 2. Copy the redact_box_ids array 3. Use them in Step 2 Apply Redaction Workflow: ┌───────────────────────────?...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "template", "value": "document_anonymize_preview", "type": "text", "description": "Template" }, { "key": "file", "value": "", "type": "text", "description": "Upload your PDF here (required)" }, { "key": "redact_categories", "value": "contact", "type": "text", "description": "Only redact contact information" }, { "key": "whitelist", "value": "PaperOffice,ACME Corp", "type": "text", "description": "Keep these company names visible" }, { "key": "priority", "value": "900", "type": "text", "description": "Priority" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Pii preview", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "{document_id}" ] }, "description": "Step 1: Detect PII Preview Analyzes document and returns detected PII with bounding boxes. Response Structure: json { \"status\": \"success\", \"job_result\": { \"workflow_output\": { \"original_images\": \"https://api.paperoffice.ai/latest/job/download/ABC123\" , \"simplified_boxes\": { \"text\": \"Max Mustermann\",...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/document_intelligence/entities/{document_id}", "host": [ "{{base_url}}" ], "path": [ "document_intelligence", "entities", "{document_id}" ] }, "description": "Step 1: Detect PII Preview Analyzes document and returns detected PII with bounding boxes. Response Structure: json { \"status\": \"success\", \"job_result\": { \"workflow_output\": { \"original_images\": \"https://api.paperoffice.ai/latest/job/download/ABC123\" , \"simplified_boxes\": { \"text\": \"Max Mustermann\",...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"pii_found\": true,\n \"pii_count\": 0,\n \"pii_details\": [\n {\n \"type\": \"Beispiel\",\n \"value\": \"string\",\n \"page\": 0,\n \"position\": {},\n \"confidence\": 0\n }\n ]\n }\n }\n}" } ] } ] }, { "name": "📁 Documentation", "item": [ { "name": "Ai integration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "🤖 MCP Server - AI Tool Integration Model Context Protocol MCP enables AI assistants to directly use PaperOffice tools. --- 🔗 Server URL https://api.paperoffice.ai/latest/mcp --- ⚡ Quick Setup Cursor IDE Remote MCP 1. Open Cursor Settings → MCP 2. Add new Remote MCP Server 3. Enter URL: htt...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "🤖 MCP Server - AI Tool Integration Model Context Protocol MCP enables AI assistants to directly use PaperOffice tools. --- 🔗 Server URL https://api.paperoffice.ai/latest/mcp --- ⚡ Quick Setup Cursor IDE Remote MCP 1. Open Cursor Settings → MCP 2. Add new Remote MCP Server 3. Enter URL: htt...\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Beispiel\",\n \"version\": \"string\",\n \"protocol\": \"string\",\n \"description\": \"string\",\n \"methods\": {\n \"initialize\": \"string\",\n \"tools\\/list\": \"string\",\n \"tools\\/search\": \"string\",\n \"tools\\/schema\": \"string\",\n \"tools\\/check\": \"string\",\n \"tools\\/intents\": \"string\",\n \"tools\\/call\": \"string\"\n },\n \"endpoints\": {},\n \"tools_count\": 0,\n \"search\": {},\n \"check\": {},\n \"documentation\": \"https:\\/\\/api.paperoffice.ai\\/dev\\/...\",\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Postman collection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Complete Postman Collection with all endpoints. Direct URL: https://api.paperoffice.ai/latest/docs/postman Import to Postman: 1. Copy URL above 2. File → Import → Link 3. Paste and Import\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Complete Postman Collection with all endpoints. Direct URL: https://api.paperoffice.ai/latest/docs/postman Import to Postman: 1. Copy URL above 2. File → Import → Link 3. Paste and Import\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"info\": {\n \"name\": \"Beispiel\",\n \"description\": \"string\",\n \"schema\": \"string\"\n },\n \"item\": [\n {}\n ],\n \"variable\": [\n {}\n ],\n \"processing_time\": \"string\",\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Opportunities", "item": [ { "name": "Upsell opportunities", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Upselling-Potenziale identifizieren. Accounts mit hohem Upselling-Potenzial, sortiert nach Score.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "min_potential", "value": "", "type": "text", "description": "Minimum upsell potential (default: 0.3)" }, { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 20, max: 100)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Upselling-Potenziale identifizieren. Accounts mit hohem Upselling-Potenzial, sortiert nach Score.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "min_potential", "value": "", "type": "text", "description": "Minimum upsell potential (default: 0.3)" }, { "key": "limit", "value": "", "type": "text", "description": "Max results (default: 20, max: 100)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"opportunities\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Public booking", "item": [ { "name": "Book appointment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Book Appointment Book a public appointment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "booking_uuid", "value": "", "type": "text", "description": "UUID des Booking-Requests (required)" }, { "key": "session_type", "value": "", "type": "text", "description": "Session-Typ-Slug (z.B. consultation)" }, { "key": "email", "value": "", "type": "text", "description": "E-Mail des Kunden fuer Checkout (required)" }, { "key": "locale", "value": "de", "type": "text", "description": "Sprache fuer Checkout-Seite" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Book Appointment Book a public appointment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "booking_uuid", "value": "", "type": "text", "description": "UUID des Booking-Requests (required)" }, { "key": "session_type", "value": "", "type": "text", "description": "Session-Typ-Slug (z.B. consultation)" }, { "key": "email", "value": "", "type": "text", "description": "E-Mail des Kunden fuer Checkout (required)" }, { "key": "locale", "value": "de", "type": "text", "description": "Sprache fuer Checkout-Seite" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"booking_id\": \"poai-job_xxx\",\n \"confirmed\": true,\n \"start\": \"string\",\n \"status\": \"success\"\n}" } ] }, { "name": "Cancel appointment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Cancel Appointment Cancel a booked appointment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Event-ID des zu stornierenden Termins (required)" }, { "key": "uuid", "value": "", "type": "text", "description": "UUID des Events (Alternative)" }, { "key": "cancellation_reason", "value": "", "type": "text", "description": "Stornierungsgrund" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Cancel Appointment Cancel a booked appointment.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "event_id", "value": "", "type": "text", "description": "Event-ID des zu stornierenden Termins (required)" }, { "key": "uuid", "value": "", "type": "text", "description": "UUID des Events (Alternative)" }, { "key": "cancellation_reason", "value": "", "type": "text", "description": "Stornierungsgrund" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"cancelled\": true,\n \"booking_id\": \"poai-job_xxx\",\n \"status\": \"success\"\n}" } ] }, { "name": "Public Available Slots", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Public Available Slots Get available slots for public booking.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Query parameter: account_id" }, { "key": "meeting_type", "value": "", "type": "text", "description": "Query parameter: meeting_type" }, { "key": "date", "value": "", "type": "text", "description": "Query parameter: date" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Public Available Slots Get available slots for public booking.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Query parameter: account_id" }, { "key": "meeting_type", "value": "", "type": "text", "description": "Query parameter: meeting_type" }, { "key": "date", "value": "", "type": "text", "description": "Query parameter: date" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"string\",\n \"meeting_type_slug\": \"string\",\n \"duration_minutes\": 0,\n \"days\": [\n {\n \"date\": \"2026-02-07T12:00:00Z\",\n \"slots\": [\n {\n \"time_utc\": \"string\",\n \"time_local\": \"string\",\n \"end_time_utc\": \"string\",\n \"end_time_local\": \"string\",\n \"available\": true\n }\n ]\n }\n ],\n \"processing_time\": \"string\"\n}" } ] }, { "name": "Public Meeting Types", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Public Meeting Types Get publicly available meeting types for booking.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Query parameter: account_id" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Public Meeting Types Get publicly available meeting types for booking.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "account_id", "value": "", "type": "text", "description": "Query parameter: account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"processing_time\": \"string\",\n \"meeting_types\": [\n {}\n ],\n \"total\": 0,\n \"status\": \"success\"\n}" } ] } ] }, { "name": "📁 Business intelligence", "item": [ { "name": "Generate report", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/bi/bi-document-stats", "host": [ "{{base_url}}" ], "path": [ "bi", "bi-document-stats" ] }, "description": "Generate Report Generate a new business report.\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/bi/bi-document-stats", "host": [ "{{base_url}}" ], "path": [ "bi", "bi-document-stats" ] }, "description": "Generate Report Generate a new business report.\n\n💰 **Kosten**: 100 Credits/request (0.1€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"report_id\": \"string\",\n \"data\": {},\n \"generated_at\": \"string\"\n }\n }\n}" } ] }, { "name": "Get dashboard", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/bi/bi-dashboard", "host": [ "{{base_url}}" ], "path": [ "bi", "bi-dashboard" ] }, "description": "Get BI Dashboard Retrieve business intelligence dashboard data.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/bi/bi-dashboard", "host": [ "{{base_url}}" ], "path": [ "bi", "bi-dashboard" ] }, "description": "Get BI Dashboard Retrieve business intelligence dashboard data.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"widgets\": [\n {}\n ],\n \"metrics\": {}\n }\n }\n}" } ] }, { "name": "Get reports", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/bi/bi-trends", "host": [ "{{base_url}}" ], "path": [ "bi", "bi-trends" ] }, "description": "Get BI Reports List available business reports.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/bi/bi-trends", "host": [ "{{base_url}}" ], "path": [ "bi", "bi-trends" ] }, "description": "Get BI Reports List available business reports.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"reports\": [\n {}\n ],\n \"total\": 0\n }\n }\n}" } ] } ] }, { "name": "📦 General", "item": [ { "name": "Code scan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Dokumente auf leere Seiten und Code-Fragmente scannen - Automatische Erkennung und Filterung\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF oder Bilddateien zum Scannen (required)" }, { "key": "whitepage_threshold", "value": 0.95, "type": "text", "description": "Schwellwert für leere Seiten (0.1-1.0)" }, { "key": "detect_code", "value": true, "type": "text", "description": "Code-Fragmente erkennen" }, { "key": "remove_whitepages", "value": false, "type": "text", "description": "Leere Seiten automatisch entfernen" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Dokumente auf leere Seiten und Code-Fragmente scannen - Automatische Erkennung und Filterung\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF oder Bilddateien zum Scannen (required)" }, { "key": "whitepage_threshold", "value": 0.95, "type": "text", "description": "Schwellwert für leere Seiten (0.1-1.0)" }, { "key": "detect_code", "value": true, "type": "text", "description": "Code-Fragmente erkennen" }, { "key": "remove_whitepages", "value": false, "type": "text", "description": "Leere Seiten automatisch entfernen" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"codes\": [\n {}\n ],\n \"is_whitepage\": true\n }\n }\n}" } ] }, { "name": "Compress pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Compress PDF to reduce file size\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "quality", "value": "medium", "type": "text", "description": "Compression quality: low (72dpi, smallest), medium (150dpi, balanced), high (300dpi, best quality), lossless (no quality loss)" }, { "key": "linearize", "value": true, "type": "text", "description": "Linearize PDF for fast web view (default: true)" }, { "key": "remove_metadata", "value": "", "type": "text", "description": "Remove metadata during compression (default: false)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Compress PDF to reduce file size\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "quality", "value": "medium", "type": "text", "description": "Compression quality: low (72dpi, smallest), medium (150dpi, balanced), high (300dpi, best quality), lossless (no quality loss)" }, { "key": "linearize", "value": true, "type": "text", "description": "Linearize PDF for fast web view (default: true)" }, { "key": "remove_metadata", "value": "", "type": "text", "description": "Remove metadata during compression (default: false)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Dataripper ebook2pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "E-Books zu PDF konvertieren - Unterstützt EPUB, MOBI, AZW3, FB2 Formate\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "E-Book Dateien (EPUB, MOBI, AZW3, FB2) (required)" }, { "key": "output_format", "value": "pdf", "type": "text", "description": "Ausgabeformat" }, { "key": "page_size", "value": "A4", "type": "text", "description": "Seitengröße" }, { "key": "margin", "value": 20, "type": "text", "description": "Seitenrand in mm" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "E-Books zu PDF konvertieren - Unterstützt EPUB, MOBI, AZW3, FB2 Formate\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "E-Book Dateien (EPUB, MOBI, AZW3, FB2) (required)" }, { "key": "output_format", "value": "pdf", "type": "text", "description": "Ausgabeformat" }, { "key": "page_size", "value": "A4", "type": "text", "description": "Seitengröße" }, { "key": "margin", "value": 20, "type": "text", "description": "Seitenrand in mm" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Dataripper image2pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bilder zu PDF-Dokumenten konvertieren - Unterstützt JPG, PNG, TIF, TIFF\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Bilddateien (JPG, PNG, TIF, TIFF) (required)" }, { "key": "fit_to_a4", "value": false, "type": "text", "description": "Bilder auf A4-Format skalieren mit weißem Hintergrund" }, { "key": "merge", "value": true, "type": "text", "description": "Alle Bilder in EIN PDF zusammenfügen (default: true)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bilder zu PDF-Dokumenten konvertieren - Unterstützt JPG, PNG, TIF, TIFF\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Bilddateien (JPG, PNG, TIF, TIFF) (required)" }, { "key": "fit_to_a4", "value": false, "type": "text", "description": "Bilder auf A4-Format skalieren mit weißem Hintergrund" }, { "key": "merge", "value": true, "type": "text", "description": "Alle Bilder in EIN PDF zusammenfügen (default: true)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Dataripper office2pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Office-Dokumente zu PDF konvertieren — Unterstuetzt DOCX, DOC, XLSX, XLS, PPTX, PPT, ODS, ODT, ODP, RTF. Nutzt Windows-VM-Cluster mit echtem Microsoft Office fuer maximale Konvertierungstreue.\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Office-Dateien (DOCX, DOC, XLSX, XLS, PPTX, PPT, PPS, ODS, ODT, ODP, RTF) (required)" }, { "key": "provider", "value": "native", "type": "text", "description": "Konvertierungs-Engine: native (Windows VM + MS Office, beste Qualitaet), adobe (Cloud), libreoffice (lokal, geringere Treue)" } ] } } }, { "name": "Email parser", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "E-Mail-Nachrichten parsen und Inhalte extrahieren - Unterstützt EML, MSG, PST Formate\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "E-Mail Dateien (EML, MSG, PST) (required)" }, { "key": "extract_attachments", "value": true, "type": "text", "description": "Anhänge extrahieren" }, { "key": "parse_headers", "value": true, "type": "text", "description": "E-Mail-Header parsen" }, { "key": "decode_html", "value": true, "type": "text", "description": "HTML-Inhalt dekodieren" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "E-Mail-Nachrichten parsen und Inhalte extrahieren - Unterstützt EML, MSG, PST Formate\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "E-Mail Dateien (EML, MSG, PST) (required)" }, { "key": "extract_attachments", "value": true, "type": "text", "description": "Anhänge extrahieren" }, { "key": "parse_headers", "value": true, "type": "text", "description": "E-Mail-Header parsen" }, { "key": "decode_html", "value": true, "type": "text", "description": "HTML-Inhalt dekodieren" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output\": {\n \"from\": \"string\",\n \"to\": \"string\",\n \"subject\": \"string\",\n \"date\": \"string\",\n \"body_text\": \"string\",\n \"body_html\": \"string\",\n \"attachments\": [\n \"string\"\n ]\n }\n }\n}" } ] }, { "name": "Merge pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Merge multiple PDFs into one\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files to merge (required)" }, { "key": "order", "value": "", "type": "text", "description": "Merge order" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" }, { "key": "output_filename", "value": "merged.pdf", "type": "text", "description": "Name of the merged output file" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Merge multiple PDFs into one\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files to merge (required)" }, { "key": "order", "value": "", "type": "text", "description": "Merge order" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" }, { "key": "output_filename", "value": "merged.pdf", "type": "text", "description": "Name of the merged output file" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Metadata pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Edit PDF metadata (title, author, etc.)\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "operation", "value": "edit", "type": "text", "description": "Operation: edit (modify metadata fields), remove (clear all metadata), read (return current metadata)" }, { "key": "metadata", "value": "", "type": "text", "description": "Metadata object with fields to set" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Edit PDF metadata (title, author, etc.)\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "operation", "value": "edit", "type": "text", "description": "Operation: edit (modify metadata fields), remove (clear all metadata), read (return current metadata)" }, { "key": "metadata", "value": "", "type": "text", "description": "Metadata object with fields to set" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Redact image", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bilder schwärzen/anonymisieren - Zeichnet schwarze Rechtecke über sensible Bereiche\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Bilddateien zum Schwärzen (PNG, JPG) (required)" }, { "key": "bounding_boxes", "value": "", "type": "text", "description": "OCR-Bounding-Boxes pro Seite (required)" }, { "key": "redact_boxes", "value": "", "type": "text", "description": "Liste der zu schwärzenden Box-IDs (required)" }, { "key": "override_boxes", "value": [], "type": "text", "description": "Manuelle Override-Box-IDs vom Frontend" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Bilder schwärzen/anonymisieren - Zeichnet schwarze Rechtecke über sensible Bereiche\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "Bilddateien zum Schwärzen (PNG, JPG) (required)" }, { "key": "bounding_boxes", "value": "", "type": "text", "description": "OCR-Bounding-Boxes pro Seite (required)" }, { "key": "redact_boxes", "value": "", "type": "text", "description": "Liste der zu schwärzenden Box-IDs (required)" }, { "key": "override_boxes", "value": [], "type": "text", "description": "Manuelle Override-Box-IDs vom Frontend" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Rotate pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Rotiert einzelne oder alle Seiten eines PDF-Dokuments um 90, 180 oder 270 Grad.\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "angle", "value": "90", "type": "text", "description": "Rotation angle in degrees (clockwise): 90, 180, or 270" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" }, { "key": "page_range", "value": "all", "type": "text", "description": "Pages to rotate: \"all\" (default) or specific pages like \"1-5,7,9-10\"" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Rotiert einzelne oder alle Seiten eines PDF-Dokuments um 90, 180 oder 270 Grad.\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "angle", "value": "90", "type": "text", "description": "Rotation angle in degrees (clockwise): 90, 180, or 270" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" }, { "key": "page_range", "value": "all", "type": "text", "description": "Pages to rotate: \"all\" (default) or specific pages like \"1-5,7,9-10\"" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Split pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Split PDF into individual pages\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF file to split (required)" }, { "key": "mode", "value": "burst", "type": "text", "description": "Split mode: burst = every page becomes a separate PDF (default), ranges = custom page ranges via splits parameter" }, { "key": "splits", "value": "", "type": "text", "description": "For ranges mode: Array of split definitions. Each item has pages (e.g. 1-5,7) and optional filename." }, { "key": "output_prefix", "value": "", "type": "text", "description": "Prefix for burst mode output filenames (default: page_)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Split PDF into individual pages\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF file to split (required)" }, { "key": "mode", "value": "burst", "type": "text", "description": "Split mode: burst = every page becomes a separate PDF (default), ranges = custom page ranges via splits parameter" }, { "key": "splits", "value": "", "type": "text", "description": "For ranges mode: Array of split definitions. Each item has pages (e.g. 1-5,7) and optional filename." }, { "key": "output_prefix", "value": "", "type": "text", "description": "Prefix for burst mode output filenames (default: page_)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To excel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to Excel spreadsheet (XLSX)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to Excel spreadsheet (XLSX)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To jpg", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF pages to JPG images\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "quality", "value": 70, "type": "text", "description": "Quality (Ganzzahl)" }, { "key": "max_size", "value": 1200, "type": "text", "description": "Max size (Ganzzahl)" }, { "key": "dpi", "value": 150, "type": "text", "description": "Resolution in DPI (default: 150)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF pages to JPG images\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "quality", "value": 70, "type": "text", "description": "Quality (Ganzzahl)" }, { "key": "max_size", "value": 1200, "type": "text", "description": "Max size (Ganzzahl)" }, { "key": "dpi", "value": 150, "type": "text", "description": "Resolution in DPI (default: 150)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To pdf", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert webpage URL to PDF with full Puppeteer support (cookies, headers, inject CSS/JS)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "", "type": "text", "description": "URL to convert (http:// or https://) (required)" }, { "key": "screen_width", "value": 1920, "type": "text", "description": "Browser viewport width in pixels" }, { "key": "screen_height", "value": 1080, "type": "text", "description": "Browser viewport height in pixels" }, { "key": "page_size", "value": "A4", "type": "text", "description": "PDF page size" }, { "key": "page_orientation", "value": "portrait", "type": "text", "description": "Page orientation" }, { "key": "page_margins", "value": 20, "type": "text", "description": "Page margins in pixels" }, { "key": "scale", "value": "1", "type": "text", "description": "Scale factor 0.1-2.0" }, { "key": "print_background", "value": "true", "type": "text", "description": "Print background colors/images (true/false)" }, { "key": "page_ranges", "value": "", "type": "text", "description": "Pages to print, e.g. 1-5,8" }, { "key": "header_template", "value": "", "type": "text", "description": "HTML header template" }, { "key": "footer_template", "value": "", "type": "text", "description": "HTML footer template" }, { "key": "remove_classes", "value": "", "type": "text", "description": "CSS selectors to remove" }, { "key": "inject_css", "value": "", "type": "text", "description": "Custom CSS to inject" }, { "key": "inject_js", "value": "", "type": "text", "description": "JavaScript to execute" }, { "key": "cookies", "value": "", "type": "text", "description": "JSON array of cookies" }, { "key": "extra_headers", "value": "", "type": "text", "description": "JSON object of HTTP headers" }, { "key": "user_agent", "value": "", "type": "text", "description": "Custom User-Agent" }, { "key": "wait_until", "value": "networkidle0", "type": "text", "description": "Navigation completion event" }, { "key": "timeout", "value": 60000, "type": "text", "description": "Navigation timeout in ms" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert webpage URL to PDF with full Puppeteer support (cookies, headers, inject CSS/JS)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "url", "value": "", "type": "text", "description": "URL to convert (http:// or https://) (required)" }, { "key": "screen_width", "value": 1920, "type": "text", "description": "Browser viewport width in pixels" }, { "key": "screen_height", "value": 1080, "type": "text", "description": "Browser viewport height in pixels" }, { "key": "page_size", "value": "A4", "type": "text", "description": "PDF page size" }, { "key": "page_orientation", "value": "portrait", "type": "text", "description": "Page orientation" }, { "key": "page_margins", "value": 20, "type": "text", "description": "Page margins in pixels" }, { "key": "scale", "value": "1", "type": "text", "description": "Scale factor 0.1-2.0" }, { "key": "print_background", "value": "true", "type": "text", "description": "Print background colors/images (true/false)" }, { "key": "page_ranges", "value": "", "type": "text", "description": "Pages to print, e.g. 1-5,8" }, { "key": "header_template", "value": "", "type": "text", "description": "HTML header template" }, { "key": "footer_template", "value": "", "type": "text", "description": "HTML footer template" }, { "key": "remove_classes", "value": "", "type": "text", "description": "CSS selectors to remove" }, { "key": "inject_css", "value": "", "type": "text", "description": "Custom CSS to inject" }, { "key": "inject_js", "value": "", "type": "text", "description": "JavaScript to execute" }, { "key": "cookies", "value": "", "type": "text", "description": "JSON array of cookies" }, { "key": "extra_headers", "value": "", "type": "text", "description": "JSON object of HTTP headers" }, { "key": "user_agent", "value": "", "type": "text", "description": "Custom User-Agent" }, { "key": "wait_until", "value": "networkidle0", "type": "text", "description": "Navigation completion event" }, { "key": "timeout", "value": 60000, "type": "text", "description": "Navigation timeout in ms" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To pdfa", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to PDF/A for archiving\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "level", "value": "pdfa-2b", "type": "text", "description": "Level" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to PDF/A for archiving\n\n💰 **Kosten**: 20 Credits/file (0.02€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "level", "value": "pdfa-2b", "type": "text", "description": "Level" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To powerpoint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to PowerPoint presentation (PPTX)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to PowerPoint presentation (PPTX)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To webp", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF pages to WebP images\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "quality", "value": 70, "type": "text", "description": "Quality (Ganzzahl)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF pages to WebP images\n\n💰 **Kosten**: 10 Credits/request (0.01€/request)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "quality", "value": 70, "type": "text", "description": "Quality (Ganzzahl)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "To word", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to Word document (DOCX)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Convert PDF to Word document (DOCX)\n\n💰 **Kosten**: 30 Credits/file (0.03€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] }, { "name": "Unlock PDF Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Remove password from PDF (password required)\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "password", "value": "", "type": "text", "description": "Current password (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "response": [ { "name": "Erfolgreiche Response (Schema)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{bearer_token}}" } ], "url": { "raw": "{{base_url}}/job", "host": [ "{{base_url}}" ], "path": [ "job" ] }, "description": "Remove password from PDF (password required)\n\n💰 **Kosten**: 10 Credits/file (0.01€/file)", "body": { "mode": "formdata", "formdata": [ { "key": "files", "value": "", "type": "text", "description": "PDF files (required)" }, { "key": "password", "value": "", "type": "text", "description": "Current password (required)" }, { "key": "priority", "value": "", "type": "text", "description": "Processing priority (>=900 = synchronous)" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"job_id\": \"poai-job_xxx\",\n \"message\": \"string\",\n \"pipeline\": \"Beispiel\",\n \"operation\": \"string\",\n \"processing_time\": \"string\",\n \"server\": \"string\",\n \"timing\": {\n \"actual_ms\": 0,\n \"expected_ms\": 0,\n \"timeout_ms\": 0,\n \"speed_factor\": 0,\n \"performance\": \"string\"\n },\n \"result\": {\n \"status\": \"completed\",\n \"message\": \"string\",\n \"duration_ms\": \"string\",\n \"output_files\": {}\n }\n}" } ] } ] } ] }