OpenAI API (unofficial showcase)
POST/evals/{eval_id}/runs/{run_id}/cancel

Cancel an evaluation run

Cancels an ongoing evaluation run. Use this endpoint to stop a run that is still in progress; the response contains the canceled run object.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters
eval_idstringrequired
The identifier of the evaluation whose run to cancel.
run_idstringrequired
The identifier of the run to cancel.

2 status codes
200Returns the canceled evaluation run object, including its status, report URL, result counts, and other run details.
objectstringrequired
The type of the object. Always "eval.run".
Allowed:eval.runDefault:eval.run
idstringrequired
Unique identifier for the evaluation run.
eval_idstringrequired
The identifier of the associated evaluation.
statusstringrequired
The status of the evaluation run.
modelstringrequired
The model that is evaluated, if applicable.
namestringrequired
The name of the evaluation run.
created_atintegerrequired
Unix timestamp (in seconds) when the evaluation run was created.
report_urlstringrequired
The URL to the rendered evaluation run report on the UI dashboard.
result_countsobjectrequired
Counters summarizing the outcomes of the evaluation run.
per_model_usagearrayrequired
Usage statistics for each model during the evaluation run.
per_testing_criteria_resultsarrayrequired
Results per testing criteria applied during the evaluation run.
data_sourceobjectrequired
Information about the run's data source.
metadataobjectrequired
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
errorobjectrequired
An object representing an error response from the Eval API.
429Returned when the request is rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds a rate limit. The eval_id path parameter identifies the evaluation, and the run_id path parameter identifies the run to cancel.