Перейти к основному содержимому

Создать модель поведения

POST /api/v1/bot-agents​

Создаёт модель поведения для указанного бота. Если бот не найден, возвращается 404; если нет доступа — 403.

URL​

https://app.helpfy.ai/api/v1/bot-agents

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки​

ЗаголовокЗначение
AuthorizationBasic <base64(email:api_key)>
Acceptapplication/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

Параметры запроса​

Тело запроса (application/json)​

ПолеТипОбязательноОписание
bot_unique_idстрокаДаУникальный идентификатор бота.
nameстрокаДаНазвание записи.
greeting_messageстрокаНетГотовое приветствие в начале нового диалога.
greeting_message_is_enabledлогическое значениеНетВключить готовое приветствие.
greeting_filterстрокаНетДополнительные правила распознавания приветствия.
greeting_filter_is_enabledлогическое значениеНетВключить дополнительные правила распознавания приветствия.
closing_messageстрокаНетГотовое сообщение при завершении диалога.
closing_message_is_enabledлогическое значениеНетВключить готовый ответ при завершении диалога.
closing_filterстрокаНетДополнительные правила распознавания завершения диалога.
closing_filter_is_enabledлогическое значениеНетВключить дополнительные правила завершения диалога.
classify_greeting_is_enabledлогическое значениеНетВключить распознавание приветствия в режиме поддержки.
classify_closing_is_enabledлогическое значениеНетВключить распознавание завершения диалога в режиме поддержки.
classify_operator_is_enabledлогическое значениеНетВключить распознавание просьбы о переводе на оператора.
classify_spam_is_enabledлогическое значениеНетВключить распознавание спама в режиме поддержки.
spam_filterстрокаНетПравила определения спама.
spam_filter_is_enabledлогическое значениеНетВключить фильтр спама.
spam_fallback_messageстрокаНетГотовый ответ на сообщение, признанное спамом.
system_behaviorстрокаНетСистемная роль, стиль и правила общения бота.
system_behavior_is_enabledлогическое значениеНетВключить правила общения бота.
executorстрокаНетПравила перевода диалога на оператора.
executor_is_enabledлогическое значениеНетВключить правила перевода на оператора.
executor_fallback_messageстрокаНетГотовое сообщение при переводе на оператора.
constant_contextстрокаНетСведения, добавляемые к каждому запросу бота.
constant_context_is_enabledлогическое значениеНетВключить постоянный контекст.
public_sources_headerстрокаНетТекст перед списком использованных источников.
public_sources_header_is_enabledлогическое значениеНетВключить собственный заголовок списка источников.
public_sources_limitчислоНетВключить собственный заголовок списка источников.
is_activeлогическое значениеНетИспользуется ли эта модель поведения ботом.

Пример запроса​

curl --request POST 'https://app.helpfy.ai/api/v1/bot-agents' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "11111111-1111-4111-8111-111111111111",
  "name": "Default Agent"
}
JSON

Ответы​

HTTPОписание
201Успешный ответ
403Недостаточно прав для изменения модели поведения.
404Бот не найден.
Пример ответа — HTTP 201

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "Служба поддержки",
  "greeting_message": "example",
  "greeting_message_is_enabled": true,
  "greeting_filter": "example",
  "greeting_filter_is_enabled": true,
  "closing_message": "example",
  "closing_message_is_enabled": true,
  "closing_filter": "example",
  "closing_filter_is_enabled": true,
  "classify_greeting_is_enabled": true,
  "classify_closing_is_enabled": true,
  "classify_operator_is_enabled": true,
  "classify_spam_is_enabled": true,
  "spam_filter": "example",
  "spam_filter_is_enabled": true,
  "spam_fallback_message": "example",
  "system_behavior": "example",
  "system_behavior_is_enabled": true,
  "executor": "example",
  "executor_is_enabled": true,
  "executor_fallback_message": "example",
  "constant_context": "example",
  "constant_context_is_enabled": true,
  "public_sources_header": "example",
  "public_sources_header_is_enabled": true,
  "public_sources_limit": 1,
  "is_active": false,
  "is_default": false,
  "created_at": "2026-10-16T09:00:00.000Z",
  "updated_at": "2026-10-16T09:00:00.000Z"
}