Skip to content
POST/api/v1/evaluators

Create an evaluator version (content-hash deduped)

Creates a new version of a named evaluator. An identical definition to the latest version is deduped (returns the existing version). Set `activate` to make it the active version.

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",
  "definition": {
    "kind": "llm-judge",
    "config": {},
    "threshold": 0
  },
  "notes": "string",
  "activate": false,
  "numberValence": "positive"
}
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
        },
        "definition": {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "llm-judge",
                "code",
                "heuristic",
                "composite"
              ]
            },
            "config": {
              "default": {},
              "type": "object",
              "additionalProperties": {}
            },
            "threshold": {
              "type": "number",
              "minimum": 0,
              "maximum": 1
            }
          },
          "required": [
            "kind",
            "config"
          ],
          "additionalProperties": false
        },
        "notes": {
          "type": "string",
          "maxLength": 2000
        },
        "activate": {
          "type": "boolean"
        },
        "numberValence": {
          "type": "string",
          "enum": [
            "positive",
            "negative",
            "neutral"
          ]
        }
      },
      "required": [
        "projectId",
        "name",
        "definition"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

200Deduped — identical to the latest version
201Created

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/evaluators \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "name": "string", "definition": { "kind": "llm-judge", "config": {}, "threshold": 0 }, "notes": "string", "activate": false, "numberValence": "positive" }'

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/evaluators",
  body: {
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "definition": {
      "kind": "llm-judge",
      "config": {},
      "threshold": 0
    },
    "notes": "string",
    "activate": false,
    "numberValence": "positive"
  },
});
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/evaluators",
    body={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "definition": {
        "kind": "llm-judge",
        "config": {},
        "threshold": 0
    },
    "notes": "string",
    "activate": False,
    "numberValence": "positive"
},
)
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","definition":{"kind":"llm-judge","config":{},"threshold":0},"notes":"string","activate":false,"numberValence":"positive"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/evaluators", 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)
}

Other Evaluators endpoints