Test-run an automation without enabling it
Queues a run against the draft version when one exists and the published version otherwise, ignoring the enabled flag so an automation can be exercised before it goes live. Requires the `automations:write` permission plus edit access; an automation with no version yet is rejected with a run error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/automations/string/test-run" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "string", "automationId": "string", "automationVersionId": "string", "workspaceId": "string", "status": "queued", "source": "manual", "startedAt": "string", "completedAt": "string", "triggerPayload": {}, "output": {}, "error": "string", "metadata": {}, "startNodeId": "string", "replayOfRunId": "string", "nodeRuns": [ { "id": "string", "runId": "string", "nodeId": "string", "nodeKind": "string", "scopeKey": "string", "status": "queued", "attempt": 0, "input": {}, "output": {}, "error": "string", "startedAt": "string", "completedAt": "string" } ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Run an automation now
Queues a manual run of the automation's published version, seeded with the optional `triggerPayload`, and returns the queued run. Requires the `automations:write` permission plus edit access; an automation that is not both published and enabled is rejected with a run error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Run an automation starting from one node
Queues a run that begins at `nodeId`, optionally against a specific `automationVersionId` and pre-seeded with `scope` and per-node `nodes` context so a single branch can be exercised. Requires the `automations:write` permission plus edit access; a version belonging to another automation is rejected with a validation error, and without an explicit version the automation must be published and enabled. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.