Skip to main content
POST
/
eval_runs
/
{id}
/
cancel
Cancel Eval Run
curl --request POST \
  --url https://api.vogent.ai/api/eval_runs/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "PENDING",
  "callAgentId": "<string>",
  "versionedPromptId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "aggregateResult": {
    "numFailing": 123,
    "numPassing": 123
  }
}

Authorizations

​
Authorization
string
header
required

In the form Bearer <api_key_here>. You can find your api key in your dashboard.

Path Parameters

​
id
string
required

ID of the eval run to cancel.

Response

Successful operation

​
id
string
required
​
status
enum<string>
required

The status of an evaluation run.

Available options:
PENDING,
RUNNING,
SUCCESS,
FAILED,
CANCELLED
​
callAgentId
string
required
​
versionedPromptId
string
required
​
createdAt
string<date-time>
required
​
aggregateResult
object
required