AI Rule Engine Docs
Go to App

Actions Overview

Actions are the units of work a rule performs. When a rule's condition matches, the engine runs the rule's actions in order, and each action reads from and writes to the shared execution context.

What an action is

An action is a single, typed step โ€” call an HTTP API, prompt an AI model, transform a value, write to the context, log a message, and so on. Every action carries a Name, an optional Description, and a type that determines its shape and the fields it accepts. Actions are grouped into reusable action sets, and a rule references one or more action sets (or holds actions inline).

See Rules for how conditions decide whether a rule runs, and Core Concepts for the bigger picture of rule sets and subjects.

How a rule runs actions

A rule pairs a condition with a set of actions. If the condition evaluates true for the current subject, the engine executes the rule's actions; actions within an action set always run sequentially, one after another, in the order they are listed. Each action receives the same evolving subject and passes it forward, so an action can build on values produced by earlier actions in the same run.

Reading and writing the context

Actions communicate through the shared context โ€” a key/value bag attached to the subject. Inputs are usually a value input: a literal constant, a reference to a context key, or a reference to a variable. Outputs are written to a named context key, where later actions (or the final result) can read them. This read/write contract is what lets you chain actions into a pipeline. See Variables & Context for the details.

Tip Name your output context keys descriptively. Downstream actions reference them by key, so clear names keep larger action sets readable.

Action catalog

The engine ships the following action types, grouped by category.

AI

Actions that call a selected AI model or provider. See AI Actions.

ActionWhat it does
AI ChatSends a prompt to a chat model and stores the reply.
AI Image GenerationGenerates an image from a text prompt.
AI Image RecognitionAsks a model a question about one or more images.
AI ModerationFlags whether text violates content policy.
Speech-to-TextTranscribes audio into text.
Text-to-SpeechSynthesizes speech audio from text.

Data & Transform

Actions that shape, compute, and move values. See Data & Transform Actions.

ActionWhat it does
TransformApplies math, string, date, or array operators to a value.
JSON CreateBuilds a JSON document from context values.
XML CreateBuilds an XML document from context values.
Add to ContextSets one or more named values into the context.
Remove from ContextDeletes named keys from the context.

Integration

Actions that reach external systems. See Integration Actions.

ActionWhat it does
APIMakes an outbound HTTP request and captures the response.
ExtensionInvokes a marketplace extension.
Extension CallbackCalls back into the consuming project (extension authors only).
StorageSaves, retrieves, or deletes stored files by key.

Control & Flow

Actions that direct execution. See Control & Flow Actions.

ActionWhat it does
RuleInvokes another rule set, optionally passing parameters.
LogWrites a message and optional attachments to the run log.
Human InterventionPauses the run for a person to review and resume.
Array LoopRepeats a set of actions once per array item.
Project type matters A few actions are restricted by project type: Storage, Human Intervention, and Extension are not available inside extension projects, while Extension Callback is valid only inside extension projects.