agents
Agent management, skills, and runs
limai agents <subcommand>Manage agents: create and configure agents, attach template files and skills, and inspect runs and their conversations.
--jsonOutput raw JSON--verboseEnable debug loggingSubcommands
limai agents list <projectId>
List agents in a project.
limai agents list <projectId>List agents in a project.
--status <status>Filter by status (ACTIVE, PAUSED, DISABLED)limai agents get <projectId> <agentId>
Show agent details: triggers, process content, deployments, email address, connection, files, skills, and run count.
limai agents get <projectId> <agentId>limai agents create <projectId>
Create a new agent.
limai agents create <projectId>Create a new agent.
--name <name>Agent name (required)--triggers <triggers>Comma-separated trigger types: DOCUMENT_EXTRACTED, DOCUMENT_REVIEWED, EMAIL_RECEIVED (required)--process-file <path>Read process content from file--deployments <deployments>Comma-separated deployment IDs--connection-id <connectionId>Integration connection ID--integration-config-file <path>Read provider-specific integrationConfigs JSON from file--email-local-part <value>Custom email local part (before @domain); auto-generated if omitted--file <path>Attach a template file (repeatable); equivalent to chaining `agents upload-file` after createlimai agents update <projectId> <agentId>
Update an agent. Only the provided fields are changed.
limai agents update <projectId> <agentId>Update an agent.
--name <name>Agent name--process-file <path>Read process content from file--triggers <triggers>Comma-separated trigger types--deployments <deployments>Comma-separated deployment IDs--connection-id <connectionId>Integration connection ID--integration-config-file <path>Read provider-specific integrationConfigs JSON from file--status <status>Agent status (ACTIVE, PAUSED, DISABLED)--tier <tier>Agent tier (STANDARD, STANDARD_PLUS, MAX)--email-local-part <value>Custom email local part (before @domain)limai agents delete <projectId> <agentId>
Delete an agent.
limai agents delete <projectId> <agentId>limai agents upload-file <projectId> <agentId> <filePath>
Upload a template file to an agent.
limai agents upload-file <projectId> <agentId> <filePath>limai agents delete-file <projectId> <agentId> <fileId>
Delete a template file from an agent.
limai agents delete-file <projectId> <agentId> <fileId>limai agents download-file <projectId> <agentId> <fileId>
Download a template file from an agent.
limai agents download-file <projectId> <agentId> <fileId>Download a template file from an agent.
--output <path>Output file path (defaults to original filename)Skills
limai agents skills list <projectId> <agentId>
List skills for an agent.
limai agents skills list <projectId> <agentId>limai agents skills create <projectId> <agentId>
Create a skill for an agent.
limai agents skills create <projectId> <agentId>Create a skill for an agent.
--name <name>Skill name (required)--content-file <path>Read skill content from file (required)limai agents skills update <projectId> <agentId> <skillId>
Update a skill.
limai agents skills update <projectId> <agentId> <skillId>Update a skill.
--name <name>Skill name--content-file <path>Read skill content from filelimai agents skills delete <projectId> <agentId> <skillId>
Delete a skill.
limai agents skills delete <projectId> <agentId> <skillId>limai agents skills link-file <projectId> <agentId> <skillId> <fileId>
Link an agent file to a skill. The file lands in the skill folder at runtime.
limai agents skills link-file <projectId> <agentId> <skillId> <fileId>limai agents skills unlink-file <projectId> <agentId> <skillId> <fileId>
Unlink a file from a skill.
limai agents skills unlink-file <projectId> <agentId> <skillId> <fileId>Runs
limai agents runs list <projectId> <agentId>
List runs for an agent.
limai agents runs list <projectId> <agentId>List runs for an agent.
--limit <limit>Max results (max 100)(default: 20)--status <status>Filter by status (PENDING, RUNNING, COMPLETED, FAILED, ...)limai agents runs get <projectId> <agentId> <runId>
Show run details, including steps and email drafts.
limai agents runs get <projectId> <agentId> <runId>limai agents runs conversation <projectId> <agentId> <runId>
Show the sanitized conversation for a run.
limai agents runs conversation <projectId> <agentId> <runId>Show sanitized run conversation.
--step-id <stepId>Limit to the conversation for a specific step/sessionExecution commands
These commands are invoked by the agent runtime during a run rather than by users.
limai agents create-run <projectId> <agentId>
Create a new agent run. Options: --trigger-event-id <triggerEventId> (required), --trigger-type <triggerType> (required; DOCUMENT_EXTRACTED, DOCUMENT_REVIEWED, EMAIL_RECEIVED), --title <title> (required), --metadata <json>.
limai agents create-step <projectId> <agentId> <runId>
Create a step within a run. Options: --type <type> (required; EMAIL_DRAFT, DATA_REVIEW, FILE_OUTPUT, TASK, USER_INPUT), --title <title> (required), --order <order> (required), --description <description>, --post-review-action <action> (NONE, RESUME_AGENT), --data <json>, --conditions <json>.
limai agents update-run <projectId> <agentId> <runId>
Update a run's status, metadata, or error message. Options: --status <status> (PENDING, RUNNING, PAUSED, WAITING_HUMAN, COMPLETED, FAILED), --metadata <json> (merged into run metadata), --error-message <message>.
limai agents update-step <projectId> <agentId> <runId> <stepId>
Update a step's status or data. Options: --status <status> (PENDING, IN_PROGRESS, WAITING_HUMAN, COMPLETED, FAILED, SKIPPED), --data <json>.
limai agents update-step-conditions <projectId> <agentId> <runId> <stepId>
Replace a step's conditions, e.g. to patch placeholder entity IDs. Options: --conditions <json> (required; JSON array of {type, entityId, label} objects).
limai agents pause-run <projectId> <agentId> <runId>
Pause a running agent run. No options.
limai agents send-email <projectId> <agentId>
Draft or send an email from an agent execution. Only available inside the agent sandbox. Options: --execution-id <executionId> (required), --to <to> (required), --subject <subject> (required), --body <body> or --body-file <path> (one required; file overrides), --html-body <htmlBody>, --in-reply-to <messageId>.
limai agents complete <projectId> <agentId> <executionId>
Mark an agent execution as completed or failed. Only available inside the agent sandbox. Options: --status <status> (COMPLETED or FAILED, default COMPLETED), --error <message>, --output-file <name>, --output-url <url>.
limai agents sharepoint-token <projectId> <agentId>
Deprecated. SharePoint uploads now go through limai integrations sharepoint upload; this command always exits with an error.
limai agents upload-artifact <projectId> <agentId> <executionId> <filePath>
Upload a file as an artifact for an agent execution. Only available inside the agent sandbox. No options.
Examples
Create an agent with a process file and a template
limai agents create proj_abc123 --name "Invoice Processor" --triggers DOCUMENT_EXTRACTED --process-file ./process.md --deployments dep_456 --file ./template.xlsxList active agents
limai agents list proj_abc123 --status ACTIVEInspect an agent
limai agents get proj_abc123 agt_abc123Pause an agent
limai agents update proj_abc123 agt_abc123 --status PAUSEDUpload and download template files
limai agents upload-file proj_abc123 agt_abc123 ./template.xlsx
limai agents download-file proj_abc123 agt_abc123 file_xyz789 --output ./template.xlsxCreate a skill and link a file to it
limai agents skills create proj_abc123 agt_abc123 --name "Fill Template" --content-file ./skill.md
limai agents skills link-file proj_abc123 agt_abc123 skl_abc123 file_xyz789List recent failed runs
limai agents runs list proj_abc123 agt_abc123 --status FAILED --limit 10Inspect a run and its conversation
limai agents runs get proj_abc123 agt_abc123 run_abc123
limai agents runs conversation proj_abc123 agt_abc123 run_abc123Delete an agent
limai agents delete proj_abc123 agt_abc123