Start a run
Start a run. Send JSON or multipart/form-data.
How to read a run: the envelope is at the root. The automation business result is in output (per-automation, not this generic schema). Status is execution.status (execution.retry.nextRun.status is a later retry). input, usage, and debug appear only with ?expand=. eval is present only on eval-scoped runs.
Authorizations
API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.
Query Parameters
Release or git ref. Defaults to latest.
1Seconds to wait before returning (max 600). Omit for async.
0 <= x <= 600Body
Run envelope. Declare provenance with the X-Eigenpal-Trigger header (api or cli). Legacy 0.5.12 body shapes remain accepted.
Automation target without a version suffix, e.g. workflows.invoice or agents.support.
1Scalar and structured automation arguments.
File inputs as ingress references ({ "$fileId": "file_..." } or { "$inline": { filename, mimeType, base64 } }). Upload bytes via multipart files.<fieldName> parts instead.
Per-step output overrides. Workflow runs only.
Caller-supplied run metadata.
Response
Run completed while waiting — same body as GET /api/v1/runs/:id
workflow, agent True when the run has reached a terminal status.
Deterministic pseudo-random rank in [0, 1) for this run within the tenant. Use with a sample rate threshold to review a stable subset.
0 <= x <= 1Slim execution metadata always present (status, schemaValid, batchId, retry). Pass expand=execution to replace with full RunExecution (WorkflowRunExecution or AgentRunExecution depending on run type).
- Option 1
- Option 2
- Option 3
Parent run id when this run was started by an invoke-workflow step. Omitted for top-level runs.
Present only on eval-scoped runs. Omitted otherwise.
Completed runs only. Per-automation business result — not a generic schema. Absent until the run completes.
Completed runs only. Download with GET /api/v1/runs/:id/artifacts/:path. Absent until the run completes.
Terminal failure message. Present on terminal runs; null when the run succeeded. Absent while the run is still in flight.
Present only with expand=input.
Present only with expand=usage. Null for old runs without telemetry.
Present only with expand=debug.