Skip to content
POST/api/v1/benchmarks

Submit a benchmark run

Records a benchmark run result (a benchmark_runs row) and returns the saved row. Synchronous insert — not an async job.

Authentication

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

Request body required

Example

{
  "benchmark": "string",
  "model": "string",
  "scores": {},
  "totalScore": 0
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "benchmark": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "model": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "scores": {
          "type": "object",
          "additionalProperties": {},
          "description": "Optional per-task score map."
        },
        "totalScore": {
          "type": "number",
          "description": "Aggregate score (finite)."
        }
      },
      "required": [
        "benchmark",
        "model",
        "totalScore"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Benchmark run saved.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/benchmarks \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "benchmark": "string", "model": "string", "scores": {}, "totalScore": 0 }'

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/benchmarks",
  body: {
    "benchmark": "string",
    "model": "string",
    "scores": {},
    "totalScore": 0
  },
});
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/benchmarks",
    body={
    "benchmark": "string",
    "model": "string",
    "scores": {},
    "totalScore": 0
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"benchmark":"string","model":"string","scores":{},"totalScore":0}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/benchmarks", 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

400401429

Other Evals endpoints