Загрузить PDF

POST /api/v1/knowledges/upload

URL

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

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

Заголовки

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

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

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

Тело запроса (multipart/form-data)

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Да	Уникальный идентификатор бота.
knowledge_group_unique_id	строка	Да	Уникальный идентификатор группы базы знаний.
type	FILE, SITE, TEXT	Да	Тип загружаемого документа.
name	строка	Да	Название документа, которое будет отображаться в списке.
file	строка	Да	Файл в формате PDF.

curl самостоятельно добавляет заголовок Content-Type и разделитель частей файла. Не задавайте этот заголовок вручную.

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

curl --request POST 'https://app.helpfy.ai/api/v1/knowledges/upload' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --form 'bot_unique_id=bot_123456' \
  --form 'knowledge_group_unique_id=kg_123456' \
  --form 'type=FILE' \
  --form 'name=Company security policy' \
  --form 'file=@./document.pdf'

Ответы

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

Пример ответа

JSON-тело ответа не описано в API этого метода. Ориентируйтесь на HTTP-статус.