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

Метаданные файла

GET /v1/chats/files/:fileId

Возвращает метаданные файла: имя, размер, тип и ссылку на страницу файла. Для обычного ключа требует скоуп im и возвращает downloadUrl — адрес скачивания через API Вайбкод, для перехода по которому ключу нужен скоуп disk или crm. READONLY дополнительно требует disk и не получает ссылку. Права пользователя на файл в Битрикс24 сохраняются. Числовой fileId сам по себе не подтверждает принадлежность файла доступному чату. Используйте fileId из ответа POST /v1/chats/:chatId/files.

Для скачивания содержимого с READONLY используйте авторизованный GET /v1/files/:fileId/download. Нужен disk или crm; скоупа im одного недостаточно. Загрузка файла в чат по-прежнему требует im.

Параметры

Параметр Тип Обяз. Описание
fileId (path) number да ID файла. Получить: POST /v1/chats/:chatId/files → data.fileId

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/chats/files/9265 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/chats/files/9265 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/files/9265', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Имя файла:', data.name)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/files/9265', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
console.log('Имя файла:', data.name)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id string ID файла
data.name string Имя файла
data.size string Размер файла в байтах
data.type string Тип объекта (file)
data.detailUrl string Ссылка на страницу файла в Битрикс24
data.createdBy string ID пользователя, загрузившего файл
data.createdAt string Дата загрузки (ISO 8601)
data.updatedAt string Дата последнего изменения (ISO 8601)
data.downloadUrl string Адрес скачивания через API Вайбкод, GET /v1/files/:id/download, для обычного ключа. Переход по нему требует скоуп disk или crm. Отсутствует у READONLY

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

JSON 
{
  "success": true,
  "data": {
    "id": "9265",
    "name": "report.pdf",
    "size": "24576",
    "type": "file",
    "detailUrl": "https://YOUR_PORTAL.bitrix24.tech/file/chat1001/report.pdf",
    "createdBy": "1",
    "createdAt": "2026-06-05T13:48:24+03:00",
    "updatedAt": "2026-06-05T13:48:24+03:00"
  }
}

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

404 — файл не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "FILE_NOT_FOUND",
    "message": "File not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS fileId не является положительным целым числом — проверяется до обращения в Битрикс24
404 FILE_NOT_FOUND Файл с указанным fileId не найден
404 ENTITY_NOT_FOUND Битрикс24 вернул ошибку NOT_FOUND — файл не существует или недоступен
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе к файлу с кодом ACCESS_DENIED
422 BITRIX_ERROR Ошибка Битрикс24 при получении метаданных
403 SCOPE_DENIED Ключу не хватает im, либо ключу в режиме READONLY не хватает disk. Проверка выполняется до обращения в Битрикс24
401 TOKEN_MISSING Ключ не имеет настроенных токенов Битрикс24

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

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