Создать группу

POST /api/v1/knowledge-groups

Создаёт группу базы знаний. Если бот не найден, возвращается 404.

URL

https://app.helpfy.ai/api/v1/knowledge-groups

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

Заголовки

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

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

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

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

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

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Да	Уникальный идентификатор бота.
name	строка	Да	Название группы базы знаний.

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

curl --request POST 'https://app.helpfy.ai/api/v1/knowledge-groups' \
  --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": "My new group"
}
JSON

Ответы

HTTP	Описание
201	Данные созданной группы базы знаний.
404	Бот не найден.

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

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

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "My new group",
  "is_default": false,
  "created_at": "2024-10-18T14:13:46.180Z",
  "updated_at": "2024-10-18T14:13:46.180Z"
}