Загрузить вложение

POST /api/v1/bots/{uniqueId}/attachments

Загружает файл для последующего использования в запросах и возвращает данные вложения.

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/attachments

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

Заголовки

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

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

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

Параметры пути

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

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

Поле	Тип	Обязательно	Описание
file	строка	Да	Файл, который нужно прикрепить к запросу модели.

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

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

curl --request POST 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/attachments' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --form 'file=@./document.pdf'

Ответы

HTTP	Описание
201	Успешный ответ
400	Неверные параметры загрузки вложения.

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

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

{
  "unique_id": "a57be8c1-4db0-4bd8-aa8d-159ae8d40a16",
  "provider_file_id": "file-7d5d2f63b37d4af8a8ed4a82f4e0d3f6",
  "status": "UPLOADED",
  "provider": "gigachat",
  "file_name": "contract.pdf",
  "size_bytes": 1024,
  "created_at": "2026-03-14T12:00:00.000Z",
  "updated_at": "2026-03-14T12:00:00.000Z"
}

Пример ошибки — HTTP 400 (1)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "message": "The file was not uploaded",
  "error": "Bad Request"
}

Пример ошибки — HTTP 400 (2)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "message": "No integration profile found for bot with unique id: 1, set integration data first",
  "error": "Bad Request"
}

Пример ошибки — HTTP 400 (3)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "message": "Attachments are not supported for this model yet",
  "error": "Bad Request"
}

Пример ошибки — HTTP 400 (4)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "message": "File too large",
  "error": "Bad Request"
}