Upload a File to Document note.file.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: note

Who can execute the method: a user with access to the Knowledge base module and "Edit" permissions for the document 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.file.add method uploads a file to a document and returns a file object.

The method does not automatically insert the attachment into the document content. It only saves the file and links it to the document.

Method Parameters

Required parameters are marked with *

Name
type

Description

documentId*
integer

Identifier of the document to which the file should be attached.

The identifier can be obtained using the note.document.tree.list method

fileName*
string

File name with extension.

Allowed extensions: png, jpg, jpeg, gif, webp, svg, pdf, txt, md, csv, doc, docx, xls, xlsx, ppt, pptx, mp4, webm, mov

fileContent*
string

Binary file content in Base64 encoding.

The maximum file size depends on the main.max_file_size setting in Bitrix24. If it is not set, the 25 MiB (25 * 1024 * 1024 bytes) limit is used

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.file.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"documentId":77,"fileName":"diagram.png","fileContent":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"documentId":77,"fileName":"diagram.png","fileContent":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/note.file.add
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type FileAddResult = {
          item: {
            id: number
            documentId: number
            name: string
            size: number
            mimeType: string
            assetType: string
            assetMarkdown: string
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<FileAddResult>({
            method: 'note.file.add',
            params: {
              documentId: 77,
              fileName: 'diagram.png',
              fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('File uploaded:', result.item.id, result.item.assetMarkdown)
          }
        } catch (error) {
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addFile() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'note.file.add',
                params: {
                  documentId: 77,
                  fileName: 'diagram.png',
                  fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('File uploaded:', result.item.id, result.item.assetMarkdown)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addFile)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.note.file.add(
                document_id=77,
                file_name='diagram.png',
                file_content='iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
            ).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.file.add',
                    [
                        'documentId' => 77,
                        'fileName' => 'diagram.png',
                        'fileContent' => 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error uploading file: ' . $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.file.add',
            {
                documentId: 77,
                fileName: 'diagram.png',
                fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII='
            },
            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.file.add',
            [
                'documentId' => 77,
                'fileName' => 'diagram.png',
                'fileContent' => 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII='
            ]
        );
        
        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.file.add", b24.Params{
        	"documentId":  77,
        	"fileName":    "diagram.png",
        	"fileContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=",
        })
        if err != nil {
        	return fmt.Errorf("note.file.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"`
        	DocumentID b24.ID `json:"documentId"`
        	Name       string `json:"name"`
        	Size       int    `json:"size"`
        	MimeType   string `json:"mimeType"`
        	AssetType  string `json:"assetType"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.DocumentID)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 5001,
                    "documentId": 77,
                    "name": "diagram.png",
                    "size": 6321,
                    "mimeType": "image/png",
                    "assetType": "image",
                    "assetMarkdown": "[[image fileId=5001]]"
                }
            },
            "time": {
                "start": 1780392000,
                "finish": 1780392000.284521,
                "duration": 0.28452086448669434,
                "processing": 0.2413930892944336,
                "date_start": "2026-06-16T12:20:00+03:00",
                "date_finish": "2026-06-16T12:20:00+03:00",
                "operating_reset_at": 1780392600,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the file upload result

item
object

Object of the uploaded file

id
integer

Identifier of the uploaded file

documentId
integer

Identifier of the document to which the file is attached

name
string

File name

size
integer

File size in bytes

mimeType
string

File MIME type

assetType
string

Attachment type for the Markdown block

assetMarkdown
string

Ready-to-use Markdown block for inserting the file into a document via note.document.update.

Before inserting an image or video, you can extend the block with scale and alignment parameters. For details, see the markdown field description in note.document.update

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error during request object validation",
                "validation": [
                    {
                        "message": "invalid base64 payload",
                        "field": "fileContent"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

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

documentId
fileName
fileContent

Required field #FIELD# is not specified

Add the specified field to the request body

documentId
fileName
fileContent

The field #FIELD# requires data type #TYPE# for this request

Ensure the provided value is of the correct type

fileContent

Incorrect Base64 content provided

Please ensure that fileContent contains a non-empty Base64 string without corrupted characters

fileContent

Failed to save the file

Retry the request later or check the correctness of the provided data

Error Code: NOTE_FILE_TOO_LARGE

Field

Error description

How to Fix

fileContent

File size exceeds the allowed value

Reduce the file size or change the main.max_file_size setting in Bitrix24

Error Code: NOTE_FILE_TYPE_NOT_ALLOWED

Field

Error description

How to Fix

fileName

File type is not supported

Use a file with an allowed extension

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 permissions to edit the document

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

documentId

Document not found

Please ensure that the document exists, is not archived, and is not in the trash

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning