Получить список групп

GET /api/v1/knowledge-groups

Возвращает группы указанного бота и количество документов в каждой группе. Поддерживает просмотр по страницам.

URL

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

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

Заголовки

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

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

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

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

Параметр	Тип	Обязательный	Описание
bot_unique_id	строка	Да	Идентификатор бота, группы которого нужно получить.
search	строка	Нет	Поиск групп по названию.
skip	число	Нет	Количество записей, которые нужно пропустить.
take	число	Нет	Количество записей, которые нужно вернуть.

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

curl --request GET 'https://app.helpfy.ai/api/v1/knowledge-groups' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'bot_unique_id=804be633-6f3b-4d38-abf3-8b2709e141fb'

Ответы

HTTP	Описание
200	Список групп базы знаний с разделением на страницы.
404	Бот не найден.

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

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

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}