# ai.engine.list

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

Получить список сервисов
Scope: `ai_admin`
Кто может выполнять метод: администратор

## Описание

Метод `ai.engine.list` возвращает список зарегистрированных AI-сервисов.

## Параметры

- `filter` `array` — необязательный. Массив формата:
  ```
  {
      field_1: value_1,
      field_2: value_2,
      ...,
      field_n: value_n,
  }
  ```
  где:
  - `field_n` — название поля, по которому будет произведена фильтрация
  - `value_n` — значение фильтра
  К ключам `field_n` можно добавить префикс, уточняющий работу фильтра.
  Возможные значения префикса:
  - `>=` — больше либо равно
  - `>` — больше
  - `<=` — меньше либо равно
  - `<` — меньше
  - `@` — IN, в качестве значения передается массив
  - `!@` — NOT IN, в качестве значения передается массив
  - `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  - `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - `"мол%"` — ищет значения, начинающиеся с «мол»
      - `"%мол"` — ищет значения, заканчивающиеся на «мол»
      - `"%мол%"` — ищет значения, где «мол» может быть в любой позиции
  - `%=` — LIKE, аналогично `=%`
  - `=` — равно, точное совпадение (используется по умолчанию)
  - `!=` — не равно
  - `!` — не равно
  Список доступных для фильтрации полей приведен в разделе [(подробное описание)](#filter)
- `limit` `integer` — необязательный. Максимальное количество элементов в ответе

### Параметр filter

- `ID` `integer` — необязательный. Идентификатор сервиса
- `APP_CODE` `string` — необязательный. Код приложения, которому принадлежит сервис.
  Без контекста приложения, например через вебхук, можно фильтровать по любому `APP_CODE`.
  В контексте OAuth-приложения метод всегда показывает только сервисы текущего приложения
- `NAME` `string` — необязательный. Название сервиса
- `CODE` `string` — необязательный. Символьный код сервиса
- `CATEGORY` `string` — необязательный. Категория сервиса
- `COMPLETIONS_URL` `string` — необязательный. URL endpoint сервиса
- `DATE_CREATE` `datetime` — необязательный. Дата и время создания сервиса в формате ISO 8601, например 2026-03-20T09:50:00+03:00

## Ответ

HTTP-статус: 200

```json
{
    "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` `array`. Массив зарегистрированных сервисов [(подробное описание)](#engine-item)
- `time` `time`. Информация о времени выполнения запроса

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

### cURL (Webhook)

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

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

### 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

// Shape of each AiEngineItem returned in result[]
type AiEngineItem = {
  id: number
  app_code: string | null
  name: string
  code: string
  category: string
  completions_url: string
  settings: Record<string, unknown>
  date_create: number
}

try {
  // ai.engine.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<AiEngineItem[]>({
    method: 'ai.engine.list',
    params: {
      filter: {
        '=CATEGORY': 'text',
      },
      limit: 2,
      start: 0,
    },
    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('AI engines found:', result.length, result[0]?.name)
  }
} 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 fetchAiEngines() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // ai.engine.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'ai.engine.list',
        params: {
          filter: {
            '=CATEGORY': 'text',
          },
          limit: 2,
          start: 0,
        },
        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('AI engines found:', result.length, result[0]?.name)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.ai.engine.list(
        filter={
            "=CATEGORY": "text",
        },
        limit=2,
    ).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.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.js

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

### PHP CRest

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

$result = CRest::call(
    'ai.engine.list',
    [
        'filter' => [
            '=CATEGORY' => 'text',
        ],
        'limit' => 2,
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "ai.engine.list", b24.Params{
	"filter": b24.Params{
		"=CATEGORY": "text",
	},
	"limit": 2,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("ai.engine.list: %w", err)
}

var items []struct {
	ID             b24.ID `json:"id"`
	AppCode        string `json:"app_code"`
	Name           string `json:"name"`
	Code           string `json:"code"`
	Category       string `json:"category"`
	CompletionsURL string `json:"completions_url"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.AppCode)
}

// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
	fmt.Println("всего:", *res.Total)
}
```

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