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

Загрузить файл

POST /v1/note/documents/:documentId/files

Сохраняет содержимое файла в Base64 и привязывает его к документу Базы знаний. Сам файл в содержимое документа не вставляется — чтобы вложение появилось в тексте, используйте assetMarkdown из ответа GET /v1/note/documents/:documentId/files/:id.

Параметры

Параметр Тип Обяз. Описание
documentId (path) integer да Документ, к которому привязывается файл. Идентификатор — из POST /v1/note/documents

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

Поле Тип Обяз. Описание
fileName string да Имя файла с расширением. Расширение определяет тип вложения
fileContent string да Содержимое файла, закодированное в Base64

Размер запроса ограничен 40 МБ. Точный лимит размера файла задаёт Битрикс24 и проверяет на своей стороне.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/documents/77/files \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "diagram.png",
    "fileContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/documents/77/files \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "diagram.png",
    "fileContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/files', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ fileName: 'diagram.png', fileContent: base64Content }),
})

const { success, data } = await res.json()
console.log(data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/files', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ fileName: 'diagram.png', fileContent: base64Content }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор загруженного файла, он же fileId. Передаётся в GET /v1/note/documents/:documentId/files/:id

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

JSON 
{
  "success": true,
  "data": {
    "id": 5001
  }
}

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

404 — документ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `999999` не найдена"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передан fileName или fileContent, либо documentId неверного типа
403 BITRIX_ACCESS_DENIED Нет права редактировать документ
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
404 ENTITY_NOT_FOUND Документ не существует, архивный или в корзине
413 — Размер запроса превышает 40 МБ
422 BITRIX_ERROR Размер файла превышает лимит, тип файла не разрешён, либо повреждён Base64. Текст в error.message
403 SCOPE_DENIED Ключу не хватает скоупа note
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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