# ai.engine.register

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

Зарегистрировать сервис
Scope: `ai_admin`
Кто может выполнять метод: администратор

## Описание

Метод `ai.engine.register` регистрирует пользовательский AI-сервис.

## Параметры

- `name` `string` — обязательный. Название сервиса, которое будет отображаться в интерфейсе
- `code` `string` — обязательный. Уникальный код сервиса.
  Допустимы только символы `A-Za-z0-9-_`
- `category` `string` — обязательный. Категория сервиса.
  Возможные значения:
  - `text`
  - `image`
  - `audio`
  - `call`
- `completions_url` `string` — обязательный. URL endpoint обработчика, который должен отвечать HTTP-статусом `200` при проверке регистрации [(подробное описание)](#endpoint)
- `settings` `object` — необязательный. Дополнительные настройки сервиса [(подробное описание)](#settings)

### Параметр settings

- `code_alias` `string` — необязательный. Псевдоним модели.
  По умолчанию используется `ChatGPT`
- `model_context_type` `string` — необязательный. Способ подсчета контекста.
  Возможные значения:
  - `token`
  - `symbol`
  По умолчанию используется `token`
- `model_context_limit` `integer` — необязательный. Лимит контекста.
  По умолчанию используется `15666`

## Ответ

HTTP-статус: 200

```json
{
    "result": 12,
    "time": {
        "start": 1774078200,
        "finish": 1774078200.315271,
        "duration": 0.31527090072631836,
        "processing": 0.02,
        "date_start": "2026-03-20T09:50:00+03:00",
        "date_finish": "2026-03-20T09:50:00+03:00",
        "operating_reset_at": 1774078800,
        "operating": 0
    }
}
```

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

- `result` `integer`. Идентификатор зарегистрированного сервиса
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ENGINE_REGISTER_ERROR_CODE_UNIQUE",
    "error_description": "Запись с таким `code` уже существует."
}
```

- `ENGINE_REGISTER_ERROR_NAME` — Ключ `name` со строковым значением обязателен. Не передан параметр `name`, передано пустое значение или значение не является строкой
- `ENGINE_REGISTER_ERROR_CODE` — Ключ `code` со строковым значением обязателен. Не передан параметр `code`, передано пустое значение или значение не является строкой
- `ENGINE_REGISTER_ERROR_CODE_FORMAT` — Ключ `code` должен содержать только символы `A-Za-z0-9-_`. В `code` переданы недопустимые символы
- `ENGINE_REGISTER_ERROR_CODE_UNIQUE` — Запись с таким `code` уже существует. Сервис с таким кодом уже зарегистрирован в той же категории
- `ENGINE_REGISTER_ERROR_CATEGORY` — Ключ `category` обязателен. Не передан параметр `category` или передано пустое значение
- `ENGINE_REGISTER_ERROR_CATEGORY_FORMAT` — Ключ `category` может содержать одно из значений: `text, image, audio, call`. Передано значение `category`, которого нет в списке доступных категорий
- `ENGINE_REGISTER_ERROR_COMPLETIONS_URL` — Ключ `completions_url` со строковым значением обязателен. Не передан параметр `completions_url`, передано пустое значение или значение не является строкой
- `ENGINE_REGISTER_ERROR_COMPLETIONS_URL_FAIL` — Значением ключа `completions_url` должен быть валидный URL , который при проверке возвращает статус `200`. URL недоступен, невалиден или при проверке возвращает статус, отличный от `200`
- `ENGINE_REGISTER_ERROR_SETTINGS_FORMAT` — Значением ключа `settings` должен быть валидный JSON. Параметр `settings` передан не в виде объекта

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

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Acme GPT",
    "code": "acme_gpt",
    "category": "text",
    "completions_url": "https://api.example.com/bitrix24/ai/completions",
    "settings": {
      "code_alias": "ChatGPT",
      "model_context_type": "token",
      "model_context_limit": 15666
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_webhook_id**/**put_your_webhook_code**/ai.engine.register.json
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Acme GPT",
    "code": "acme_gpt",
    "category": "text",
    "completions_url": "https://api.example.com/bitrix24/ai/completions",
    "settings": {
      "code_alias": "ChatGPT",
      "model_context_type": "token",
      "model_context_limit": 15666
    },
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/ai.engine.register
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<number>({
    method: 'ai.engine.register',
    params: {
      name: 'Acme GPT',
      code: 'acme_gpt',
      category: 'text',
      completions_url: 'https://api.example.com/bitrix24/ai/completions',
      settings: {
        code_alias: 'ChatGPT',
        model_context_type: 'token',
        model_context_limit: 15666,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Registered AI engine ID:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function registerAiEngine() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'ai.engine.register',
        params: {
          name: 'Acme GPT',
          code: 'acme_gpt',
          category: 'text',
          completions_url: 'https://api.example.com/bitrix24/ai/completions',
          settings: {
            code_alias: 'ChatGPT',
            model_context_type: 'token',
            model_context_limit: 15666,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Registered AI engine ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.ai.engine.register(
        name='Acme GPT',
        code='acme_gpt',
        category='text',
        completions_url='https://api.example.com/bitrix24/ai/completions',
        settings={
            "code_alias": "ChatGPT",
            "model_context_type": "token",
            "model_context_limit": 15666,
        },
    ).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(
            'ai.engine.register',
            [
                'name' => 'Acme GPT',
                'code' => 'acme_gpt',
                'category' => 'text',
                'completions_url' => 'https://api.example.com/bitrix24/ai/completions',
                'settings' => [
                    'code_alias' => 'ChatGPT',
                    'model_context_type' => 'token',
                    'model_context_limit' => 15666,
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error registering AI engine: ' . $e->getMessage();
}
```

### BX24.js

```javascript
BX24.callMethod(
    'ai.engine.register',
    {
        name: 'Acme GPT',
        code: 'acme_gpt',
        category: 'text',
        completions_url: 'https://api.example.com/bitrix24/ai/completions',
        settings: {
            code_alias: 'ChatGPT',
            model_context_type: 'token',
            model_context_limit: 15666
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error(), result.error_description());
        }
        else
        {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

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

$result = CRest::call(
    'ai.engine.register',
    [
        'name' => 'Acme GPT',
        'code' => 'acme_gpt',
        'category' => 'text',
        'completions_url' => 'https://api.example.com/bitrix24/ai/completions',
        'settings' => [
            'code_alias' => 'ChatGPT',
            'model_context_type' => 'token',
            'model_context_limit' => 15666,
        ],
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "ai.engine.register", b24.Params{
	"name":            "Acme GPT",
	"code":            "acme_gpt",
	"category":        "text",
	"completions_url": "https://api.example.com/bitrix24/ai/completions",
	"settings": b24.Params{
		"code_alias":          "ChatGPT",
		"model_context_type":  "token",
		"model_context_limit": 15666,
	},
})
if err != nil {
	return fmt.Errorf("ai.engine.register: %w", err)
}

var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("результат:", value)
```

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