Run Workflow Evaluation
POST/api/automation/workflow-evaluations/:evaluation/run
Starts an evaluation run: executes the workflow once per test_data test case and records pass/fail results. Returns the created run (unwrapped) with HTTP 201 and status: "pending"; poll Show Workflow Evaluation to observe the run progressing through running → completed / failed.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Run fields: id, evaluationId, status (pending | running | completed | failed), totalCases, passedCases, failedCases, results, startedAt, finishedAt, duration (ms), createdAt.
Errors: HTTP 403 { "message": "..." } when automation is disabled for the tenant (AutomationDisabledException).
Route name: automation.evaluations.run
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.