Create Document note.document.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
noteWho can execute the method: a user with access to the Knowledge base module and "Edit" permissions for the required knowledge base
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The note.document.add method creates a new document in the knowledge base and returns its object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new document. Object structure description |
Parameter fields
|
Name |
Description |
|
collectionId* |
Knowledge base identifier. The identifier can be obtained using the note.collection.list method. |
|
title* |
Document title. The document title must not exceed 255 characters. |
|
parentId |
Parent document identifier. The identifier can be obtained using the note.document.tree.list method. Use this if you need to create a nested document. The parent document must belong to the same knowledge base as |
|
markdown |
Initial document content in Markdown. Maximum size: |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/note.document.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"collectionId":42,"title":"Chapter 1","parentId":10,"markdown":"# Chapter 1\N\nDocument Text"}}' \
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":"Chapter 1","parentId":10,"markdown":"# Chapter 1\N\nDocument Text"},"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: 'Chapter 1',
parentId: 10,
markdown: '# Chapter 1\N\nDocument Text',
},
},
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: 'Chapter 1',
parentId: 10,
markdown: '# Chapter 1\N\nDocument Text',
},
},
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": "Chapter 1",
"parentId": 10,
"markdown": "# Chapter 1\n\nDocument text",
}
try:
bitrix_response = client.note.document.add(
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'note.document.add',
[
'fields' => [
'collectionId' => 42,
'title' => 'Chapter 1',
'parentId' => 10,
'markdown' => "# Chapter 1\N\nDocument Text",
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating document: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'note.document.add',
{
fields: {
collectionId: 42,
title: 'Chapter 1',
parentId: 10,
markdown: '# Chapter 1\N\nDocument Text'
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'note.document.add',
[
'fields' => [
'collectionId' => 42,
'title' => 'Chapter 1',
'parentId' => 10,
'markdown' => "# Chapter 1\N\nDocument Text"
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "note.document.add", b24.Params{
"fields": b24.Params{
"collectionId": 42,
"title": "Chapter 1",
"parentId": 10,
"markdown": "# Chapter 1\N\nDocument Text",
},
})
if err != nil {
return fmt.Errorf("note.document.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.ID, item.CollectionID)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 77,
"collectionId": 42,
"parentId": 10,
"title": "Chapter 1",
"markdown": "
# Chapter 1\N\nText in 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
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the document creation result. |
|
item |
Created document object. |
|
id |
Identifier of the created document |
|
collectionId |
Knowledge base identifier. |
|
parentId |
Parent document identifier or |
|
title |
Document title. |
|
markdown |
Document content in Markdown. |
|
position |
Document position among neighboring pages. |
|
createdBy |
Identifier of the document author |
|
updatedBy |
Last document editor identifier. |
|
createdAt |
Document creation date and time in UTC. |
|
updatedAt |
Document last modification date and time in UTC. |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Object validation error",
"validation": [
{
"message": "Mandatory field \"title\" is not filled",
"field": "title"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Add the |
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Add the specified field to the |
|
|
The field |
Ensure the provided value is of the correct type |
|
|
Document title cannot be empty. |
Pass a non-empty string in the |
|
|
Document title must not exceed 255 characters. |
Shorten the |
Error Code: NOTE_MARKDOWN_TOO_LARGE
|
Field |
Error description |
How to Fix |
|
|
Document content is too large. The maximum allowed size is |
Shorten the |
Error Code: NOTE_INVALID_PARENT
|
Field |
Error description |
How to Fix |
|
|
The parent document does not belong to the specified collection. |
Specify the |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied. |
The user does not have access to the Knowledge Base module or the permissions to create documents in the specified knowledge base. |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Knowledge base not found. |
Please check that the knowledge base exists and is accessible to the user. |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |