Sample - OpenAI API
GET/evals/{eval_id}

Get an evaluation

Retrieves a single evaluation by its identifier. Use eval_id to inspect the evaluation's data source configuration and testing criteria before creating runs or updating its name and metadata.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
eval_idstringrequired
The unique identifier of the evaluation to retrieve.

2 status codes
200Returns the evaluation object with 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.
429Returned when the request is rejected because the rate limit has been exceeded.
errorobjectrequired

Error handling

eval_id must identify the evaluation to retrieve. A 429 is returned when the request is rejected because the rate limit has been exceeded.