Skip to content
Kindgi

Cancel an eval run

POST
/v1/eval-runs/{runId}/cancel
curl --request POST \
  --url https://example.com/v1/eval-runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>'

Best-effort cancel. Returns 409 when the run is already terminal.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
runId
required
string format: uuid

EvalRunId — opaque branded UUID.

Responses

Section titled “Responses”

200

Section titled “200”

Cancel accepted.

Media typeapplication/json
object
runId
required
string format: uuid
tenantId
required
string format: uuid
suiteId
required
string
suiteVersion
required
string
/^\d+\.\d+\.\d+$/
kind
required
string
Allowed values: accuracy pairwise regression human-review benchmark custom
agentRef
object
agentId
required
string
version
string
/^\d+\.\d+\.\d+$/
flowRef
object
flowId
required
string
version
string
/^\d+\.\d+\.\d+$/
status
required
string
Allowed values: pending running completed failed cancelled
dryRun
required
boolean
startedAt
required
string format: date-time
completedAt
string format: date-time
result

Kind-specific opaque JSON. For accuracy, contains { passCount, totalCount, meanScore, perCase[] }. Other kinds define their own shapes as their dispatchers ship.

object
key
additional properties
any
error
string
correlationId
string
Example
{
  "kind": "accuracy",
  "status": "pending"
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No eval run with that id under this tenant.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

409

Section titled “409”

Run already terminal.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}