{ "info": { "name": "Auto Appy AI API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "api_key", "value": "" }, { "key": "organisation_id", "value": "" } ], "item": [ { "name": "GET /api/auth/me", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/auth/me", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "auth", "me" ], "query": [ { "key": "data", "value": "", "description": "Data. Optional. ", "disabled": true } ] }, "description": "Me for auto appy auth. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/usage", "description": "Personal for ai usage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/source-library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/source-library", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "source-library" ], "query": [ { "key": "type", "value": "", "description": "Type. Optional. ", "disabled": true }, { "key": "search", "value": "", "description": "Search. Optional. Limits: max:160.", "disabled": true }, { "key": "page", "value": "", "description": "Page. Optional. Limits: min:1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page. Optional. ", "disabled": true } ] }, "description": "Sources for ai library. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/bots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/bots", "description": "Index for bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/bots/{bot}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/bots/{{bot}}", "description": "Show for bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/ai-jobs/types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/ai-jobs/types", "description": "Job types for ai job. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/ai-jobs/health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/ai-jobs/health", "description": "Health for ai job. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/ai-jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/ai-jobs", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "ai-jobs" ], "query": [ { "key": "job_type", "value": "", "description": "Job type.", "disabled": true }, { "key": "status", "value": "", "description": "Status.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page.", "disabled": true } ] }, "description": "Index for ai job. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. \n\nLookup `job_id`: read `data[].id` as the value and `data[].job_type` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /api/ai-jobs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/ai-jobs", "description": "Queue one of the supported AI utilities. Returns 201 with data.id and pending status. Poll GET /api/ai-jobs/{aiJob}; do not resubmit the job to poll. See the lookup cookbook for all five complete input examples.", "body": { "mode": "raw", "raw": "{\n \"job_type\": \"call_transcript_url\",\n \"input\": {\n \"call_url\": \"https://example.com/audio.mp3\",\n \"output_mode\": \"original\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/ai-jobs/{aiJob}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/ai-jobs/{{aiJob}}", "description": "Show for ai job. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "DELETE /api/ai-jobs/{aiJob}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/ai-jobs/{{aiJob}}", "description": "Destroy for ai job. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/ai-jobs/{aiJob}/cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/ai-jobs/{{aiJob}}/cancel", "description": "Cancel for ai job. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /api/faq-bots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/faq-bots", "description": "Index for faq bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /api/faq-bots", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/faq-bots", "description": "Store for faq bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/faq-bots/{faqBot}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/faq-bots/{{faqBot}}", "description": "Show for faq bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /api/faq-bots/{faqBot}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/faq-bots/{{faqBot}}", "description": "Update for faq bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /api/faq-bots/{faqBot}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/faq-bots/{{faqBot}}", "description": "Destroy for faq bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/faq-bots/{faqBot}/ask", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/faq-bots/{{faqBot}}/ask", "description": "Ask for faq bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/knowledge-bots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/knowledge-bots", "description": "Index for knowledge bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /api/knowledge-bots", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/knowledge-bots", "description": "Store for knowledge bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /api/knowledge-bots/{knowledgeBot}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/knowledge-bots/{{knowledgeBot}}", "description": "Show for knowledge bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "DELETE /api/knowledge-bots/{knowledgeBot}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/knowledge-bots/{{knowledgeBot}}", "description": "Destroy for knowledge bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/knowledge-bots/{knowledgeBot}/document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/knowledge-bots/{{knowledgeBot}}/document", "description": "Replace document for knowledge bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/knowledge-bots/{knowledgeBot}/ask", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/knowledge-bots/{{knowledgeBot}}/ask", "description": "Ask for knowledge bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/product-bots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots", "description": "Index for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /api/product-bots", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots", "description": "Store for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /api/product-bots/{productBot}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots/{{productBot}}", "description": "Show for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /api/product-bots/{productBot}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots/{{productBot}}", "description": "Update for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "DELETE /api/product-bots/{productBot}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots/{{productBot}}", "description": "Destroy for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/product-bots/{productBot}/catalog", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots/{{productBot}}/catalog", "description": "Replace catalog for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/product-bots/{productBot}/reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots/{{productBot}}/reset", "description": "Reset conversation for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/product-bots/{productBot}/ask", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/product-bots/{{productBot}}/ask", "description": "Ask for product bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/intake-bots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots", "description": "Index for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /api/intake-bots", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots", "description": "Store for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /api/intake-bots/{intakeBot}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots/{{intakeBot}}", "description": "Show for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /api/intake-bots/{intakeBot}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots/{{intakeBot}}", "description": "Update for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "DELETE /api/intake-bots/{intakeBot}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots/{{intakeBot}}", "description": "Destroy for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/intake-bots/{intakeBot}/document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots/{{intakeBot}}/document", "description": "Replace document for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/intake-bots/{intakeBot}/reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots/{{intakeBot}}/reset", "description": "Reset conversation for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/intake-bots/{intakeBot}/ask", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/intake-bots/{{intakeBot}}/ask", "description": "Ask for intake bot. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/bot-examples", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bot-examples", "description": "Index for bot example. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /api/orchestration/bot-examples", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bot-examples", "description": "Store for bot example. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/usage", "description": "Organisation for ai usage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/library", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "library" ], "query": [ { "key": "collection", "value": "", "description": "Collection. Optional. ", "disabled": true }, { "key": "type", "value": "", "description": "Type. Optional. Limits: max:40.", "disabled": true }, { "key": "search", "value": "", "description": "Search. Optional. Limits: max:160.", "disabled": true }, { "key": "page", "value": "", "description": "Page. Optional. Limits: min:1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page. Optional. Limits: min:1, max:100.", "disabled": true } ] }, "description": "Index for ai library. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/history", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "history" ], "query": [ { "key": "search", "value": "", "description": "Search. Optional. Limits: max:160.", "disabled": true }, { "key": "source", "value": "", "description": "Source. Optional. ", "disabled": true }, { "key": "from", "value": "", "description": "From. Optional. ", "disabled": true }, { "key": "to", "value": "", "description": "To. Optional. ", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor. Optional. Limits: max:1000.", "disabled": true } ] }, "description": "Index for flow history. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/history/{conversation}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/history/{{conversation}}", "description": "All show for flow history. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/history/{conversation}/turns/{turn}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/history/{{conversation}}/turns/{{turn}}", "description": "All path for flow history. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/sales-sources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/sales-sources", "description": "Sales sources for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/bots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/bots", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "bots" ], "query": [ { "key": "cursor", "value": "", "description": "", "disabled": true }, { "key": "channel_id", "value": "", "description": "", "disabled": true } ] }, "description": "\n\nLookup `bot_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /api/orchestration/bots", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bots", "description": "Save bot for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/bots/{bot}/history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}/history", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "bots", "{{bot}}", "history" ], "query": [ { "key": "search", "value": "", "description": "Search. Optional. Limits: max:160.", "disabled": true }, { "key": "source", "value": "", "description": "Source. Optional. ", "disabled": true }, { "key": "from", "value": "", "description": "From. Optional. ", "disabled": true }, { "key": "to", "value": "", "description": "To. Optional. ", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor. Optional. Limits: max:1000.", "disabled": true } ] }, "description": "Index for flow history. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/bots/{bot}/history/{conversation}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}/history/{{conversation}}", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "bots", "{{bot}}", "history", "{{conversation}}" ], "query": [ { "key": "before_sequence", "value": "", "description": "Before sequence. Optional. Limits: min:1.", "disabled": true } ] }, "description": "Show for flow history. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/bots/{bot}/history/{conversation}/turns/{turn}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}/history/{{conversation}}/turns/{{turn}}", "description": "Path for flow history. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/orchestration/bots/{bot}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}", "description": "" } }, { "name": "PUT /api/orchestration/bots/{bot}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}", "description": "Save bot for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/bots/{bot}/preview", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}/preview", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "bots", "{{bot}}", "preview" ], "query": [ { "key": "person_id", "value": "", "description": "Person id. Required. ", "disabled": false }, { "key": "event_id", "value": "", "description": "Event id. Required. ", "disabled": false }, { "key": "message", "value": "", "description": "Message. Required. Limits: max:4000.", "disabled": false }, { "key": "choice_id", "value": "", "description": "Choice id. Optional. Limits: max:200.", "disabled": true } ] }, "description": "Preview memory bot for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /api/orchestration/bots/{bot}/preview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/bots/{{bot}}/preview", "description": "Preview memory bot for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/channels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/channels", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "channels" ], "query": [ { "key": "cursor", "value": "", "description": "", "disabled": true } ] }, "description": "\n\nLookup `channel_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /api/orchestration/channels", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels", "description": "Save channel for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/channels/{channel}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels/{{channel}}", "description": "" } }, { "name": "PUT /api/orchestration/channels/{channel}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels/{{channel}}", "description": "Save channel for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/contact-fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/contact-fields", "description": "Contact fields for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /api/orchestration/contact-fields", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/contact-fields", "description": "Contact fields for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/orchestration/channels/{channel}/people/{subject}/seed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels/{{channel}}/people/{{subject}}/seed", "description": "Seed person memory for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /api/orchestration/channels/{channel}/events", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels/{{channel}}/events", "description": "202 queued/processing; 200 for other states/duplicate. Deduplicated per conversation/event ID and payload. This does not prove answer completion or delivery.", "body": { "mode": "raw", "raw": "{\n \"contract_version\": \"1.0\",\n \"conversation_id\": \"example-session\",\n \"event_id\": \"example-event-1\",\n \"subject_id\": \"customer:example\",\n \"message\": {\n \"role\": \"user\",\n \"text\": \"Hello\",\n \"at\": \"2026-09-22T10:00:00Z\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/orchestration/channels/{channel}/people/{subject}/memory", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels/{{channel}}/people/{{subject}}/memory", "description": "" } }, { "name": "PUT /api/orchestration/channels/{channel}/people/{subject}/memory", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/channels/{{channel}}/people/{{subject}}/memory", "description": "Person memory for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /api/orchestration/turns/{turn}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/turns/{{turn}}", "description": "" } }, { "name": "GET /api/orchestration/conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/conversations", "description": "Conversations for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. \n\nLookup `conversation_id`: read `data[].external_id` as the value and `data[].external_id` as the label. Use identifiers only within their authorised workspace.\n\nLookup `lookup_conversation_id`: read `data[].id` as the value and `data[].external_id` as the label. Use identifiers only within their authorised workspace.\n\nLookup `subject_id`: read `data[].subject_ref` as the value and `data[].subject_ref` as the label. Use identifiers only within their authorised workspace." } }, { "name": "GET /api/orchestration/conversations/{conversation}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://aiapi.autoappy.com/api/orchestration/conversations/{{conversation}}", "protocol": "https", "host": [ "aiapi", "autoappy", "com" ], "path": [ "api", "orchestration", "conversations", "{{conversation}}" ], "query": [ { "key": "summary", "value": "", "description": "Summary.", "disabled": true }, { "key": "before_sequence", "value": "", "description": "Before sequence.", "disabled": true }, { "key": "compact", "value": "", "description": "Compact.", "disabled": true }, { "key": "after_event", "value": "", "description": "After event.", "disabled": true } ] }, "description": "Conversation for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. \n\nLookup `turn_id`: read `turns[].id` as the value and `turns[].event_id` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /api/orchestration/conversations/{conversation}/control", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://aiapi.autoappy.com/api/orchestration/conversations/{{conversation}}/control", "description": "Control for orchestration. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }