API ReferenceAutomations
Run an automation now
Runs it once for real (not a test), whether or not it is switched on. Only for automations started by hand or on a schedule; event-started ones run when the event happens. Returns 202 with the run; read it with GET /v1/automation-runs/{id}. Counts toward the plan’s monthly runs. Owners and admins only.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
curl -X POST "https://example.com/v1/automations/497f6eca-6276-4993-bfeb-53cbbbba6f08/run"{ "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "automationId": "string", "mode": "TEST", "status": "SUCCEEDED", "triggerType": "manual", "creditsUsed": 0, "error": "string", "startedAt": "2026-10-29T09:00:00.000Z", "finishedAt": "string", "steps": [ { "nodeId": "notify", "type": "action.notify", "status": "SUCCEEDED", "error": "string" } ]}Empty
Empty
Empty
Empty
Empty