curl --request POST \
--url https://api.eigenpal.com/v1/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target": "<string>",
"tags": "<string>",
"input": {},
"files": {},
"overrides": {
"steps": {}
},
"metadata": {}
}
'import requests
url = "https://api.eigenpal.com/v1/runs"
payload = {
"target": "<string>",
"tags": "<string>",
"input": {},
"files": {},
"overrides": { "steps": {} },
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: '<string>',
tags: '<string>',
input: {},
files: {},
overrides: {steps: {}},
metadata: {}
})
};
fetch('https://api.eigenpal.com/v1/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eigenpal.com/v1/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'target' => '<string>',
'tags' => '<string>',
'input' => [
],
'files' => [
],
'overrides' => [
'steps' => [
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eigenpal.com/v1/runs"
payload := strings.NewReader("{\n \"target\": \"<string>\",\n \"tags\": \"<string>\",\n \"input\": {},\n \"files\": {},\n \"overrides\": {\n \"steps\": {}\n },\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eigenpal.com/v1/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"target\": \"<string>\",\n \"tags\": \"<string>\",\n \"input\": {},\n \"files\": {},\n \"overrides\": {\n \"steps\": {}\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eigenpal.com/v1/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": \"<string>\",\n \"tags\": \"<string>\",\n \"input\": {},\n \"files\": {},\n \"overrides\": {\n \"steps\": {}\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "wfx_01HZXEXAMPLE",
"type": "workflow",
"finished": true,
"sampleRank": 0.42,
"timing": {
"createdAt": "2026-01-15T10:00:00.000Z",
"startedAt": "2026-01-15T10:00:01.000Z",
"completedAt": "2026-01-15T10:00:08.000Z",
"durationMs": 7000,
"cancelRequestedAt": null
},
"source": {
"id": "wf_invoice",
"name": "Invoice extraction",
"version": "3",
"versionId": "wfh_3"
},
"trigger": {
"type": "api",
"by": null
},
"output": {
"vendor": "Acme",
"total": 149.5
},
"files": [
{
"name": "file_1-invoice.json",
"role": "output",
"path": "output/extract/file_1-invoice.json",
"stepName": "extract"
}
],
"error": null,
"execution": {
"status": "completed",
"schemaValid": true,
"batchId": null,
"retry": {
"number": 0,
"previousRunId": null,
"nextRun": null
}
}
}{
"id": "wfx_01HZXEXAMPLE",
"type": "workflow",
"finished": false,
"source": {
"id": "wf_invoice",
"name": "Invoice extraction",
"version": null
}
}{
"id": "wfx_01HZXEXAMPLE",
"type": "workflow",
"finished": false,
"source": {
"id": "wf_invoice",
"name": "Invoice extraction",
"version": null
}
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}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.
curl --request POST \
--url https://api.eigenpal.com/v1/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target": "<string>",
"tags": "<string>",
"input": {},
"files": {},
"overrides": {
"steps": {}
},
"metadata": {}
}
'import requests
url = "https://api.eigenpal.com/v1/runs"
payload = {
"target": "<string>",
"tags": "<string>",
"input": {},
"files": {},
"overrides": { "steps": {} },
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: '<string>',
tags: '<string>',
input: {},
files: {},
overrides: {steps: {}},
metadata: {}
})
};
fetch('https://api.eigenpal.com/v1/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eigenpal.com/v1/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'target' => '<string>',
'tags' => '<string>',
'input' => [
],
'files' => [
],
'overrides' => [
'steps' => [
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eigenpal.com/v1/runs"
payload := strings.NewReader("{\n \"target\": \"<string>\",\n \"tags\": \"<string>\",\n \"input\": {},\n \"files\": {},\n \"overrides\": {\n \"steps\": {}\n },\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eigenpal.com/v1/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"target\": \"<string>\",\n \"tags\": \"<string>\",\n \"input\": {},\n \"files\": {},\n \"overrides\": {\n \"steps\": {}\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eigenpal.com/v1/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": \"<string>\",\n \"tags\": \"<string>\",\n \"input\": {},\n \"files\": {},\n \"overrides\": {\n \"steps\": {}\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "wfx_01HZXEXAMPLE",
"type": "workflow",
"finished": true,
"sampleRank": 0.42,
"timing": {
"createdAt": "2026-01-15T10:00:00.000Z",
"startedAt": "2026-01-15T10:00:01.000Z",
"completedAt": "2026-01-15T10:00:08.000Z",
"durationMs": 7000,
"cancelRequestedAt": null
},
"source": {
"id": "wf_invoice",
"name": "Invoice extraction",
"version": "3",
"versionId": "wfh_3"
},
"trigger": {
"type": "api",
"by": null
},
"output": {
"vendor": "Acme",
"total": 149.5
},
"files": [
{
"name": "file_1-invoice.json",
"role": "output",
"path": "output/extract/file_1-invoice.json",
"stepName": "extract"
}
],
"error": null,
"execution": {
"status": "completed",
"schemaValid": true,
"batchId": null,
"retry": {
"number": 0,
"previousRunId": null,
"nextRun": null
}
}
}{
"id": "wfx_01HZXEXAMPLE",
"type": "workflow",
"finished": false,
"source": {
"id": "wf_invoice",
"name": "Invoice extraction",
"version": null
}
}{
"id": "wfx_01HZXEXAMPLE",
"type": "workflow",
"finished": false,
"source": {
"id": "wf_invoice",
"name": "Invoice extraction",
"version": null
}
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}{
"issues": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>",
"severity": "error"
}
],
"requestId": "<string>",
"hint": "<string>",
"docsUrl": "<string>",
"conflictingWorkflowId": "<string>"
}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.
11 - 256Scalar and structured automation arguments.
Show child attributes
Show child attributes
File inputs as ingress references ({ "$fileId": "file_..." } or { "$inline": { filename, mimeType, base64 } }). Upload bytes via multipart files.<fieldName> parts instead.
Show child attributes
Show child attributes
Per-step output overrides. Workflow runs only.
Show child attributes
Show child attributes
Caller-supplied run metadata.
Show child attributes
Show child attributes
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 <= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Slim 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
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Completed runs only. Per-automation business result — not a generic schema. Absent until the run completes.
Show child attributes
Show child attributes
Completed runs only. Download with GET /api/v1/runs/:id/artifacts/:path. Absent until the run completes.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Present only with expand=usage. Null for old runs without telemetry.
Show child attributes
Show child attributes
Present only with expand=debug.
Show child attributes
Show child attributes