# AIChatShortcutReviewDefinition

interface

A shortcut that interacts with the AI Review.

**Note**: This shortcut type requires the [`AIReviewMode`](module_ai_aireviewmode_aireviewmode-AIReviewMode.md) plugin to be loaded.

This type of shortcut can run both predefined and extra review commands. The list of predefined review commands with available parameters can be found in the [AI Review documentation](../features/ai/ckeditor-ai-review.md#review-commands). Extra review commands are defined via the [`config.ai.review.extraCommands`](module_ai_aireviewmode_aireviewmode-AIReviewModeConfig.md#member-extraCommands) configuration.

Example of a shortcut that opens the AI Review mode:

```typescript
{
	id: 'open-review',
	label: 'Open review',
	type: 'review'
}
```

Example of a shortcut that runs the `'correctness'` review command:

```typescript
{
	id: 'check-correctness',
	label: 'Proofread this document',
	type: 'review',
	commandId: 'correctness'
}
```

Example of a shortcut that runs the `'tone'` review command with a parameter:

```typescript
{
	id: 'adjust-tone',
	label: 'Change the tone of this document to casual',
	type: 'review',
	commandId: 'tone',
	params: [ 'casual' ]
}
```

Example of a shortcut that runs the `'custom'` review command with a specific model and a prompt:

```typescript
{
	id: 'custom-review',
	label: 'Custom grammar command using the gpt-5.1 model',
	type: 'review',
	commandId: 'custom',
	model: 'gpt-5.1',
	prompt: 'Check grammar and style.'
}
```

<a id="properties">

## Properties

<a id="member-commandId">

### `commandId?: string` _(readonly)_

The ID of the review command to be run.

**Note**: When not provided, the shortcut will switch the user interface to the AI Review.

See [`config.ai.review.availableCommands`](module_ai_aireviewmode_aireviewmode-AIReviewModeConfig.md#member-availableCommands) for the list of available review commands.

<a id="member-icon">

### `icon?: string` _(readonly)_

The icon of the shortcut in SVG string format.

Learn more about setting the icon in the [`IconView` API reference](module_ui_icon_iconview-IconView.md#member-content).

**Note**: When not provided, a generic icon associated with the shortcut type will be used instead.

<a id="member-id">

### `id: string` _(readonly)_

The unique identifier of the shortcut.

<a id="member-label">

### `label: string` _(readonly)_

The human-readable label of the shortcut.

<a id="member-model">

### `model?: string` _(readonly)_

The ID of the model to be used for the `'custom'` review command that requires a model identifier.

See the [integration guide](../features/ai/ckeditor-ai-integration.md#supported-ai-models) to learn more about available models.

**Note**: When not provided, the default model will be used instead. See [`config.ai.models.defaultModelId`](module_ai_aicore_model_aimodels-AIModelsConfig.md#member-defaultModelId) to learn more.

<a id="member-params">

### `params?: Array<string>` _(readonly)_

The parameters to be used for review commands that require parameters (e.g. `'length'`, `'tone'`, etc.).

<a id="member-prompt">

### `prompt?: string` _(readonly)_

The prompt to be sent to the AI Review for the `'custom'` review command that requires a prompt.

<a id="member-type">

### `type: 'review'`

The type of the shortcut.

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)