Создать бота

`POST /api/v1/bots`

Создаёт бота для текущего пользователя.

URL

https://app.helpfy.ai/api/v1/bots

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

Заголовки

Заголовок	Значение
`Authorization`	`Basic <base64(email:api_key)>`
`Accept`	`application/json`

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

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

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

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

Поле	Тип	Обязательно	Описание
`name`	строка	Да	Название бота.
`gpt_model`	`yandexgpt`, `gigachat`, `chatgpt`, `ollama`	Да	Провайдер языковой модели, который будет использовать бот.
`gpt_version`	строка	Нет	Версия языковой модели. Актуальные значения получите через метод списка версий выбранного провайдера. Для Ollama список загружается из подключённого сервера.
`embedding_version`	строка	Нет	Версия модели для индексации и поиска. Для Ollama выберите подходящую модель из загруженных у провайдера.
`primary_language`	`ru`, `en`, `uk`, `be`, `kk`, `uz`, `az`, `hy`, `ka`, `ky`, `tg`, `tk`, `de`, `fr`, `es`, `it`, `pt`, `pl`, `ro`	Нет	Основной язык документов базы знаний. Поисковый запрос переводится на этот язык перед поиском. (по умолчанию: "ru")
`first_line_greeting_enabled`	логическое значение	Нет	Включить приветствие первой линии.
`first_line_greeting_text`	строка	Нет	Текст приветствия первой линии.
`rag_clarify_enabled`	логическое значение	Нет	Разрешить уточняющий вопрос, если сведений для ответа недостаточно.
`scenario_clarify_enabled`	логическое значение	Нет	Предлагать клиенту выбрать тему, если подходят несколько сценариев. (по умолчанию: false)
`scenario_clarify_min_confidence`	число	Нет	Минимальная оценка соответствия сценарию, при которой можно уточнить тему у клиента. (минимум: 0; максимум: 100; по умолчанию: 55)
`scenario_clarify_margin`	число	Нет	Разница оценок сценариев, при которой выбор темы считается неоднозначным. (минимум: 0; максимум: 100; по умолчанию: 12)
`max_output_tokens`	число	Нет	Максимальное количество токенов в ответе бота.
`allow_public_sources_in_support`	логическое значение	Нет	Показывать ссылки на публичные источники в режиме поддержки.
`tools_enabled`	логическое значение	Нет	Разрешить боту вызывать настроенные функции.
`anonymize_pii`	логическое значение	Нет	Обезличивать персональные данные перед отправкой языковой модели.
`webhook_url`	строка	Нет	Адрес вашего сервера для получения результатов запросов.

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

curl --request POST 'https://app.helpfy.ai/api/v1/bots' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "name": "Служба поддержки",
  "gpt_model": "yandexgpt"
}
JSON

Ответы

HTTP	Описание
201	Успешный ответ

Пример ответа — HTTP 201

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

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "Main knowledge bot",
  "primary_language": "ru",
  "first_line_greeting_enabled": true,
  "first_line_greeting_text": "Hello! How can I assist you today?",
  "rag_clarify_enabled": true,
  "scenario_clarify_enabled": false,
  "scenario_clarify_min_confidence": 55,
  "scenario_clarify_margin": 12,
  "allow_public_sources_in_support": true,
  "tools_enabled": false,
  "anonymize_pii": false,
  "max_output_tokens": 1000,
  "created_at": "2024-10-18T14:13:46.180Z",
  "updated_at": "2024-10-18T14:13:46.180Z"
}

POST /api/v1/bots​

URL​

Заголовки​

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

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

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

Ответы​