Get the List of Services ai.engine.list

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: ai_admin

Who can execute the method: administrator

The method ai.engine.list returns a list of registered AI services.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter
array

An array in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — the name of the field to filter by
value_n — the filter value

You can add a prefix to the keys field_n to specify the filter operation.
Possible prefix values:

>= — greater than or equal to
> — greater than
<= — less than or equal to
< — less than
@ — IN, an array is passed as the value
!@ — NOT IN, an array is passed as the value
% — LIKE, substring search. The % symbol should not be included in the filter value. The search looks for the substring in any position of the string
=% — LIKE, substring search. The % symbol should be included in the value. Examples:
- "mol%" — searches for values starting with "mol"
- "%mol" — searches for values ending with "mol"
- "%mol%" — searches for values where "mol" can be in any position
%= — LIKE, similar to =%
= — equals, exact match (used by default)
!= — not equal
! — not equal

The list of fields available for filtering is provided in the section (detailed description)

limit
integer

Maximum number of elements in the response

Filter Parameter

Name `type`	Description
ID `integer`	Service identifier
APP_CODE `string`	Application code to which the service belongs. Without application context, such as through a webhook, you can filter by any `APP_CODE`. In the context of an OAuth application, the method always shows only the services of the current application
NAME `string`	Service name
CODE `string`	Symbolic code of the service
CATEGORY `string`	Service category
COMPLETIONS_URL `string`	Service endpoint URL
DATE_CREATE `datetime`	Date and time of service creation in ISO 8601 format, e.g., 2026-03-20T09:50:00+03:00

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "filter": {
              "=CATEGORY": "text"
            },
            "limit": 2
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_webhook_id**/**put_your_webhook_code**/ai.engine.list.json

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "filter": {
              "=CATEGORY": "text"
            },
            "limit": 2,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/ai.engine.list

try
        {
            const response = await $b24.callMethod(
                'ai.engine.list',
                {
                    filter: {
                        '=CATEGORY': 'text'
                    },
                    limit: 2
                }
            );
        
            const result = response.getData().result;
            console.log('Engines:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'ai.engine.list',
                    [
                        'filter' => [
                            '=CATEGORY' => 'text',
                        ],
                        'limit' => 2,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting AI engine list: ' . $e->getMessage();
        }

BX24.callMethod(
            'ai.engine.list',
            {
                filter: {
                    '=CATEGORY': 'text'
                },
                limit: 2
            },
            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.list',
            [
                'filter' => [
                    '=CATEGORY' => 'text',
                ],
                'limit' => 2,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "id": 12,
                    "app_code": "rest_app_123456",
                    "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
                    },
                    "date_create": 1774078200
                }
            ],
            "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
            }
        }

Returned Data

Name `type`	Description
result `array`	An array of registered services (detailed description)
time `time`	Information about the request execution time

Service Object

Name `type`	Description
id `integer`	Service identifier
app_code `string`	Application code to which the service belongs. May return `null` if the value is not set
name `string`	Service name
code `string`	Symbolic code of the service
category `string`	Service category
completions_url `string`	Service endpoint URL
settings `object`	Service settings saved during registration
date_create `integer`	Service creation date in Unix Timestamp format

Error Handling

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Unregister Service

Get the List of Services ai.engine.list

Method ParametersMethod Parameters

Filter ParameterFilter Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Service ObjectService Object

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning