---
title: Create Eval Run
description: "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."
product: general
lang: en
token_estimate: 1462
---
# Create Eval Run

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

## Create Eval Run

**POST** `/console/v1/evals/{name}`

Full URL: `https://statsigapi.net/console/v1/evals/{name}`

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.

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| STATSIG-API-KEY | string | Yes | — | apiKey (header) |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| name (path) | string | Yes | — | name |

## Body (application/json)

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| name | string | Yes | my_eval_run | The Eval Run display name Constraints: min length: 3, max length: 100, pattern: ^[a-zA-Z0-9_\-. ]*$ |
| graders | string[] | Yes | ["grader1","grader2"] | The list of grader names |
| dataset | string | Yes | dataset1 | The dataset name |

## Response (application/json)

**200** — Create Eval Run

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| message | string | Yes | — | A simple string explaining the result of the operation. |
| data | object | Yes | — | — |
| data.id | string | Yes | — | — |
| data.name | string | Yes | — | — |
| data.evalID | string | Yes | — | — |
| data.status | string | Yes | — | running until the run finishes, then completed, or failed when the run recorded an error. Allowed values: running, completed, failed |
| data.createdTime | number | Yes | — | Constraints: format: double |
| data.finishTime | number | Yes | — | Constraints: format: double, nullable |
| data.runTime | number | Yes | — | Constraints: format: double, nullable |
| data.datasetID | string | Yes | — | Dataset the run scored. Null for runs posted from code through send_results. Constraints: nullable |
| data.datasetItemCount | number | Yes | — | Constraints: format: double |
| data.graderIDs | string[] | Yes | — | — |
| data.primaryEvalGraderID | string | Yes | — | Constraints: nullable |
| data.parameters | object | Yes | — | Constraints: nullable |
| data.errorReason | string | Yes | — | Constraints: nullable |

```json
{
  "message": "string",
  "data": {
    "id": "string",
    "name": "string",
    "evalID": "string",
    "status": "running",
    "createdTime": 0,
    "finishTime": 0,
    "runTime": 0,
    "datasetID": "string",
    "datasetItemCount": 0,
    "graderIDs": [
      "string"
    ],
    "primaryEvalGraderID": "string",
    "parameters": {},
    "errorReason": "string"
  }
}
```

**403** — Forbidden. The request was valid, but the server is refusing action. You might not have the necessary permissions to access the resource.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| status | integer | Yes | — | Allowed values: 403 |
| message | string | Yes | — | — |

```json
{
  "status": 403,
  "message": "Forbidden. The request was valid, but the server is refusing action. You might not have the necessary permissions to access the resource."
}
```

**404** — Not Found. The requested resource could not be found.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| status | integer | Yes | — | Allowed values: 404 |
| message | string | Yes | — | — |

```json
{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}
```

## Code samples

### cURL

```bash
curl -X POST "https://statsigapi.net/console/v1/evals/{name}" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.post(
    "https://statsigapi.net/console/v1/evals/{name}",
    headers={
        "Content-Type": "application/json",
        "STATSIG-API-KEY": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://statsigapi.net/console/v1/evals/{name}", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "STATSIG-API-KEY": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://statsigapi.net/console/v1/evals/{name}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "STATSIG-API-KEY: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("POST", "https://statsigapi.net/console/v1/evals/{name}", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("STATSIG-API-KEY", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://statsigapi.net/console/v1/evals/{name}"))
      .method("POST", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("STATSIG-API-KEY", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://statsigapi.net/console/v1/evals/{name}")
request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["STATSIG-API-KEY"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```