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

Создать базу знаний

POST /v1/note/collections

Создаёт базу знаний — контейнер для документов в Базе знаний 2.0 Битрикс24. Тело передаётся плоско, без обёртки fields.

Поля запроса (body)

Поле Тип Обяз. Описание
Полеname Типstring Обяз.да ОписаниеНазвание базы знаний
Полеposition Типinteger Обяз.нет ОписаниеПозиция в списке. Сортировка по убыванию значения. По умолчанию 0 — база знаний размещается в начале списка

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/collections \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Продуктовая документация",
    "position": 100
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/collections \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Продуктовая документация",
    "position": 100
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Продуктовая документация',
    position: 100,
  }),
})

const { success, data } = await res.json()
console.log('ID базы знаний:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Продуктовая документация',
    position: 100,
  }),
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОбъект с идентификатором созданной базы знаний
Полеdata.id Типnumber ОписаниеИдентификатор созданной базы знаний

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

JSON 
{
  "success": true,
  "data": {
    "id": 42
  }
}

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

400 — не передан name:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`name` is required and must be a non-empty string"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан name, либо position не является неотрицательным целым числом
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНа портале Битрикс24 нет права создавать базы знаний
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме «только чтение»
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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