Проверить целостность базы знаний
POST /api/v1/knowledge-integrity/bots/{botUniqueId}/scan
URL
https://app.helpfy.ai/api/v1/knowledge-integrity/bots/{botUniqueId}/scan
Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.
Заголовки
| Заголовок | Значение |
|---|---|
Authorization | Basic <base64(email:api_key)> |
Accept | application/json |
Подробнее — авторизация API.
Параметры запроса
Параметры пути
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
botUniqueId | строка | Да | Идентификатор бота. |
Пример запроса
curl --request POST 'https://app.helpfy.ai/api/v1/knowledge-integrity/bots/11111111-1111-4111-8111-111111111111/scan' \
--user 'user@example.com:api_key' \
--header 'Accept: application/json'
Ответы
| HTTP | Описание |
|---|---|
| 201 | Успешный ответ |
Пример ответа — HTTP 201
Сокращённый пример; показаны клиентские поля. Значения условные.
{
"message": "Integrity scan started",
"scan_id": "7827d9b8-8bb8-428b-984a-7bfcf3221f1f"
}