Включить индексацию группы

PATCH /api/v1/knowledge-groups/{uniqueId}/indexing/enable

Включает участие документов группы в поиске ответа. Если группа не найдена, возвращается 404.

URL

https://app.helpfy.ai/api/v1/knowledge-groups/{uniqueId}/indexing/enable

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

Заголовки

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

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

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

Параметры пути

Параметр	Тип	Обязательный	Описание
uniqueId	строка	Да	Идентификатор группы базы знаний.

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

curl --request PATCH 'https://app.helpfy.ai/api/v1/knowledge-groups/11111111-1111-4111-8111-111111111111/indexing/enable' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json'

Ответы

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

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

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

{
  "message": "example",
  "is_indexed": true
}