Skip to content
POST/api/v1/evals/yaml/validate

Lint a YAML eval document

Parses + validates an eval defined in the EvalGuard YAML DSL. Body: `yaml` (1..262,144 chars, required) and optional `orgId`. Returns HTTP 200 either way — valid=true with the typed doc (id, version, description, model, scorerCount, caseCount, scorers) plus non-fatal warnings, or valid=false with errors. Responses are `Cache-Control: no-store`. No execution happens — this is the dashboard's 'is my YAML correct?' check. To run, post the compiled config to POST /api/v1/evals, then poll GET /api/v1/evals/{runId}.

Authentication

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

Request body required

Example

{
  "yaml": "string",
  "orgId": "00000000-0000-0000-0000-000000000000"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "yaml": {
          "type": "string",
          "minLength": 1,
          "maxLength": 262144
        },
        "orgId": {
          "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)$"
        }
      },
      "required": [
        "yaml"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

200Lint result with valid/errors/warnings/doc
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/evals/yaml/validate \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "yaml": "string", "orgId": "00000000-0000-0000-0000-000000000000" }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/evals/yaml/validate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "yaml": "string",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/evals/yaml/validate",
    headers=headers,
    json={
    "yaml": "string",
    "orgId": "00000000-0000-0000-0000-000000000000"
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"yaml":"string","orgId":"00000000-0000-0000-0000-000000000000"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/evals/yaml/validate", 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

400401403429500

Other Evaluations endpoints