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

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

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

Сохраняет содержимое файла в Base64 и привязывает его к документу Базы знаний. Сам файл в содержимое документа не вставляется — чтобы вложение появилось в тексте, вставьте в него assetMarkdown и сохраните документ через PATCH /v1/note/documents/:id. Готовый 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: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=' }),
})

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: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=' }),
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.id Типnumber ОписаниеИдентификатор загруженного файла, он же fileId. Передаётся в GET /v1/note/documents/:documentId/files/:id
Полеdata.documentId Типnumber ОписаниеДокумент, к которому привязан файл
Полеdata.name Типstring ОписаниеОригинальное имя файла
Полеdata.size Типnumber ОписаниеРазмер файла в байтах
Полеdata.mimeType Типstring ОписаниеТип содержимого файла в формате MIME, определённый при сохранении
Полеdata.assetType Типstring ОписаниеКатегория вложения: image, video или file
Полеdata.assetMarkdown Типstring ОписаниеГотовый фрагмент [[<assetType> fileId=<id>]] для вставки в содержимое

Ответ повторяет форму GET /v1/note/documents/:documentId/files/:id. Поля приходят от Битрикс24 как есть: если портал какое-то из них не вернул, платформа его не достраивает, а data.id присутствует всегда.

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

JSON 
{
  "success": true,
  "data": {
    "id": 5001,
    "documentId": 77,
    "name": "diagram.png",
    "size": 6321,
    "mimeType": "image/png",
    "assetType": "image",
    "assetMarkdown": "[[image fileId=5001]]"
  }
}

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

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

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

Ошибки

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

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

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