Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/proactions-ai-kit-configuration/_shared/latest--partial-action.schema.json
Parent schema proactions-ai-kit-configuration
Type: object

Schema for a single action entry used inside a section

Properties

title string required

Display title for the action

List of steps to execute

id string

Unique identifier for the action

category string

Category for sub-grouping actions

context string | string[]

Document context where this action appears

keywords string

Search keywords for finding this action

icon string

Icon HTML for the action

imports object[] | string
events object[]

Optional event subscriptions that automatically trigger this action.

Steps to execute if an error occurs

hidden boolean

Whether this action is hidden from UI

isAvailable string

Condition for when action is available

panelContext object[]

Context specifications for panel display

swing object

Swing Web Client native integrations (v1.1.0+)

4 nested properties
inlineMenu object

Add button to inline text editor toolbar (appears when selecting text)

7 nested properties
enable boolean required

Enable this integration

label string

Button label text (defaults to action title)

icon string

FontAwesome icon class (e.g., 'fa fa-magic')

allowReadOnly boolean

Allow button to be active in read-only mode

Default: false
isEnabled string

Nunjucks expression for button enablement (e.g., '{{ client.isTextSelected() }}')

isActive string

Nunjucks expression for button visibility

showIn object

Optional source-level visibility gates evaluated before isActive.

3 nested properties
inlinetoolbar boolean

Show action when triggered from inline text selection toolbar

slashmenu boolean

Show action when triggered from contextual slash menu

blockmenu boolean

Show action when triggered from contextual block menu

objectAction object

Add action to object three-dots menu (search results, preview pane, explorer)

1 nested properties
enable boolean required

Enable this integration

contextMenu object

Add item to right-click context menus (Explorer and other contexts)

1 nested properties
enable boolean required

Enable this integration

onBlockDrop object

Trigger action when a block element is dropped in the editor (e.g., drag and drop between stories)

3 nested properties
enable boolean required

Enable this integration

runWhen Record<string, boolean | string>

Simple conditions that must match for the action to run. All conditions must be true.

5 nested properties
isCrossStory boolean

Only run when block is dropped between different stories

fromOldVersion boolean

Only run when content is being restored from a previous version

betweenChannelCopy boolean

Only run when block is copied between different channels

isSameContainer boolean

Only run when block is moved within the same container

blockType string

Only run for specific block types (e.g., 'image', 'video')

when string

Custom JavaScript expression for complex conditions. Has access to 'options' (block drop info) and 'ctx' (editor context). Must return true for the action to run.

Examples: "options.sourceLanguage !== options.targetLanguage", "options.blockType === 'image' && options.textContent.length > 100"
monitor object

Monitor configuration override for this action

9 nested properties
enabled boolean

Enable monitor for this action

showProgress boolean

Show progress bar

showStepNames boolean

Show current step name

showElapsedTime boolean

Show elapsed time

enableCancellation boolean

Allow cancelling this flow

confirmCancellation boolean

Confirm before cancelling

renderMarkdown boolean

Render markdown in feedback messages

defaultWidth number

Override default width of the monitor in pixels for this action

min=200
defaultHeight number

Override default height of the monitor in pixels for this action

min=100