Skip to main content
POST
Requires version 1.1.12 or later of the Archetype platform.

Overview

This endpoint cancels a pending or running eval and returns it in its cancelled state.
An eval that has already terminated (with status whose value is completed, failed, or cancelled) has nothing to cancel and returns HTTP status code 409.
Canceling is the prerequisite for deleting a non-terminal eval. Attempting to delete a non-terminal eval fails, returning HTTP status 409. Cancel the eval first to avoid this error.

Request

string
required
Eval evl_ id.

Response

Returns the cancelled eval, in the same format that Get Eval returns.
string
required
TypeID-encoded eval identifier (evl_ prefix).
string
required
Human label for the eval.
string
required
Organization identifier the eval belongs to.
string
required
The blueprint being evaluated.
string
required
The run’s headline, as <target>.<objective>.
array
required
The examples the eval was created against, as resolved.
object
required
The fully-expanded configuration this eval ran under.
string
required
Eval lifecycle status; cancelled after a successful cancel.
string
required
Subject id (usr_... or key_...) that created this eval.
string
required
Creation timestamp (date-time).
string
When the runner picked the eval up; null if it never did.
string
When the eval finished; null while unfinished.
object
This is always null for a cancelled eval since the report is populated only when an eval reaches completed.
array
References to the files the run produced. A cancelled eval keeps its partial predictions entry — the rows scored so far are still readable.
A cancelled eval keeps the rows it already scored. Its predictions artifact stays in output_artifacts with metadata.status set to partial.
string
Failure detail; null unless the eval failed.