Для AI-агентов: markdown этой страницы — /docs-content/chats/files/upload-to-folder.md индекс документации — /llms.txt

Загрузить файл в папку чата

POST /v1/chats/:chatId/files/uploads

Метод в процессе раскатки — выходит в обновлении im 26.1500.0. Доступен не на всех порталах Битрикс24. Если метод ещё не доступен, API вернёт 422 METHOD_NOT_YET_AVAILABLE с error.release.

Загружает один файл в папку чата без создания сообщения. Для публикации вызовите маршрут публикации с data.file.id в uploadIds.

Параметры

Параметр Тип Обяз. Описание
chatId (path) number да ID чата. Получить: POST /v1/chats или поле chatId строки GET /v1/chats/recent

Поля запроса (body)

Поле Тип Обяз. Описание
filename string да Имя файла с расширением
content string да Содержимое в base64, не более 4 МиБ после декодирования

Другие поля и параметры запроса отклоняются с 400 INVALID_PARAMS.

Примеры

curl — личный ключ

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/42/files/uploads \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filename":"a.txt","content":"YWJj"}'

curl — OAuth-приложение

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/42/files/uploads \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"filename":"a.txt","content":"YWJj"}'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/files/uploads', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"filename": "a.txt", "content": "YWJj"}),
})
const { success, data, error } = await res.json()
console.log(success ? data : error)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/files/uploads', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"filename": "a.txt", "content": "YWJj"}),
})
const { success, data, error } = await res.json()
console.log(success ? data : error)

Поля ответа

Поле Тип Описание
success boolean true при успехе
data.file object Файл в папке чата. Ссылки с токенами обнулены
data.file.id number ID загруженного файла. Передайте в uploadIds при публикации
data.file.name string Имя файла
data.file.size number Размер файла в байтах
data.chatId number ID чата
data.dialogId string ID диалога. messageId отсутствует

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

JSON 
{
  "success": true,
  "data": {
    "file": {
      "id": 7701,
      "name": "a.txt",
      "size": 3
    },
    "chatId": 42,
    "dialogId": "chat42"
  }
}

Пример ответа при ошибке

400 — содержимое больше 4 МиБ:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`content` exceeds the 4 MiB file limit."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Некорректное тело или лишние параметры
400 INVALID_CHAT_ID chatId в пути не положительное целое число
401 TOKEN_MISSING Нет токенов портала
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения
403 BITRIX_ACCESS_DENIED Нет доступа к чату на портале
413 PAYLOAD_TOO_LARGE Тело JSON больше 40 МиБ. Уменьшите запрос
422 METHOD_NOT_YET_AVAILABLE Метод ещё не доступен на портале — см. заметку в начале страницы
422 BITRIX_ERROR Портал отказал файлу
429 LARGE_BODY_BACKEND_BUSY Сейчас принимается слишком много больших тел. Повторите с учётом Retry-After
429 QUEUE_TIMEOUT Очередь портала перегружена. Повторите с учётом Retry-After

Для общего 422 BITRIX_ERROR поле error.b24Code присутствует только при распознанном коде. Платформа не повторяет загрузку после неизвестного исхода.

Полный список общих ошибок API — Ошибки.

Смотрите также