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

Дерево документов базы знаний

GET /v1/note/collections/:collectionId/documents

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

Общий параметр filter этим эндпоинтом не применяется. По умолчанию API сохраняет прежний ответ HTTP 200 и прежние данные, добавляет заголовок Warning: 299 - "filter is not supported on this endpoint and was ignored", а сервер фиксирует использование неподдерживаемого фильтра в журнале.

Параметры

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

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/note/collections/9/documents \
  -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/collections/9/documents', {
  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/collections/9/documents', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеДокументы верхнего уровня базы знаний
Полеdata[].id Типnumber ОписаниеИдентификатор документа
Полеdata[].collectionId Типnumber ОписаниеИдентификатор базы знаний, которой принадлежит документ. Список: GET /v1/note/collections
Полеdata[].parentId Типnumber или null ОписаниеИдентификатор родительского документа. null у документа верхнего уровня
Полеdata[].title Типstring ОписаниеЗаголовок документа
Полеdata[].position Типnumber ОписаниеЧисловая позиция документа среди соседних
Полеdata[].children Типarray ОписаниеВложенные документы той же структуры
Полеmeta.truncated Типboolean Описаниеtrue, если дерево показано не полностью

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 65,
      "collectionId": 27,
      "parentId": null,
      "title": "Глава 1",
      "position": 1000,
      "children": [
        {
          "id": 67,
          "collectionId": 27,
          "parentId": 65,
          "title": "Раздел 1.1",
          "position": 1000,
          "children": []
        }
      ]
    }
  ],
  "meta": { "truncated": false }
}

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

404 — база знаний не найдена:

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

Ошибки

HTTP Код Описание
HTTP200 КодWarning: 299 ОписаниеФильтр игнорируется по умолчанию; прежние данные сохраняются, предупреждение передаётся заголовком Warning.
HTTP400 только при включённом строгом режиме КодUNSUPPORTED_FILTER ОписаниеСерверный режим выключен по умолчанию; до его включения эндпоинт сохраняет HTTP 200 и прежние данные.
HTTP400 КодINVALID_PARAMS ОписаниеcollectionId не является положительным целым числом
HTTP404 КодENTITY_NOT_FOUND ОписаниеБаза знаний с указанным collectionId не найдена
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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

Архивные документы в дерево не входят. Возвращаются только активные документы базы знаний.

Поле meta.truncated приходит true, когда дерево достигло внутреннего предела в 5000 узлов. В этом случае показана только часть структуры.

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