Register the Service ai.engine.register
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:
ai_adminWho can execute the method: administrator
The method ai.engine.register registers a custom AI service.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
name* |
The name of the service that will be displayed in the interface |
|
code* |
A unique code for the service. Only characters |
|
category* |
The category of the service. Possible values:
|
|
completions_url* |
The URL endpoint of the handler, which must respond with HTTP status |
|
settings |
Additional settings for the service (detailed description) |
Settings Parameter
The method accepts settings as a JSON object without a strict schema. The following fields are used in the service code:
|
Name |
Description |
|
code_alias |
The alias of the model. Defaults to |
|
model_context_type |
The method of calculating context. Possible values:
Defaults to |
|
model_context_limit |
The context limit. Defaults to |
Endpoint
completions_url must point to your endpoint that accepts requests from Bitrix24 and processes them in the expected format.
Attention!
The endpoint code from the examples can be used as a foundation, but for production, it's better to separate the processing into different parts of the application.
The template endpoint can be used as a basis for your own service.
Endpoint Requirements
- The endpoint must quickly accept the request and return a response or queue the task in its internal queue. The initial response time should not exceed 5 seconds — after the timeout, the connection is terminated.
- For the
imagecategory, processing should be done asynchronously. - The request payload includes
callbackUrlanderrorCallbackUrl. After processing, the result should be sent tocallbackUrl, and error information toerrorCallbackUrl. - The endpoint must correctly return HTTP statuses:
200— request processed immediately202— request accepted and queued503— service temporarily unavailable
The callbackUrl has a limited lifespan — it is provided in the ttl parameter (in seconds). If the endpoint does not send the result before this period expires, the link will become invalid, and the user will not receive a response.
Attention!
The endpoint's response to the initial request does not replace the callback mechanism. Upon successful acceptance of the request, the endpoint should return json_encode(['result' => 'OK']).
Features for the Audio Category
For the audio category, the prompt key receives an object with the following fields:
|
Name |
Description |
|
file |
Link to the file. The file may come without an extension |
|
fields |
Additional data about the file (detailed description) |
|
fileExtension |
The file extension, if it can be determined. May come as an empty string |
Fields Object
|
Name |
Description |
|
type |
Content-Type of the file. Especially important if the file is sent without an extension, e.g., |
|
prompt |
Auxiliary prompt for file recognition, e.g., company name |
Features for the Image Category
For the image category, the prompt key receives an object with the following fields:
|
Name |
Description |
|
prompt |
Text description of what needs to be generated |
|
style |
The style of image generation. May be absent if no style was specified |
|
format |
Image format, e.g., |
|
images_number |
The number of images to generate. May be absent if no value was specified |
Additional Fields in the Request to the Endpoint
|
Name |
Description |
|
auth |
Authorization data |
|
payload_raw |
Raw value of the prompt. When using BitrixGPT, this may contain the symbolic code of the used prompt |
|
payload_provider |
Symbolic code of the pre-prompt provider. When using BitrixGPT, this may contain |
|
payload_prompt_text |
If |
|
payload_markers |
Additional user markers used in prompt formation |
|
payload_role |
Role or instruction used in prompt formation. In GPT-like systems, this value is usually passed as a system message |
|
collect_context |
A flag indicating whether to pass context to the model |
|
context |
An array of previous messages in chronological order. The volume sent depends on the provider's settings and the type of context calculation |
|
max_tokens |
Maximum number of tokens in the response |
|
temperature |
A parameter that controls the degree of randomness of the output |
|
callbackUrl |
URL to which the result of successful processing should be sent |
|
errorCallbackUrl |
URL to which error information should be sent |
|
ttl |
The lifespan of the |
Context should only be passed to the model if the request includes collect_context = true. If the parameter is absent or set to false, context can be omitted.
Example structure of a message for a GPT-like model:
[
{
"role": "system",
"content": "$payload_role"
},
{
"role": "user",
"content": "$prompt"
}
]
Code Examples
How to Use Examples in Documentation
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 -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
// 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)
}
<!-- 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>
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 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}")
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.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());
}
}
);
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>';
// client and ctx are already created — see the Go SDK section
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("parse response: %w", err)
}
fmt.Println("result:", value)
Response Handling
HTTP Status: 200
{
"result": 12,
"time": {
"start": 1774078200,
"finish": 1774078200.315271,
"duration": 0.31527090072631836,
"processing": 0.02,
"date_start": "2026-03-20T09:50:00+02:00",
"date_finish": "2026-03-20T09:50:00+02:00",
"operating_reset_at": 1774078800,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the registered service |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "ENGINE_REGISTER_ERROR_CODE_UNIQUE",
"error_description": "A record with this `code` already exists."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
The |
The |
|
|
The |
The |
|
|
The |
Invalid characters are present in |
|
|
A record with this |
A service with this code is already registered in the same category |
|
|
The |
The |
|
|
The |
The provided |
|
|
The |
The |
|
|
The value of the |
The URL is unavailable, invalid, or returns a status other than |
|
|
The value of the |
The |
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 |