Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Eigenpal Runs API

Start, monitor, retry, review, and debug automation runs, including artifacts.

Eigenpal Runs API is one of 6 APIs that Eigenpal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Runs. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 11 operations across 10 paths, and defines 38 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.eigenpal.com.

11 operations 10 paths 38 schemas 8 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://studio.eigenpal.com
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Eigenpal Runs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key issued from Settings → API Keys. Pass as Authorization: Bearer .

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 8 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Runs 11

Start, monitor, retry, review, and debug automation runs, including artifacts.

GET
/api/v1/runs
List runs
runs.list 36 params → 200400401403404413429500
POST
/api/v1/runs
Start a run
runs.start 2 params body → 200201202400401403404413
GET
/api/v1/runs/{id}
Get a run
runs.get 2 params → 200400401403404413429500
GET
/api/v1/runs/{id}/artifacts
List run artifacts
runs.artifacts.list 4 params → 200400401403404413429500
GET
/api/v1/runs/{id}/artifacts/{path}
Download run artifact
runs.artifacts.get 2 params → 200400401403404413429500
POST
/api/v1/runs/{id}/cancel
Cancel run
runs.cancel 1 param → 200400401403404413429500
GET
/api/v1/runs/{id}/events
List run events
runs.events.list 1 param → 200400401403404413429500
POST
/api/v1/runs/{id}/rerun
Retry run
runs.rerun 3 params → 200201202400401403404413
GET
/api/v1/runs/{id}/steps
List run steps
runs.steps.list 1 param → 200400401403404413429500
GET
/api/v1/runs/{id}/trace
Get run trace
runs.trace.get 1 param → 200400401403404413429500
GET
/api/v1/runs/{id}/usage
Get run usage
runs.usage.get 1 param → 200400401403404413429500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Run (15 properties), RunReview (15 properties), RunReviewCorrection (10 properties), RunSource (10 properties). Each schema is shown below with its type and property counts.

RunsListResponse
object
2 properties 2 required
RunTraceResponse
object
1 property 1 required
RunInput
object
3 properties 1 required
RunUsage
object
6 properties 3 required
RunCancelResponse
object
5 properties 5 required
RunStartBody
object
Run envelope. Declare provenance with the X-Eigenpal-Trigger header (api or cli). Legacy 0.5.12 body shapes remain accepted.
5 properties 1 required
RunStepsResponse
object
1 property 1 required
RunArtifactsResponse
object
1 property 1 required
RunStartMultipartRequest
object
4 properties 1 required
RunError
RunStartResponse
RunTrigger
object
3 properties 2 required
RunSourceGit
object
4 properties 4 required
RunAccepted
object
4 properties 3 required
WorkflowRunExecution
object
8 properties 5 required
RunReview
object
15 properties 14 required
AgentRunExecution
object
8 properties 5 required
ExecutionStatus
string
RunEventsResponse
object
1 property 1 required
RunExecutionMeta
object
5 properties 4 required
RunExecutionRetry
object
3 properties 3 required
RunDebug
object
2 properties 1 required
RunFile
object
1 property 1 required
RunRerunResponse
RunReviewSummary
object
4 properties 4 required
RunTiming
object
5 properties 5 required
RunArtifact
object
6 properties 3 required
RunEval
object
4 properties 3 required
RunSource
object
10 properties 3 required
Run
object
15 properties 8 required
RunUsageResponse
object
1 property 1 required
RunExecution
ApiErrorEnvelope
object
4 properties 2 required
RunListItem
object
10 properties 8 required
RunEvent
object
5 properties 2 required
RunTraceEvent
object
Trace event emitted by a workflow or agent run. Extra fields depend on the run type and event source.
7 properties
RunReviewCorrection
object
10 properties 7 required
ApiErrorIssue
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eigenpal-runs-api-openapi.yml Raw ↑

Other APIs Eigenpal publishes across the network.

Eigenpal Automations API
Eigenpal Evaluation API
Eigenpal Files API
Eigenpal Metadata API
Eigenpal Reviews API