Swagger Petstore - OpenAPI 3.0
GET/evals/{eval_id}

Retrieve an evaluation

Retrieves a specific evaluation by its identifier. Returns the complete evaluation structure including its data source configuration, testing criteria, and metadata. Use this to inspect an evaluation before running it or to verify its configuration.

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 rate limit is exceeded.
errorobjectrequired

Error handling

eval_id must identify an existing evaluation. A 429 is returned when the request rate limit is exceeded.