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

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

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

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

Параметры

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

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/note/documents/77/files/5001 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
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)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.id Типnumber ОписаниеИдентификатор файла
Поле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>]] для вставки в содержимое

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

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 ОписаниеНе передан documentId или id, либо параметр неверного типа
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP404 КодENTITY_NOT_FOUND ОписаниеДокумент или файл не существуют, нет доступа, либо файл не привязан к документу
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

Известные особенности

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

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