Получить список сервисов ai.engine.list
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
ai_adminКто может выполнять метод: администратор
Метод ai.engine.list возвращает список зарегистрированных AI-сервисов.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter |
Массив формата: где:
К ключам
Список доступных для фильтрации полей приведен в разделе (подробное описание) |
|
limit |
Максимальное количество элементов в ответе |
Параметр filter
|
Название |
Описание |
|
ID |
Идентификатор сервиса |
|
APP_CODE |
Код приложения, которому принадлежит сервис. Без контекста приложения, например через вебхук, можно фильтровать по любому В контексте OAuth-приложения метод всегда показывает только сервисы текущего приложения |
|
NAME |
Название сервиса |
|
CODE |
Символьный код сервиса |
|
CATEGORY |
Категория сервиса |
|
COMPLETIONS_URL |
URL endpoint сервиса |
|
DATE_CREATE |
Дата и время создания сервиса в формате ISO 8601, например 2026-03-20T09:50:00+03:00 |
Примеры кода
Как использовать примеры в документации
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>';
Обработка ответа
HTTP-статус: 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
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив зарегистрированных сервисов (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект сервиса
|
Название |
Описание |
|
id |
Идентификатор сервиса |
|
app_code |
Код приложения, которому принадлежит сервис. Может вернуть |
|
name |
Название сервиса |
|
code |
Символьный код сервиса |
|
category |
Категория сервиса |
|
completions_url |
URL endpoint сервиса |
|
settings |
Настройки сервиса, сохраненные при регистрации |
|
date_create |
Дата создания сервиса в формате Unix Timestamp |
Обработка ошибок
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |