Необов’язкові перевірки прикладів
Section titled “Необов’язкові перевірки прикладів”-
Попередній перегляд збігів JSONPath. Перевірте шляхи до кореня, полів, індексів масиву та шляхи з підстановкою за наданим JSON. Дія не виконується, пам’ять розмови не зберігається.
-
Перевірка тестового підключення MCP. Ініціалізуйте підключення й отримайте список інструментів лише з ендпоїнта документації Cloudflare або Microsoft Learn. Вхід і виконання інструментів не здійснюються.
У сумісному браузері ці перевірки також доступні як інструменти сайту. Посилання відкривають звичайні форми.
Дії AI
Section titled “Дії AI”Дії AI розширюють можливості AI-агента за межі відповідей із Бази знань. Вони визначають поведінку за умовою: що AI має зробити, коли виявить певну ситуацію в розмові.
Можливості дій AI:
- Дії HTTP-запиту: викликають зовнішні API. Наприклад, перевіряють статус замовлення у вашому бекенді, створюють звернення до підтримки або шукають дані облікового запису під час розмови.
- Дії MCP: підключають сервери Model Context Protocol для інтеграції інструментів, наприклад пошуку товарів Shopify чи власних запитів до бази даних.
Типові сценарії:
- Отримання актуальної інформації (статусів замовлень, даних облікового запису, запасів) із ваших систем під час розмови
- Створення звернень, оновлення записів CRM або запуск процесів у зовнішніх системах на основі контексту розмови
- Персоналізовані рекомендації через запити до каталогу товарів
Кожна дія має name, description (для HTTP-запитів опис пояснює AI, коли виконати дію) і конфігурацію відповідного типу. Дії можна окремо вмикати й вимикати через API. Створення й повне налаштування доступні в панелі керування Quickchat; API надає отримання списку, оновлення (увімкнення/вимкнення) і видалення, а також окремі ендпоїнти для створення й налаштування дій MCP.
Список усіх дій AI
Section titled “Список усіх дій AI”GET https://app.quickchat.ai/v1/api/ai_actions
curl https://app.quickchat.ai/v1/api/ai_actions \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.get( url="https://app.quickchat.ai/v1/api/ai_actions", headers={"Authorization": "Bearer <API_TOKEN>"},)data = response.json()Відповідь 200 OK
[ { "id": 1, "name": "Check Order Status", "description": "Look up order status when customer asks about their order.", "is_active": true, "type": "http_request", "icon": null, "icon_color": null, "is_valid": true }]| Поле | Опис |
|---|---|
id integer | Ідентифікатор дії AI |
name string | Назва для відображення |
description string | Коли спрацьовує дія |
is_active boolean | Чи ввімкнено дію |
type string | "http_request", "remote_mcp", "shopify_remote_mcp" або "knowledge_base" |
icon string or null | Ідентифікатор значка |
icon_color string or null | Колір значка |
is_valid boolean | Чи коректно налаштовано дію |
Оновлення дії AI
Section titled “Оновлення дії AI”PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}
Тіло запиту
| Параметр | Опис |
|---|---|
is_active boolean | Увімкнення/вимкнення дії |
icon string | Ідентифікатор значка (до 200 символів) |
icon_color string | Колір значка (до 50 символів) |
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{"is_active": false}'import requests
response = requests.patch( url="https://app.quickchat.ai/v1/api/ai_actions/1", headers={"Authorization": "Bearer <API_TOKEN>"}, json={"is_active": False},)data = response.json()Відповідь 200 OK: повертає оновлений стан дії AI.
Видалення дії AI
Section titled “Видалення дії AI”DELETE https://app.quickchat.ai/v1/api/ai_actions/{action_id}
curl -X DELETE https://app.quickchat.ai/v1/api/ai_actions/1 \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.delete( url="https://app.quickchat.ai/v1/api/ai_actions/1", headers={"Authorization": "Bearer <API_TOKEN>"},)Відповідь 200 OK (порожнє тіло)
Створення дії MCP
Section titled “Створення дії MCP”POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp
Підключає віддалений сервер MCP до AI-агента як дію MCP. Потрібен токен API з областю write_all (токени API потребують тарифу Business або вищого).
Тіло запиту
| Параметр | Опис |
|---|---|
remote_mcp_url string, обов’язковий | URL сервера MCP. Має використовувати https://; адреси, що вказують на приватну чи внутрішню мережу, відхиляються |
headers array, обов’язковий | Заголовки підключення, які надсилаються серверу, наприклад статичний токен Authorization. Кожен елемент має вигляд {"id", "name", "value"}; для id виберіть будь-який унікальний рядок. Надішліть [], якщо заголовки не потрібні |
allowed_tools array, обов’язковий | Перемикачі інструментів, кожен у вигляді {"name", "is_active"}. Надішліть [], щоб доступність визначалася через default_tool_is_active |
name string | Назва в списку дій (до 100 символів). За замовчуванням формується з хоста сервера |
description string | Опис у списку дій (до 2 500 символів) |
icon string | Ідентифікатор значка (до 200 символів) |
icon_color string | Колір значка (до 50 символів) |
name і description призначені для операторів: вони ідентифікують дію в панелі керування, а AI їх не читає. AI використовує описи інструментів, опубліковані самим сервером MCP.
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "remote_mcp_url": "https://mcp.example.com/mcp", "headers": [ {"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"} ], "allowed_tools": [], "name": "Example MCP" }'import requests
response = requests.post( url="https://app.quickchat.ai/v1/api/ai_actions/remote_mcp", headers={"Authorization": "Bearer <API_TOKEN>"}, json={ "remote_mcp_url": "https://mcp.example.com/mcp", "headers": [ {"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"} ], "allowed_tools": [], "name": "Example MCP", },)data = response.json()Відповідь 201 Created
{ "id": 2, "name": "Example MCP", "description": "Connected MCP server", "is_active": false, "type": "remote_mcp", "icon": "FaMixcloud", "icon_color": "#EF4444", "is_valid": true, "validation_issues": [], "remote_mcp_url": "https://mcp.example.com/mcp", "remote_mcp_auth_token": "", "default_tool_is_active": true, "allowed_tools": [], "headers": [ {"id": 10, "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"} ], "oauth": null, "recommended_tools": []}| Поле | Опис |
|---|---|
remote_mcp_url string | URL підключеного сервера MCP |
default_tool_is_active boolean | Чи можна використовувати інструменти, не перелічені в allowed_tools |
allowed_tools array | Перемикачі інструментів, {"name", "is_active"} |
headers array | Збережені заголовки підключення |
remote_mcp_auth_token string or null | Застаріле поле статичного токена. Його не можна задавати через цей API; передавайте облікові дані через headers |
oauth object or null | Статус авторизації серверів, підключених через OAuth (null в інших випадках) |
recommended_tools array | Назви інструментів, рекомендованих Quickchat для серверів із підготовленим профілем (лише читання) |
validation_issues array | Назви невдалих перевірок конфігурації; порожній масив, коли is_valid дорівнює true |
Решта полів відповідає Списку всіх дій AI.
Дія створюється з is_active: false. Для серверів без підготовленого профілю Quickchat початкове значення також становить default_tool_is_active: true, тому всі інструменти, знайдені під час відповіді, дозволені, доки ви їх не обмежите. Щоб увімкнути дію, використайте ендпоїнт Оновлення дії AI вище: PATCH /v1/api/ai_actions/{action_id} із {"is_active": true}.
Отримання конфігурації дії MCP
Section titled “Отримання конфігурації дії MCP”GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp
curl https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.get( url="https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp", headers={"Authorization": "Bearer <API_TOKEN>"},)data = response.json()Відповідь 200 OK: повертає конфігурацію MCP у тому самому форматі, що й відповідь створення вище.
Оновлення конфігурації дії MCP
Section titled “Оновлення конфігурації дії MCP”PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp
Усі поля необов’язкові; змінюються лише передані поля.
Тіло запиту
| Параметр | Опис |
|---|---|
remote_mcp_url string | Новий URL сервера (перевіряється як під час створення). Зміна URL сервера, підключеного через OAuth, очищає збережену авторизацію й вимикає дію |
headers array | Замінює заголовки підключення |
allowed_tools array | Замінює перемикачі інструментів, кожен {"name", "is_active"} |
default_tool_is_active boolean | Чи можна використовувати інструменти, не перелічені в allowed_tools |
name string | Назва для відображення (до 100 символів) |
description string | Опис у списку дій (до 2 500 символів) |
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "allowed_tools": [ {"name": "search_docs", "is_active": true}, {"name": "delete_page", "is_active": false} ], "default_tool_is_active": false }'import requests
response = requests.patch( url="https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp", headers={"Authorization": "Bearer <API_TOKEN>"}, json={ "allowed_tools": [ {"name": "search_docs", "is_active": True}, {"name": "delete_page", "is_active": False}, ], "default_tool_is_active": False, },)data = response.json()Відповідь 200 OK: повертає оновлену дію MCP в тому самому форматі, що й відповідь створення.
Перевірка підключення й пошук інструментів, які запускає Підключити в панелі керування, недоступні через публічний API. Панель автоматично виконує перевірку під час підключення чи повторного підключення сервера. Сервери з OAuth мають завершити авторизацію в панелі; поле oauth у відповідях вище повідомляє її статус.