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

Создать документ

POST /v1/note/documents

Создаёт документ в базе знаний. Непустой markdown создаёт документ с готовым содержимым, без него создаётся пустой документ для совместного редактирования.

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

Поле Тип Обяз. Описание
ПолеcollectionId Типinteger Обяз.да ОписаниеИдентификатор базы знаний. Список: GET /v1/note/collections
Полеtitle Типstring Обяз.да ОписаниеЗаголовок документа
ПолеparentId Типinteger Обяз.нет ОписаниеРодительский документ для вложенности. Принадлежит той же базе знаний. Дерево документов: GET /v1/note/collections/:collectionId/documents
Полеmarkdown Типstring Обяз.нет ОписаниеНачальное содержимое в Markdown. Максимум 1 048 576 байт (1 МиБ)

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/documents \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "collectionId": 42,
    "title": "Глава 1",
    "parentId": 10,
    "markdown": "# Глава 1\n\nТекст"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/documents \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "collectionId": 42,
    "title": "Глава 1",
    "parentId": 10,
    "markdown": "# Глава 1\n\nТекст"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    collectionId: 42,
    title: 'Глава 1',
    parentId: 10,
    markdown: '# Глава 1\n\nТекст',
  }),
})
const { success, data } = await res.json()
console.log(data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    collectionId: 42,
    title: 'Глава 1',
    parentId: 10,
    markdown: '# Глава 1\n\nТекст',
  }),
})
const { success, data } = await res.json()

Поля ответа

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

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

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

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

400 — не передан обязательный параметр:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`collectionId` is required and must be a positive integer"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан collectionId или title, либо параметр неверного типа
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права создавать документы в базе знаний
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч в режиме «только чтение»
HTTP404 КодENTITY_NOT_FOUND ОписаниеБаза знаний или родительский документ не существуют
HTTP422 КодBITRIX_ERROR ОписаниеparentId из другой базы знаний, либо размер markdown превышает лимит. Текст ошибки в error.message
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа не настроены токены

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

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