Skip to content
POST/api/v1/generators/rag-auto-eval

Auto-generate RAG eval suite

Synthesizes a RAG-evaluation test suite from a knowledge corpus: generates question-answer pairs, ground-truth references, scorer config (faithfulness / context-relevance / answer-correctness).

Authentication

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

Request body required

Example

{
  "corpus_id": "00000000-0000-0000-0000-000000000000",
  "sample_count": 50
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "corpus_id"
      ],
      "properties": {
        "corpus_id": {
          "type": "string",
          "format": "uuid"
        },
        "sample_count": {
          "type": "integer",
          "default": 50
        }
      }
    }
  }
}

Response

202 example

{
  "job_id": "00000000-0000-0000-0000-000000000000"
}

All status codes

202Generation queued.
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/generators/rag-auto-eval \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "corpus_id": "00000000-0000-0000-0000-000000000000", "sample_count": 50 }'

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/generators/rag-auto-eval",
  body: {
    "corpus_id": "00000000-0000-0000-0000-000000000000",
    "sample_count": 50
  },
});
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/generators/rag-auto-eval",
    body={
    "corpus_id": "00000000-0000-0000-0000-000000000000",
    "sample_count": 50
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"corpus_id":"00000000-0000-0000-0000-000000000000","sample_count":50}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/generators/rag-auto-eval", 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