Skip to main content
POST
/
api
/
v1
/
automations
/
{id}
/
examples
/
{exampleId}
/
run
Run dataset example
curl --request POST \
  --url https://studio.eigenpal.com/api/v1/automations/{id}/examples/{exampleId}/run \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "batchId": "<string>",
  "finished": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Automation id or typed alias.

​
exampleId
string
required

Dataset example id to run.

Response

Example run accepted

​
id
string
required

Run id created for this example.

​
type
enum<string>
required

Implementation type behind the automation.

Available options:
workflow,
agent
​
batchId
string | null
required

Experiment batch id when the run is associated with a batch. The API also calls this an experiment id in experiment routes.

​
finished
boolean
required

Example runs are accepted asynchronously.