Skip to content
POST/api/v1/experiments

Create experiment

Starts a new experiment with the given variants. Idempotent (ADR-0024).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "source": "manual",
  "models": [
    "string"
  ],
  "scorers": [
    "string"
  ],
  "cases": [
    {
      "input": "string",
      "expectedOutput": "string"
    }
  ],
  "csvContent": "string",
  "traceIds": [
    "string"
  ],
  "datasetId": "00000000-0000-0000-0000-000000000000",
  "datasetVersionId": "00000000-0000-0000-0000-000000000000",
  "split": "string",
  "groupId": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "source": {
          "type": "string",
          "enum": [
            "manual",
            "csv",
            "traces",
            "dataset",
            "dataset_version"
          ]
        },
        "models": {
          "minItems": 1,
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 200
          }
        },
        "scorers": {
          "minItems": 1,
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "cases": {
          "maxItems": 10000,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "input": {
                "type": "string",
                "maxLength": 100000
              },
              "expectedOutput": {
                "type": "string",
                "maxLength": 100000
              }
            },
            "required": [
              "input"
            ],
            "additionalProperties": false
          }
        },
        "csvContent": {
          "type": "string",
          "maxLength": 5242880
        },
        "traceIds": {
          "maxItems": 10000,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 200
          }
        },
        "datasetId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "datasetVersionId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "split": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "pattern": "^[\\w.-]+$"
        },
        "groupId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        }
      },
      "required": [
        "projectId",
        "name",
        "source",
        "models",
        "scorers"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Experiment created.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/experiments \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "name": "string", "source": "manual", "models": [ "string" ], "scorers": [ "string" ], "cases": [ { "input": "string", "expectedOutput": "string" } ], "csvContent": "string", "traceIds": [ "string" ], "datasetId": "00000000-0000-0000-0000-000000000000", "datasetVersionId": "00000000-0000-0000-0000-000000000000", "split": "string", "groupId": "string" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/experiments",
  body: {
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "source": "manual",
    "models": [
      "string"
    ],
    "scorers": [
      "string"
    ],
    "cases": [
      {
        "input": "string",
        "expectedOutput": "string"
      }
    ],
    "csvContent": "string",
    "traceIds": [
      "string"
    ],
    "datasetId": "00000000-0000-0000-0000-000000000000",
    "datasetVersionId": "00000000-0000-0000-0000-000000000000",
    "split": "string",
    "groupId": "string"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/experiments",
    body={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "source": "manual",
    "models": [
        "string"
    ],
    "scorers": [
        "string"
    ],
    "cases": [
        {
            "input": "string",
            "expectedOutput": "string"
        }
    ],
    "csvContent": "string",
    "traceIds": [
        "string"
    ],
    "datasetId": "00000000-0000-0000-0000-000000000000",
    "datasetVersionId": "00000000-0000-0000-0000-000000000000",
    "split": "string",
    "groupId": "string"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","name":"string","source":"manual","models":["string"],"scorers":["string"],"cases":[{"input":"string","expectedOutput":"string"}],"csvContent":"string","traceIds":["string"],"datasetId":"00000000-0000-0000-0000-000000000000","datasetVersionId":"00000000-0000-0000-0000-000000000000","split":"string","groupId":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/experiments", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Evals endpoints