Skip to main content
POST
/
v1
/
ai
/
eval
/
runs
/
{runId}
/
cancel
Cancel an eval run
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/ai/eval/runs/{runId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "cancelled": 4,
  "run": {
    "branch_id": null,
    "branch_name": null,
    "completed_at": null,
    "created_at": "2025-01-15T10:00:00.000Z",
    "description": null,
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "is_archived": false,
    "model_id": "880e8400-e29b-41d4-a716-446655440003",
    "prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
    "results": [
      {
        "agentic_job": {
          "conversation_id": "770e8400-e29b-41d4-a716-446655440002",
          "id": "990e8400-e29b-41d4-a716-446655440004",
          "state": "COMPLETE"
        },
        "cost": 0.0021,
        "error_reason": null,
        "id": "aa0e8400-e29b-41d4-a716-446655440005",
        "prompt": "What are the top 5 products by revenue?",
        "score": 0.9,
        "scoring_cost": 0.0004,
        "timing_ms": 4321
      }
    ],
    "run_number": 3,
    "status": "RUNNING"
  },
  "total": 12
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
runId
string<uuid>
required

The unique identifier of the eval run.

Example:

"660e8400-e29b-41d4-a716-446655440001"

Response

Cancellation processed.

​
cancelled
integer
required

Number of per-prompt agentic jobs that were cancelled by this request.

Example:

4

​
run
object
required

The cancelled run. status: CANCELLED and is_archived: true after this call.

​
total
integer
required

Total number of per-prompt jobs in the run.

Example:

12