AI in Bitrix24: Overview of Methods

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.

The ai section helps connect your own AI service to Bitrix24. The methods in this section allow you to register new services, retrieve their list, and remove selected ones.

Important

Before registration, check the availability of the external handler URL in the completions_url parameter and the requirements for processing requests.

Quick navigation: all methods

What to Consider Before Registration

  • Specify a valid URL in completions_url that returns an HTTP status of 200 upon verification.

  • For the image category, use asynchronous processing.

  • Choose the category value based on the service scenario: text, image, audio, or call.

  • Pass additional parameters in settings.

How to Get Started

  1. Prepare the external endpoint.

  2. Register the service via ai.engine.register.

  3. Verify the registration and service parameters through ai.engine.list.

  4. Remove the service via ai.engine.unregister if it is no longer needed.

How Integration Works

Endpoint. The application sends requests from Bitrix24 to the external endpoint via completions_url.

Callback Mechanism. After processing, the service sends the result to callbackUrl and error information to errorCallbackUrl.

Endpoint Template

You can use this template as a basis for your own service.

Download Template

Connection with the Application and Access

Application. The service is linked to the application via the APP_CODE field. This can be obtained in the response from the ai.engine.list method. In the context of an OAuth application, the list contains only the services of the current application.

Webhook. You can filter services by any APP_CODE through the webhook.

Overview of Methods

Scope: ai_admin

Who can execute the method: administrator

Method

Description

ai.engine.register

Registers a custom AI service

ai.engine.list

Retrieves a list of registered AI services

ai.engine.unregister

Removes a registered AI service
Previous
When Deleting an Automation Rule
Next
Register Service