Get the List of Services ai.engine.list
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.list returns a list of registered AI services.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter |
An array in the following format:
where:
You can add a prefix to the keys
The list of fields available for filtering is provided in the section (detailed description) |
|
limit |
Maximum number of elements in the response |
Filter Parameter
|
Name |
Description |
|
ID |
Service identifier |
|
APP_CODE |
Application code to which the service belongs. Without application context, such as through a webhook, you can filter by any In the context of an OAuth application, the method always shows only the services of the current application |
|
NAME |
Service name |
|
CODE |
Symbolic code of the service |
|
CATEGORY |
Service category |
|
COMPLETIONS_URL |
Service endpoint URL |
|
DATE_CREATE |
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 -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
// 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)
}
<!-- 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>
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 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.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>';
// client and ctx are already created — see the Go SDK section
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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.AppCode)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
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 |
Description |
|
result |
An array of registered services (detailed description) |
|
time |
Information about the request execution time |
Service Object
|
Name |
Description |
|
id |
Service identifier |
|
app_code |
Application code to which the service belongs. May return |
|
name |
Service name |
|
code |
Symbolic code of the service |
|
category |
Service category |
|
completions_url |
Service endpoint URL |
|
settings |
Service settings saved during registration |
|
date_create |
Service creation date in Unix Timestamp format |
Error Handling
|
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 |
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 |