Создать документ note.document.add

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: note

Кто может выполнять метод: пользователь с доступом к модулю База знаний и правом «Редактирование» для нужной базы знаний

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.document.add создает новый документ в базе знаний и возвращает его объект.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
fields* `object`	Объект с полями нового документа. Описание структуры объекта

Параметр fields

Название `тип`	Описание
collectionId* `integer`	Идентификатор базы знаний. Идентификатор можно получить методом note.collection.list
title* `string`	Заголовок документа. Заголовок документа не должен превышать 255 символов
parentId `integer`	Идентификатор родительского документа. Идентификатор можно получить методом note.document.tree.list. Используйте, если нужно создать вложенный документ. Родительский документ должен принадлежать той же базе знаний, что и `collectionId`
markdown `string`	Начальное содержимое документа в Markdown. Максимальный размер: `1 048 576` байт

Примеры кода

Как использовать примеры в документации

Вызов нового api отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.document.add

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"collectionId":42,"title":"Глава 1","parentId":10,"markdown":"# Глава 1\n\nТекст документа"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"collectionId":42,"title":"Глава 1","parentId":10,"markdown":"# Глава 1\n\nТекст документа"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.add

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentAddResult = {
  item: {
    id: number
    collectionId: number | null
    parentId: number | null
    title: string
    markdown: string
    position: number
    createdBy: number
    updatedBy: number
    createdAt: string
    updatedAt: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentAddResult>({
    method: 'note.document.add',
    params: {
      fields: {
        collectionId: 42,
        title: 'Глава 1',
        parentId: 10,
        markdown: '# Глава 1\n\nТекст документа',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Document created:', result.item.id, result.item.title)
  }
} catch (error) {
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addDocument() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.document.add',
        params: {
          fields: {
            collectionId: 42,
            title: 'Глава 1',
            parentId: 10,
            markdown: '# Глава 1\n\nТекст документа',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Document created:', result.item.id, result.item.title)
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addDocument)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "collectionId": 42,
    "title": "Глава 1",
    "parentId": 10,
    "markdown": "# Глава 1\n\nТекст документа",
}

try:
    bitrix_response = client.note.document.add(
        fields=fields,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'note.document.add',
            [
                'fields' => [
                    'collectionId' => 42,
                    'title' => 'Глава 1',
                    'parentId' => 10,
                    'markdown' => "# Глава 1\n\nТекст документа",
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error creating document: ' . $e->getMessage();
}

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
    'note.document.add',
    {
        fields: {
            collectionId: 42,
            title: 'Глава 1',
            parentId: 10,
            markdown: '# Глава 1\n\nТекст документа'
        }
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');

$result = CRest::call(
    'note.document.add',
    [
        'fields' => [
            'collectionId' => 42,
            'title' => 'Глава 1',
            'parentId' => 10,
            'markdown' => "# Глава 1\n\nТекст документа"
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.document.add", b24.Params{
	"fields": b24.Params{
		"collectionId": 42,
		"title":        "Глава 1",
		"parentId":     10,
		"markdown":     "# Глава 1\n\nТекст документа",
	},
})
if err != nil {
	return fmt.Errorf("note.document.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID           b24.ID `json:"id"`
	CollectionID b24.ID `json:"collectionId"`
	ParentID     b24.ID `json:"parentId"`
	Title        string `json:"title"`
	Markdown     string `json:"markdown"`
	Position     int    `json:"position"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.CollectionID)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 77,
            "collectionId": 42,
            "parentId": 10,
            "title": "Глава 1",
            "markdown": "# Глава 1\n\nТекст в Markdown...",
            "position": 5,
            "createdBy": 1,
            "updatedBy": 1,
            "createdAt": "2026-04-20T12:00:00Z",
            "updatedAt": "2026-04-20T12:00:00Z"
        }
    },
    "time": {
        "start": 1780390800,
        "finish": 1780390800.214321,
        "duration": 0.21432113647460938,
        "processing": 0.17321419715881348,
        "date_start": "2026-06-16T12:00:00+03:00",
        "date_finish": "2026-06-16T12:00:00+03:00",
        "operating_reset_at": 1780391400,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Объект с результатом создания документа
item `object`	Объект созданного документа
id `integer`	Идентификатор созданного документа
collectionId `integer`	Идентификатор базы знаний
parentId `integer`	Идентификатор родительского документа или `null`
title `string`	Заголовок документа
markdown `string`	Содержимое документа в Markdown
position `integer`	Позиция документа среди соседних страниц
createdBy `integer`	Идентификатор автора документа
updatedBy `integer`	Идентификатор последнего редактора документа
createdAt `datetime`	Дата и время создания документа в UTC
updatedAt `datetime`	Дата и время последнего изменения документа в UTC
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Не заполнено обязательное поле \"title\"",
                "field": "title"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`fields`	Обязательное поле `fields` не указано	Добавьте объект `fields` в тело запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`collectionId` `title`	Не заполнено обязательное поле `#FIELD#`	Добавьте указанное поле в объект `fields`
`collectionId` `title` `parentId` `markdown`	В поле `#FIELD#` требуется тип данных `#TYPE#` для такого запроса	Убедитесь, что передаваемое значение нужного типа
`title`	Заголовок документа не может быть пустым	Передайте непустую строку в поле `fields.title`
`title`	Заголовок документа не должен превышать 255 символов	Сократите значение `fields.title`

Код ошибки: NOTE_MARKDOWN_TOO_LARGE

Поле	Описание ошибки	Как исправить
`markdown`	Содержимое документа слишком большое. Максимально допустимый размер — `1 048 576` байт	Сократите содержимое `fields.markdown`

Код ошибки: NOTE_INVALID_PARENT

Поле	Описание ошибки	Как исправить
`parentId`	Родительский документ не принадлежит указанной коллекции	Укажите `fields.parentId` документа из той же базы знаний, что и `fields.collectionId`, или не передавайте `fields.parentId`

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	У пользователя нет доступа к модулю База знаний или права создавать документы в указанной базе знаний

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`collectionId`	База знаний не найдена	Проверьте, что база знаний существует и доступна пользователю

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Обзор методов

Обновить документ

Создать документ note.document.add

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Ошибки валидации запросаОшибки валидации запроса

Ошибки доступаОшибки доступа

Ошибка отсутствия объектаОшибка отсутствия объекта

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Параметры метода

Параметр fields

Примеры кода

Обработка ответа

Возвращаемые данные

Обработка ошибок

Возможные коды ошибок

Ошибки валидации запроса

Ошибки доступа

Ошибка отсутствия объекта

Статусы и коды системных ошибок

Продолжите изучение