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

Список документов

GET /v1/note/documents

Возвращает плоский список доступных документов с продолжением. Для полного обхода большой базы знаний используйте этот метод: дерево документов одной базы не является страницей.

Параметры

Параметр Тип Обяз. Описание
Параметрlimit (query) Типinteger Обяз.нет ОписаниеРазмер страницы, от 1 до 200
ПараметрafterCursor (query) Типstring Обяз.нет ОписаниеJSON объекта meta.nextCursor из предыдущего ответа, закодированный для URL. Поля: stream, collectionId, id

Передавайте курсор без изменения полей. collectionId может быть null. Завершайте обход только при meta.nextCursor: null: пустой data при ненулевом курсоре означает, что нужно запросить следующую страницу.

Примеры

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

Terminal 
curl -G https://vibecode.bitrix24.tech/v1/note/documents \
  --data-urlencode "limit=20" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -G https://vibecode.bitrix24.tech/v1/note/documents \
  --data-urlencode "limit=20" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
let cursor = null
do {
  const params = new URLSearchParams({ limit: '20' })
  if (cursor) params.set('afterCursor', JSON.stringify(cursor))
  const res = await fetch(`https://vibecode.bitrix24.tech/v1/note/documents?${params}`, {
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  })
  if (!res.ok) throw new Error(`HTTP ${res.status}`)
  const { data, meta } = await res.json()
  for (const document of data) console.log(document.id)
  cursor = meta.nextCursor
} while (cursor !== null)

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

javascript 
let cursor = null
do {
  const params = new URLSearchParams({ limit: '20' })
  if (cursor) params.set('afterCursor', JSON.stringify(cursor))
  const res = await fetch(`https://vibecode.bitrix24.tech/v1/note/documents?${params}`, {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  })
  if (!res.ok) throw new Error(`HTTP ${res.status}`)
  const { data, meta } = await res.json()
  for (const document of data) console.log(document.id)
  cursor = meta.nextCursor
} while (cursor !== null)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеДокументы текущей страницы; массив может быть пустым при наличии продолжения
Полеdata[].id Типnumber ОписаниеИдентификатор документа
Полеmeta.nextCursor Типobject или null ОписаниеКурсор { stream, collectionId, id } следующей страницы или null в конце

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

JSON 
{
  "success": true,
  "data": [{ "id": 40 }],
  "meta": { "nextCursor": { "stream": "collections", "collectionId": 3, "id": 40 } }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеlimit вне 1…200 или повреждённый afterCursor
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа не настроены токены

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

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