CKEditor AI Writing Agent

This module is part of the AI module ecosystem and included in DXPR CMS.

Transform CKEditor 5 into an AI-powered content creation platform with slash commands, real-time streaming, and support for 400+ AI models. Like ChatGPT but faster, and better at creating HTML content. Built on DXPR's CKEditor 5 AI plugin.

You need CKEditor AI Agent if

• You want AI-powered content generation directly within your text editor
• Your content team needs faster, more efficient writing workflows
• You want to integrate external web content seamlessly into your articles
• You need support for multiple AI providers with automatic failover
• You prefer intuitive slash commands over complex AI interfaces

Features

• Slash commands: Quickly trigger AI actions using intuitive commands like /write blog about AI
• Real-time streaming: See AI-generated content appear instantly as it's written
• Web content integration: Includes content from user-provided URLs directly into generated text
• Context-aware writing: Automatically uses surrounding editor content to enhance response accuracy
• Selection-based edits: Select text to quickly revise with AI
• 400+ AI models support: Works with commercial and open source AI vendors via the Drupal AI module
• Secure server-side proxy: AI requests are routed through Drupal; API keys are never exposed to the browser
• Smart formatting: Automatically ensures generated HTML matches your editor's allowed content
• Multilingual support: Fully supports Drupal's multilingual content features
• Simple menu options: Easily edit, review, fix errors, and adjust tone from dropdown menus
• Extensible API: Clearly defined API for integration with custom workflows or systems

Keyboard Shortcuts

• / - Open AI Command Menu in empty field
• Cmd/Ctrl + / - Force insert slash command within text
• Cmd/Ctrl + Backspace - Cancel AI generation
• Enter - Execute command
• Shift + Enter - Add new line in command

Post-installation

1. Install and enable the AI module and an AI provider module (e.g. DXPR AI Provider, OpenAI, or any other supported provider)
2. Configure a default Chat provider at /admin/config/ai/settings
3. Configure global AI Agent settings at /admin/config/content/ckeditor-ai-agent
4. Grant the "Use CKEditor AI Agent" permission to roles that should have AI access
5. Set up text formats at /admin/config/content/formats
6. Add the AI Agent button to your CKEditor toolbars
7. Start using slash commands or the toolbar button for AI assistance

Usage Examples

• Content Creation: Type "/write" followed by your topic to generate new content
• Content Enhancement: Select text and use the AI menu to improve or modify it
• Reference Integration: Include URLs in prompts to incorporate external content
• Inline Assistance: Use Cmd/Ctrl + / to insert AI content mid-sentence
• Multilingual Content: Generate content in any language supported by your chosen AI model

Dependencies

• AI module (drupal/ai) - Required. Routes AI requests through Drupal server-side, keeping API keys secure. Works with any AI provider plugin (DXPR, OpenAI, Anthropic, Ollama, and more).

Related Modules

• AI module - Required. Routes all AI requests server-side through Drupal; API keys never reach the browser
• DXPR AI Provider - Compatible AI provider that enables long-form content creation with automatic failover between AI backends
• DXPR Builder - Drag-and-drop Drupal page builder. CKEditor AI Agent works inside DXPR Builder's text editing fields