Skip to main content
POST
/
api
/
v1
/
run
/
{target}
Start a workflow or agent run
curl --request POST \
  --url https://app.eigenpal.com/api/v1/run/{target} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "runId": "<string>",
  "output": "<unknown>",
  "error": "<string>",
  "schemaValid": true,
  "requestedSourceRef": "<string>",
  "resolvedGitRef": "<string>",
  "resolvedGitTag": "<string>",
  "resolvedCommitSha": "<string>",
  "cost": {}
}

Authorizations

​
Authorization
string
header
required

API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

​
target
string
required

Automation target without a version suffix.

Minimum string length: 1

Query Parameters

​
version
string

Optional version or source ref. Defaults to latest.

Minimum string length: 1
​
wait_for_completion
integer
Required range: 0 <= x <= 600

Body

​
{key}
any

Response

Run completed while waiting

​
runId
string
required
​
type
enum<string>
required
Available options:
workflow,
agent
​
status
Available options:
created,
pending,
running,
waiting,
finalizing,
completed,
failed,
cancelled,
rejected
​
output
any
​
error
string | null
​
schemaValid
boolean | null
​
requestedSourceRef
string | null
​
resolvedGitRef
string | null
​
resolvedGitTag
string | null
​
resolvedCommitSha
string | null
​
cost
object