Skip to content
GET/api/v1/firewall/benchmark

Get latest firewall latency benchmark

Runs a LIVE benchmark on each call: executes FirewallEngine.scan() over a built-in 19-prompt adversarial corpus (replayed cyclically) and returns freshly measured latency { avg, p50, p90, p95, p99, min, max } in ms plus detection accuracy { total, blocked, allowed, TP/TN/FP/FN, precision, recall, f1 } and a per-CATEGORY breakdown (benign, prompt-injection, jailbreak, pii-leak, code-execution) of count/blocked/avg_latency_ms. Query: `n` sample count (default 200, max 2000), `warmup` iterations discarded before measuring (default 20, max 100), `layers` a comma-list of pattern,token,semantic,output,multi-turn selecting which engine layers run (default pattern,token,semantic; an unknown name returns 400 INVALID_LAYERS). No stored or CI-published baseline is returned — numbers vary per call with the host. Any authenticated caller; stateless, no project scope, no persistence.

Authentication

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

Response

200 example

{
  "success": true
}

All status codes

200Benchmark.
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 GET \
  https://evalguard.ai/api/v1/firewall/benchmark \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

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/firewall/benchmark", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
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']}"}

response = requests.request("GET", "https://evalguard.ai/api/v1/firewall/benchmark", headers=headers)
print(response.status_code, response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/firewall/benchmark", 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

400401403429500

Other Firewall endpoints