#Файлы

⚠️ Методы в процессе раскатки — выходят в обновлении note 26.100.0. Доступны не на всех порталах Битрикс24. Если на вашем портале метод ещё не доступен, API вернёт 422 METHOD_NOT_YET_AVAILABLE — это не ошибка интеграции, а признак того, что обновление пока не приехало на портал.

Загрузка вложений к документам Базы знаний. Все методы требуют скоуп note. OAuth-приложения добавляют заголовок Authorization: Bearer USER_SESSION_TOKEN к каждому вызову.

Вложение добавляется в два шага: POST /v1/note/documents/:documentId/files сохраняет файл и привязывает его к документу, а GET /v1/note/documents/:documentId/files/:id возвращает готовый фрагмент assetMarkdown для вставки в содержимое документа через PATCH /v1/note/documents/:id. Полный пример — Обзор Базы знаний.

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

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

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

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

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="}'

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) // fileId

#Поля ответа

data = { id } — идентификатор загруженного файла (он же fileId), передаётся в GET /v1/note/documents/:documentId/files/:id.

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

#Ошибки

#Получить метаданные файла

GET /v1/note/documents/:documentId/files/:id

Возвращает метаданные файла и готовый фрагмент assetMarkdown для вставки в содержимое документа. Чтение — доступно и ключу в режиме «только чтение».

curl https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001 \
  -H "X-Api-Key: YOUR_API_KEY"

const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
console.log(data.assetMarkdown) // "[[image fileId=5001]]"

#Поля ответа

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

Чтобы вложение появилось в документе, добавьте assetMarkdown отдельной строкой в markdown и вызовите PATCH /v1/note/documents/:id. Фрагмент должен начинаться с начала строки, без других символов в той же строке. Тип пишется в нижнем регистре, fileId — целое положительное число.

#Ошибки

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

• Базы знаний
• Документы
• Обзор Базы знаний