CKEditor AI Integration

The CKEditor AI integration within the ADITO platform empowers users to efficiently generate, transform, and enhance textual content directly in the editor using natural language inputs. By leveraging either an external AI service (e.g., OpenAI) or our in-house AI model, the integration delivers advanced capabilities such as content summarization, translation, rewriting for clarity or tone, and text generation. This functionality supports both freeform natural-language requests and predefined reusable commands, thereby enhancing productivity and writing quality across diverse use cases.

Key benefits of the AI Assistant include:

Efficient content summarization
Accurate text translation
Context-aware rewriting for improved clarity or tone
Intelligent text continuation and suggestion generation

This documentation provides a step-by-step guide to configuring and enabling the CKEditor AI features within the ADITO platform.

📎 CKEditor AI Assistant Demo

Features

AI Assistant
Allows freeform input for natural-language requests applied to the entire document or selected text.
AI Commands
Supports predefined, reusable prompts enabling rapid text transformations.

Creating an AI Alias

To define a new AI alias in your project:

Right-click the alias folder in your project tree.
Select New and then select the AI type.
Deploy the project changes to activate the alias.

Create AI Alias.png
Figure: Creating an AI alias

Configuring the AI Alias

A new configuration entry becomes available under System Configuration.

Right-click and select Create.
In the properties tool window, specify the following:

Figure: Creating alias configuration entry

Required Properties

Property	Description
endpointUrl	Endpoint URL for AI requests
token	API key for authenticating requests
requestParameters	JSON object specifying parameters for the AI endpoint

For detailed AI provider configuration options, see the AI Provider Configuration section below.

Figure: Alias properties configuration

tip

An AI alias must be created in order to use any AI features in the client.

Enabling AI Features in CKEditor

Use the Project Preferences (XML Editor) to enable and customize CKEditor AI features. These settings are intended for advanced users.

Figure: Configuring expert-level AI properties

Properties

Property	Description
ckeditorAIAlias	Reference to the AI alias containing URL, token, and parameters
ckeditorAIAssistantEnabled	Enables the AI Assistant for freeform natural-language requests
ckeditorTextAdapterEnabled	Enables the Text Adapter for command-based text transformations
ckeditorAICommands	JSON array defining custom AI commands (overrides default commands)

tip

An alias must be configured in order to use the AI features in the editor. Otherwise no features will be available.

Example: Custom Command Set

[
  {
    "groupId": "customGroupId",
    "groupLabel": "My Group of Commands",
    "commands": [
      {
        "id": "translateSpanish",
        "label": "Translate to Spanish",
        "prompt": "Translate this text to Spanish."
      },
      {
        "id": "explainFive",
        "label": "Explain Like I'm Five",
        "prompt": "Explain this like I'm five years old."
      }
    ]
  }
]

tip

For detailed information on official API integration, refer to the CKEditor AI Assistant Documentation.

Permissions

Only users with the INTERNAL_AI role will be able to see and use the AI features of the CKEditor. (since core version 2025.1.1)

After restarting the system, AI features become accessible directly within the CKEditor toolbar.

Figure: CKEditor toolbar with AI features enabled

info

Ensure that the AI alias is properly configured and the project has been redeployed for the AI features to appear in the toolbar.

AI Provider Configuration

ADITO AI Model Configuration

To use the internal ADITO AI model, configure the AI alias with the following values:

Property	Value
`endpointUrl`	`https://ai.adito.cloud:443/openai/v1`
`token`	`<your-adito-api-key>`
`requestParameters`	See JSON configuration below

{
  "model": "adito-llm",
  "temperature": 0.15,
  "stream": true
}

OpenAI Configuration

To use OpenAI as the AI provider, configure the AI alias with the following values:

Property	Value
`endpointUrl`	`https://api.openai.com/v1/chat/completions`
`token`	`<your-openai-api-key>`
`requestParameters`	See JSON configuration below

{
  "model": "gpt-3.5-turbo",
  "max_tokens": 2000,
  "temperature": 1,
  "top_p": 1,
  "stream": true
}

tip

Ensure that your API key has access to the required OpenAI model and enough usage quota.

Features​

Creating an AI Alias​

Configuring the AI Alias​

Required Properties​

Enabling AI Features in CKEditor​

Properties​

Example: Custom Command Set​

Permissions​

CKEditor Toolbar Integration​

AI Provider Configuration​

ADITO AI Model Configuration​

OpenAI Configuration​