Back to Eliza

Automations API

packages/docs/rest/automations.md

2.0.12.0 KB
Original Source

The Automations API provides a canonical view of all automation sources (triggers, workflows, cron jobs, workbench tasks) and a catalog of available automation nodes. These endpoints power the Automations tab in the dashboard.

Endpoints

MethodPathDescription
GET/api/automationsList all automation items
GET/api/automations/nodesBrowse the automation node catalog

GET /api/automations

Returns a canonical list of all automation items across sources (triggers, workflows, cron jobs, workbench tasks).

Response

json
{
  "automations": [
    {
      "id": "trigger-uuid",
      "source": "trigger",
      "type": "coordinator_text",
      "displayName": "Daily summary",
      "enabled": true,
      "triggerId": "trigger-uuid",
      "lastRun": "2026-04-22T14:00:00Z"
    }
  ]
}
FieldTypeDescription
automationsarrayAll automation items across all sources
automations[].sourcestring"trigger", "workflow", "cron", or "workbench"
automations[].typestringAutomation type (e.g., "coordinator_text", "workflow_service")
automations[].enabledbooleanWhether the automation is currently active

GET /api/automations/nodes

Returns the catalog of available automation node types that can be used to compose workflows.

Response

json
{
  "nodes": [
    {
      "id": "trigger-interval",
      "class": "trigger",
      "displayName": "Interval Trigger",
      "description": "Fires on a recurring interval"
    }
  ]
}
FieldTypeDescription
nodesarrayAvailable automation node descriptors
nodes[].classstringNode class: "trigger", "action", "context", "integration", or "agent"