Проверить наличие документа

GET /api/v1/knowledges/document-exists

URL

https://app.helpfy.ai/api/v1/knowledges/document-exists

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

Заголовки

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

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

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

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

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

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

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

Ответы

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

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

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

{
  "document_id": "external-document-123",
  "exists": true
}