Skip to content
POST/api/v1/prompts/experiments

Create a prompt experiment or tag

type='tag' attaches a tag to a prompt version; otherwise (default) creates a multi-version experiment with auto-computed equal traffic splits.

Authentication

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

Request body required

Schema
{
  "application/json": {
    "schema": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "type",
            "promptName",
            "version",
            "tag"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "tag"
              ]
            },
            "promptName": {
              "type": "string"
            },
            "version": {
              "type": "integer"
            },
            "tag": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "name",
            "promptName",
            "promptVersions"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "experiment"
              ],
              "description": "Default when omitted."
            },
            "name": {
              "type": "string"
            },
            "promptName": {
              "type": "string"
            },
            "promptVersions": {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "integer"
              }
            },
            "description": {
              "type": "string"
            },
            "datasetId": {
              "type": "string",
              "format": "uuid"
            }
          }
        }
      ],
      "discriminator": {
        "propertyName": "type"
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Experiment or tag created.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/prompts/experiments \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \

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",
});
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")
print(response)

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/prompts/experiments", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401429

Other Prompts endpoints