Skip to main content
POST
/
api
/
v1
/
automations
/
{id}
/
experiments
/
{experimentId}
/
cancel
Cancel experiment
curl --request POST \
  --url https://studio.eigenpal.com/api/v1/automations/{id}/experiments/{experimentId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "automationId": "<string>",
  "runCount": 0,
  "completedCount": 0,
  "passedCount": 0,
  "failedCount": 0,
  "avgScore": 123,
  "createdAt": "<string>",
  "completedAt": "<string>",
  "version": "<string>",
  "runs": [
    {
      "id": "<string>",
      "status": "<string>",
      "exampleId": "<string>",
      "exampleName": "<string>",
      "createdAt": "<string>",
      "completedAt": "<string>"
    }
  ],
  "resultsByRun": {}
}

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.

​
experimentId
string
required

Experiment batch id.

Response

Experiment detail after the cancellation request.

Experiment batch detail.

​
id
string
required

Experiment batch id. Some CLI commands historically call this a batch id.

​
automationId
string
required

Automation this experiment belongs to.

​
automationType
enum<string>
required
Available options:
workflow,
agent
​
status
enum<string>
required

Experiment batch status.

Available options:
queued,
running,
completed
​
runCount
integer
required

Total runs in the experiment.

Required range: -9007199254740991 <= x <= 9007199254740991
​
completedCount
integer
required

Runs that have completed.

Required range: -9007199254740991 <= x <= 9007199254740991
​
passedCount
integer
required

Runs whose evaluator scores passed.

Required range: -9007199254740991 <= x <= 9007199254740991
​
failedCount
integer
required

Runs whose evaluator scores failed.

Required range: -9007199254740991 <= x <= 9007199254740991
​
avgScore
number | null
required

Average automated evaluator score.

​
createdAt
required
​
completedAt
required
​
version
string | null
required
​
runs
object[]
required

Runs created for dataset examples in this experiment.

​
resultsByRun
object
required

Evaluator results keyed by run id.