Actions

Transform specific text content with focused operations such as grammar fixing and translation. Actions are single-purpose tools that take content in, apply a transformation, and return the result.

Unlike conversations, actions do not remember previous interactions. Each action is independent and focused on a single task.

When to use Actions vs Reviews: Use Actions when you need to transform specific text content (fix grammar, translate, adjust tone). Use Reviews when you need to analyze entire documents for quality improvements and get suggestions without automatically changing the content.

CKEditor AI provides built-in system actions for common content transformation tasks:

• Fix Grammar – Catch and correct spelling mistakes, grammar errors, and punctuation issues.
• Improve Writing – Enhance clarity, flow, and overall writing quality.
• Continue Writing – Complete unfinished sentences, paragraphs, or entire documents.
• Make Longer – Expand content with more detail, examples, and explanations.
• Make Shorter – Condense lengthy text while keeping the essential information.
• Adjust Tone – Change writing style to casual, professional, friendly, or confident.
• Translate – Convert content between languages with proper cultural context.

In addition to system actions, you can create custom actions tailored to your specific use cases. Custom actions allow you to define specialized content transformations using your own prompts to control AI behavior.

Unlike system actions that use predefined identifiers, custom actions use a unified endpoint where you define the transformation behavior through a prompt parameter.

Each action is independent and does not require conversation context. Actions use streaming output with Server-Sent Events for real-time feedback as results are generated.

POST /v1/actions/system/fix-grammar/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>The norhtern lights dence across the polar skies, painting ribbons of green and purple light that ripple like a cosmic curtain.</p>"
    }
  ]
}

POST /v1/actions/system/improve-writing/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>The system works by processing data through various algorithms to produce results.</p>"
    }
  ]
}

POST /v1/actions/system/make-longer/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>Artificial intelligence is transforming the way we work.</p>"
    }
  ]
}

POST /v1/actions/system/make-shorter/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>Artificial intelligence, which is a rapidly evolving field of computer science that focuses on creating intelligent machines capable of performing tasks that typically require human intelligence, is transforming the way we work across various industries and sectors.</p>"
    }
  ]
}

POST /v1/actions/system/make-tone-casual/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>We regret to inform you that your request cannot be processed at this time.</p>"
    }
  ]
}

POST /v1/actions/system/translate/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>Hello, how are you today?</p>"
    }
  ],
  "args": {
    "language": "Spanish"
  }
}

POST /v1/actions/custom/calls
Content-Type: application/json
Authorization: Bearer <your-token>

{
  "content": [
    {
      "type": "text",
      "content": "<p>The company's Q4 revenue was $2.5M, representing a 15% increase YoY.</p>"
    }
  ],
  "prompt": "Convert financial abbreviations to full words (e.g., 'YoY' to 'year-over-year', 'Q4' to 'fourth quarter') to make the text more accessible to general audiences.",
  "model": "agent-1",
  "outputFormat": "html"
}

Custom actions require the ai:actions:custom permission in your JWT token.

Actions use Server-Sent Events (SSE) for real-time streaming results. See the Streaming Responses guide for detailed implementation information.

For complete endpoint documentation, request/response schemas, authentication details, and additional parameters, see:

• Actions API Reference – Full documentation for system and custom actions endpoints.
• Complete API Documentation – Interactive API reference with all CKEditor AI endpoints.

• Conversations – For interactive discussions with document analysis and context.
• Reviews – For content quality analysis and improvement suggestions.
• Streaming Responses – For implementing real-time review suggestions.