API-дії

API-дії дозволяють агенту викликати зовнішній HTTP-ендпоінт під час розмови і використовувати відповідь для відповіді відвідувачеві. Використовуйте для перевірки статусу замовлення, наявності товару, деталей акаунта або запиту до будь-якого внутрішнього API.

Створення дії

Перейдіть до Можливості → API-дії і натисніть Додати дію.

Загальні налаштування

• Назва — як AI називає цю дію внутрішньо. Коротко і описово: Перевірити статус замовлення, Перевірити наявність товару.
• Коли використовувати — опис звичайною мовою, коли AI має активувати цю дію.

Використовуй цю дію, коли відвідувач запитує про статус свого замовлення або хоче відстежити доставку.

Налаштування API-виклику

Метод і URL

Оберіть HTTP-метод (GET, POST, PUT, PATCH, DELETE) і введіть URL ендпоінта. Використовуйте {{плейсхолдери}} для динамічних значень:

https://api.yourshop.com/orders/{{order_id}}

Вхідні дані

Визначте змінні, які потрібні вашому URL, заголовкам або тілу запиту. Для кожної змінної:

Приклад для перевірки замовлення:

• Назва: order_id · Опис: Номер замовлення, який надав відвідувач · Обов'язкова: так

AI автоматично витягує значення з контексту розмови. Якщо обов'язкового значення немає, AI запитає відвідувача перед викликом.

Заголовки, Параметри, Тіло

Використовуйте вкладки для додавання заголовків авторизації, query-параметрів або тіла запиту. Плейсхолдери працюють скрізь:

Authorization: Bearer {{api_token}}

Для статичних секретів (наприклад, токенів API), які не мають витягуватися з чату, вводьте їх безпосередньо як значення без плейсхолдера — вони не будуть доступні AI чи відвідувачам.

Тестування дії

У розділі Тест відповіді введіть тестові значення для ваших змінних і натисніть Запустити тест. Реальний HTTP-виклик буде виконаний і відповідь відобразиться. Використовуйте це для перевірки URL і авторизації перед запуском.

Доступ до даних

Визначає, яку частину відповіді API може бачити AI:

• Повний — весь JSON-об'єкт передається AI. Використовуйте для простих відповідей, де всі поля потрібні.
• Обмежений — AI бачить лише поля з вашого білого списку. Використовуйте для захисту чутливих даних (внутрішні ID, токени, персональні дані) від потрапляння у відповіді AI.

Вводьте шляхи до полів по одному в рядку, використовуючи крапкову нотацію:

order.status
order.estimated_delivery
customer.name

Поради

• Тримайте відповіді стислими — AI узагальнює відповідь при відповіді, тому сфокусований об'єкт дає кращі результати, ніж 200-польовий.
• Використовуйте Обмежений доступ до даних для будь-якого API, що повертає чутливі поля поряд з потрібними.
• Якщо ваш API потребує OAuth, використовуйте довгоживучий токен сервісу замість токена користувача.
• Синтаксис {{плейсхолдер}} працює в: URL, query-параметрах, заголовках і тілі запиту.