Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132429592.7 MB
Evals

Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.

post/evals/{eval_id}/runs

Path parameters

eval_idstring required

The ID of the evaluation to create a run for.

Request body

namestring

The name of the run.

metadataMetadata nullable

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.

Response

Successfully created a run for the evaluation

object'eval.run' required

The type of the object. Always "eval.run".

idstring required

Unique identifier for the evaluation run.

eval_idstring required

The identifier of the associated evaluation.

statusstring required

The status of the evaluation run.

modelstring required

The model that is evaluated, if applicable.

namestring required

The name of the evaluation run.

created_atinteger required

Unix timestamp (in seconds) when the evaluation run was created.

report_urlstring uri required

The URL to the rendered evaluation run report on the UI dashboard.

metadataMetadata nullable required

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.