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

Получить документ

GET /v1/note/documents/:id

Возвращает один документ базы знаний по его идентификатору. Используйте, чтобы прочитать содержимое конкретного документа.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор документа. Список документов базы знаний — GET /v1/note/collections/:collectionId/documents

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/note/documents/11 \
  -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/11', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Документ:', data)

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор документа
data.collectionId number База знаний, которой принадлежит документ. Список: GET /v1/note/collections
data.parentId number или null Родительский документ в дереве базы знаний. null у документа верхнего уровня
data.title string Заголовок документа
data.markdown string Содержимое документа в разметке Markdown
data.position number Порядок сортировки среди соседних документов
data.createdBy number Идентификатор создателя. Список: GET /v1/users
data.updatedBy number Идентификатор автора последнего изменения. Список: GET /v1/users
data.createdAt string Дата создания в формате ISO 8601
data.updatedAt string Дата последнего изменения в формате ISO 8601

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

JSON 
{
  "success": true,
  "data": {
    "id": 11,
    "collectionId": 9,
    "parentId": null,
    "title": "Глава 1",
    "markdown": "# Глава 1\n\nТекст документа",
    "position": 1000,
    "createdBy": 1269,
    "updatedBy": 1269,
    "createdAt": "2026-06-23T19:07:29Z",
    "updatedAt": "2026-06-23T19:07:29Z"
  }
}

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

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

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является положительным целым числом
404 ENTITY_NOT_FOUND Документа с указанным id не существует
403 SCOPE_DENIED Ключу не хватает скоупа note
401 TOKEN_MISSING У API-ключа не настроены токены

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

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

Вставки прикреплённых файлов в тексте. Поле markdown может содержать блоки вида [[image fileId=17]], где тип — image, video или file. Так в текст документа встраиваются загруженные к нему файлы. При отображении документа обрабатывайте эти блоки отдельно от остальной разметки Markdown.

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