# note.file.add

URL: https://chugunov.pro/api-bitrix24/note/file/note-file-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

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

## Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](https://chugunov.pro/api-bitrix24/rest-v3/).

Метод `note.file.add` загружает файл в документ и возвращает объект файла.

Метод не вставляет вложение в содержимое документа автоматически. Он только сохраняет файл и привязывает его к документу.

## Параметры

- `documentId` `integer` — обязательный. Идентификатор документа, к которому нужно привязать файл.
  Идентификатор можно получить методом [note.document.tree.list](https://chugunov.pro/api-bitrix24/note/document/note-document-tree-list/)
- `fileName` `string` — обязательный. Имя файла с расширением.
  Допустимые расширения: `png`, `jpg`, `jpeg`, `gif`, `webp`, `svg`, `pdf`, `txt`, `md`, `csv`, `doc`, `docx`, `xls`, `xlsx`, `ppt`, `pptx`, `mp4`, `webm`, `mov`
- `fileContent` `string` — обязательный. Бинарное содержимое файла в кодировке [Base64](https://apidocs.bitrix24.ru/api-reference/files/how-to-upload-files.html).
  Максимальный размер файла зависит от настройки `main.max_file_size` в Битрикс24. Если она не задана, используется ограничение `25 МиБ (25 * 1024 * 1024 байт)`

## Ответ

HTTP-статус: 200

```json
{
    "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
    }
}
```

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

- `result` `object`. Объект с результатом загрузки файла
- `item` `object`. Объект загруженного файла
- `id` `integer`. Идентификатор загруженного файла
- `documentId` `integer`. Идентификатор документа, к которому привязан файл
- `name` `string`. Имя файла
- `size` `integer`. Размер файла в байтах
- `mimeType` `string`. MIME-тип файла
- `assetType` `string`. Тип вложения для Markdown-блока
- `assetMarkdown` `string`. Готовый Markdown-блок для вставки файла в документ через [note.document.update](https://chugunov.pro/api-bitrix24/note/document/note-document-update/).
  Перед вставкой изображения или видео блок можно дополнить параметрами масштаба и выравнивания. Подробнее о параметрах читайте в описании поля `markdown` метода [note.document.update](https://chugunov.pro/api-bitrix24/note/document/note-document-update/)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "invalid base64 payload",
                "field": "fileContent"
            }
        ]
    }
}
```

- `Поле` — **Описание ошибки**. **Как исправить**
- `documentId fileName fileContent` — Обязательное поле `#FIELD#` не указано. Добавьте указанное поле в тело запроса
- `documentId fileName fileContent` — В поле `#FIELD#` требуется тип данных `#TYPE#` для такого запроса. Убедитесь, что передаваемое значение нужного типа
- `fileContent` — Передано некорректное содержимое Base64. Проверьте, что `fileContent` содержит непустую Base64-строку без поврежденных символов
- `fileContent` — Не удалось сохранить файл. Повторите запрос позже или проверьте корректность передаваемых данных

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
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)
}
```

### JS (UMD)

```html
<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>
```

### Python

```python
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",
        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}")
```

### PHP

```php
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();
}
```

### BX24.js

```js
BX24.callMethod(
    'note.file.add',
    {
        documentId: 77,
        fileName: 'diagram.png',
        fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII='
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'note.file.add',
    [
        'documentId' => 77,
        'fileName' => 'diagram.png',
        'fileContent' => 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII='
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
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)
}

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

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("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.DocumentID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/note/file/note-file-add.html