LimAI Docs

$limai workflows <subcommand>

Create, configure, test, and manage automation workflows. Workflows execute agent prompts in response to triggers like document extraction or email ingestion.

Options

--jsonOutput raw JSON

--verboseEnable debug logging

Subcommands

`limai workflows list <projectId>`

List all workflows in a project.

$limai workflows list <projectId>

List workflows in a project.

Options

--status <status>Filter by status (ACTIVE, PAUSED, DISABLED)

`limai workflows get <projectId> <workflowId>`

Show detailed information about a workflow, including triggers, deployments, files, and connection status.

limai workflows get <projectId> <workflowId>

`limai workflows create <projectId>`

Create a new workflow.

$limai workflows create <projectId>

Create a new workflow.

Options

--name <name>Workflow name (required)

--prompt <prompt>Agent prompt text (required unless --prompt-file is used)

--triggers <triggers>Comma-separated trigger types: DOCUMENT_EXTRACTED, DOCUMENT_REVIEWED, EMAIL_RECEIVED (required)

--description <description>Workflow description

--deployments <deployments>Comma-separated deployment IDs

--connection-id <connectionId>Integration connection ID

--prompt-file <path>Read agent prompt from a file (overrides --prompt)

--files <files>Comma-separated file paths to upload as templates

`limai workflows update <projectId> <workflowId>`

Update an existing workflow. Only specified fields are changed.

$limai workflows update <projectId> <workflowId>

Update a workflow.

Options

--name <name>Workflow name

--prompt <prompt>Agent prompt text

--prompt-file <path>Read agent prompt from a file

--description <description>Workflow description

--triggers <triggers>Comma-separated trigger types

--deployments <deployments>Comma-separated deployment IDs

--connection-id <connectionId>Integration connection ID

--status <status>Workflow status (ACTIVE, PAUSED, DISABLED)

`limai workflows delete <projectId> <workflowId>`

Delete a workflow.

limai workflows delete <projectId> <workflowId>

`limai workflows test <projectId> <workflowId>`

Test a workflow by running it against a specific file.

$limai workflows test <projectId> <workflowId>

Test a workflow with a file.

Options

--file-id <fileId>File ID to test with (required)

`limai workflows executions <projectId> <workflowId>`

List execution history for a workflow.

$limai workflows executions <projectId> <workflowId>

List workflow executions.

Options

--status <status>Filter by status (PENDING, RUNNING, COMPLETED, FAILED)

--limit <limit>Number of results(default: 50)

`limai workflows upload-file <projectId> <workflowId> <filePath>`

Upload a template file to a workflow.

limai workflows upload-file <projectId> <workflowId> ./template.xlsx

`limai workflows delete-file <projectId> <workflowId> <fileId>`

Delete a template file from a workflow.

limai workflows delete-file <projectId> <workflowId> file_xyz789

Examples

Create a workflow with a prompt

limai workflows create proj_abc123 \
  --name "Invoice Processing" \
  --prompt "Extract invoice data and send to accounting" \
  --triggers DOCUMENT_EXTRACTED \
  --deployments dep_456,dep_789

Create a workflow with prompt from file

limai workflows create proj_abc123 \
  --name "Email Ingestion" \
  --prompt-file ./prompts/email-handler.md \
  --triggers EMAIL_RECEIVED \
  --files ./templates/report.xlsx

Update workflow status

limai workflows update proj_abc123 wf_xyz789 --status PAUSED

Test a workflow

limai workflows test proj_abc123 wf_xyz789 --file-id file_abc

View execution history

limai workflows executions proj_abc123 wf_xyz789 --status FAILED

Upload a template file

limai workflows upload-file proj_abc123 wf_xyz789 ./template.xlsx

List active workflows

limai workflows list proj_abc123 --status ACTIVE --json

workflows

On this page