Изменить индексацию документа
PATCH /api/v1/knowledges/{uniqueId}/toggle-indexing
URL
https://app.helpfy.ai/api/v1/knowledges/{uniqueId}/toggle-indexing
Адрес своей установки подставьте вместо 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/knowledges/11111111-1111-4111-8111-111111111111/toggle-indexing' \
--user 'user@example.com:api_key' \
--header 'Accept: application/json'
Ответы
| HTTP | Описание |
|---|---|
| 200 | Успешный ответ |
Пример ответа — HTTP 200
Сокращённый пример; показаны клиентские поля. Значения условные.
{
"message": "example",
"is_indexed": true
}