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

Update an evaluation

Updates an evaluation's name or metadata. Supply either or both fields to change the corresponding evaluation properties; the request does not replace the data source configuration or testing criteria.

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

1 parameter · 2 body fields
eval_idstringrequired
The identifier of the evaluation to update.

Evaluation properties to update. Include name, metadata, or both.

namestringoptional
Rename the evaluation.
metadataobjectoptional
Metadata to attach to the evaluation, provided as an object of string key-value pairs, or null.

4 status codes
200Returns the updated evaluation, including its identifier, name, data source configuration, testing criteria, creation timestamp, and metadata.
objectstringrequired
The object type.
Allowed:evalDefault:eval
idstringrequired
Unique identifier for the evaluation.
namestringrequired
The name of the evaluation.
data_source_configobjectrequired
Configuration of data sources used in runs of the evaluation.
testing_criteriaarray<LabelModelGrader>required
A list of testing criteria.
created_atintegerrequired
The Unix timestamp (in seconds) for when the eval was created.
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.
400Returned when the evaluation name or metadata is invalid.
errorobjectrequired
404Returned when the evaluation is not found.
errorobjectrequired
429Returned when the request is rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 400 is returned when the evaluation name or metadata is invalid. A 404 is returned when the evaluation is not found. A 429 is returned when the request exceeds a rate limit. The eval_id path parameter must identify the evaluation you want to update.