Создать документ асинхронно

POST /api/v1/knowledges/async

URL

https://app.helpfy.ai/api/v1/knowledges/async

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

Заголовки

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

Для JSON-тела передайте Content-Type: application/json.

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

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

Тело запроса (application/json)

Поле	Тип	Обязательно	Описание
document_id	строка	Нет	Уникальный идентификатор документа.
bot_unique_id	строка	Да	Уникальный идентификатор бота.
knowledge_group_unique_id	строка	Да	Уникальный идентификатор группы базы знаний.
name	строка	Да	Название документа.
type	FILE, SITE, TEXT	Да	Тип документа: текст, файл или страница сайта.
content	строка	Да	Текст документа базы знаний.
source	строка	Нет	Ссылка или примечание к источнику, из которого взята информация.
is_private_source	логическое значение	Нет	Скрывать ссылку на источник в ответах. Содержимое документа при этом может использоваться. (по умолчанию: true)
is_indexed	логическое значение	Нет	Участвует ли содержимое документа в поиске информации для ответов. (по умолчанию: true)

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

curl --request POST 'https://app.helpfy.ai/api/v1/knowledges/async' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "11111111-1111-4111-8111-111111111111",
  "knowledge_group_unique_id": "11111111-1111-4111-8111-111111111111",
  "name": "Служба поддержки",
  "type": "FILE",
  "content": "Адрес доставки можно изменить до передачи заказа в доставку."
}
JSON

Ответы

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

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

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

{
  "message": "Document has been successfully queued for upload",
  "unique_id": "4e48b893-3793-413a-89bd-8f74ac4c2f1d"
}