POST/api/v1/prompts/experiments

Start a prompt experiment

Creates an experiment that evaluates N prompt variants against a dataset using selected scorers. Async — poll the experiment id for status.

Authentication

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

Request body required

Example

{
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "variants": [
    {
      "name": "string",
      "template": "string"
    }
  ],
  "scorers": [
    "string"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "dataset_id",
        "variants"
      ],
      "properties": {
        "dataset_id": {
          "type": "string",
          "format": "uuid"
        },
        "variants": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "template": {
                "type": "string"
              }
            }
          },
          "minItems": 2
        },
        "scorers": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Experiment started.
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/prompts/experiments \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "dataset_id": "00000000-0000-0000-0000-000000000000", "variants": [ { "name": "string", "template": "string" } ], "scorers": [ "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/prompts/experiments",
  body: {
    "dataset_id": "00000000-0000-0000-0000-000000000000",
    "variants": [
      {
        "name": "string",
        "template": "string"
      }
    ],
    "scorers": [
      "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/prompts/experiments",
    body={
    "dataset_id": "00000000-0000-0000-0000-000000000000",
    "variants": [
        {
            "name": "string",
            "template": "string"
        }
    ],
    "scorers": [
        "string"
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/prompts/experiments", map[string]any{"dataset_id": "00000000-0000-0000-0000-000000000000", "variants": []any{map[string]any{"name": "string", "template": "string"}}, "scorers": []any{"string"}})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401403429

Other Prompts endpoints