For AI agents: a documentation index is available at /llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Create Eval Run

Start a run on an existing eval that scores a dataset with the named graders. Poll Get Eval Run until its status is completed, then read its results.

Start a run on an existing eval that scores a dataset with the named graders. Poll Get Eval Run until its status is completed, then read its results.

posthttps://statsigapi.net/console/v1/evals/{name}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

namestringrequired

name

Body

application/json
namestringrequired

The Eval Run display name

Example:my_eval_run
Constraints:min length: 3max length: 100pattern: ^[a-zA-Z0-9_\-. ]*$
gradersstring[]required

The list of grader names

Example:["grader1","grader2"]
datasetstringrequired

The dataset name

Example:dataset1

Response

application/json
200· Create Eval Run
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
idstringrequired
namestringrequired
evalIDstringrequired
statusstringrequired

running until the run finishes, then completed, or failed when the run recorded an error.

Allowed values:runningcompletedfailed
createdTimenumberrequired
Constraints:format: double
finishTimenumberrequired
Constraints:format: doublenullable
runTimenumberrequired
Constraints:format: doublenullable
datasetIDstringrequired

Dataset the run scored. Null for runs posted from code through send_results.

Constraints:nullable
datasetItemCountnumberrequired
Constraints:format: double
graderIDsstring[]required
primaryEvalGraderIDstringrequired
Constraints:nullable
parametersobjectrequired
Constraints:nullable
errorReasonstringrequired
Constraints:nullable
403· Forbidden. The request was valid, but the server is refusing action. You might not have the necessary permissions to access the resource.
statusintegerrequired
Allowed values:403
messagestringrequired
404· Not Found. The requested resource could not be found.
statusintegerrequired
Allowed values:404
messagestringrequired

Was this helpful?