метод REST scope: ai_admin

ai.engine.list

Получить список сервисов

Кто может выполнять: администратор

Описание

Метод 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, аналогично =%
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

Список доступных для фильтрации полей приведен в разделе (подробное описание)

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

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

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

Ответ

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 array

Массив зарегистрированных сервисов (подробное описание)

time time

Информация о времени выполнения запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.