Components
Reference for all built-in Awee workflow components, organized by category.
Components are the building blocks of an Awee workflow. Each step in a workflow uses one component.
Built-in vs Component Registry
Built-in components ship with the engine and cover the most common automation tasks.
Component registry component configurations are stored online in our Cloud. We're building a marketplace for free and paid, our team and community contributed component configurations.
App
Premium
These components require an Awee Premium subscription and a valid license key.
Manage schemas, tables, fields, and records in the Awee app platform.
| Component | Description |
|---|---|
app:field | Retrieves the definition of a single field within a table |
app:field:create | Adds a new field to a table and applies the migration |
app:field:delete | Removes a field from a table and applies the migration |
app:field:update | Replaces the definition of an existing field within a table |
app:fields | Lists all fields defined within a table |
app:record | Retrieves a single record by ID from the given schema table |
app:record:delete | Soft-deletes a record by setting its deleted_at timestamp |
app:record:history | Retrieves the immutable audit log for a record, ordered oldest first |
app:record:insert | Inserts a new record into a schema table and returns the persisted record |
app:record:update | Applies a full replacement patch to an existing record and returns the updated record |
app:records:query | Queries records from a schema table using filters, sorting and pagination |
app:schema | Retrieves a single schema by ID for the given organisation |
app:schema:create | Provisions a new database and applies the initial schema definition |
app:schema:create:many | Provisions multiple databases and applies their initial schema definitions |
app:schema:delete | Drops the database for the given schema ID |
app:schema:update | Replaces the metadata of an existing schema |
app:schemas | Lists all schemas belonging to an organisation |
app:table | Retrieves the definition of a single table within a schema |
app:table:create | Adds a new table to a schema and applies the migration |
app:table:delete | Removes a table from a schema and applies the migration |
app:table:update | Replaces the definition of an existing table within a schema |
app:tables | Lists all tables defined within a schema |
CSV
Parse, transform, and merge CSV files.
| Component | Description |
|---|---|
csv:chunk | Splits a large CSV file into smaller chunk files of a fixed row count |
csv:merge | Merges columns from a secondary CSV file into a primary CSV file |
csv:shrink | Removes specified columns from a CSV file to reduce its width |
csv:unchunk | Combines multiple CSV chunk files back into a single output file |
Dir
Read and write directories on the local filesystem.
Each
Iterate over a list and run sub-steps for every item.
| Component | Description |
|---|---|
each | Loop over a collection of items or map entries, processing them one by one or in chunks. |
Error
Raise an explicit error to stop the workflow.
| Component | Description |
|---|---|
error | Immediately fails the workflow step with a configurable error message |
Event
Emit events during workflow execution.
| Component | Description |
|---|---|
event:emit | Publishes an event to the configured topic so other pipeline steps or external systems can react |
Exec
Execute shell commands.
| Component | Description |
|---|---|
exec | Runs an arbitrary shell command and captures its stdout, stderr and exit code |
File
Read, write, copy, find, and validate files on the local filesystem.
| Component | Description |
|---|---|
file:copy | Copies a file from source to destination, preserving file permissions |
file:json:unchunk | Combines multiple JSON chunk files into a single array or map output file |
file:read | Reads the full contents of a file and returns it as both a string and raw bytes |
file:write | Writes or appends content to a file, optionally deleting it first |
Group
Group related steps under a single named step.
| Component | Description |
|---|---|
group | Is a control component that groups multiple components together It does not execute any logic itself, but serves as a container for other components |
HTTP
Make HTTP requests and handle responses.
| Component | Description |
|---|---|
http | Perform HTTP requests using the provided configuration |
Inference
Interact with AI language models.
| Component | Description |
|---|---|
inference | Makes LLM inference requests using the configured provider and its model. Supports tools, LLM parameter settings and cost calculation with user currency conversion. Pass a template path to the prompt field, or a string prompt to render dynamic prompts with variables. |
inference:estimate | Estimates the token count and cost for a prompt without running the model |
inference:models | Lists all available models from the configured inference provider |
Map
Transform a list by running sub-steps per item and collecting results.
| Component | Description |
|---|---|
map | Remaps and transforms values from a source object into a new output structure |
Print values to stdout for debugging.
| Component | Description |
|---|---|
print | Logs a labelled variable value to the debug output for inspection during development |
Sleep
Pause workflow execution for a duration.
| Component | Description |
|---|---|
sleep | Is a control component that sleeps for a specified duration |
Var
Set or pass through a variable value.
| Component | Description |
|---|---|
var | Sets or appends a variable in the workflow context for use in subsequent steps |
XML
Parse and transform XML documents.
| Component | Description |
|---|---|
xml | Processes an XML file using a configurable processor (generic or xliff), supporting import and export of translated content |
How is this guide?