Skip to content
POST/api/v1/security/assessment

Start a red-team assessment

Starts a comprehensive red-team assessment using registered attack plugins and strategies. Runs asynchronously -- poll with GET to check progress.

Authentication

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

Request body required

Example

{
  "targetName": "<Name of the target system>",
  "systemPrompt": "<System prompt to attack>",
  "modelName": "<Model to test against>",
  "maxConcurrent": 5
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "targetName",
        "systemPrompt",
        "modelName",
        "plugins"
      ],
      "properties": {
        "targetName": {
          "type": "string",
          "description": "Name of the target system"
        },
        "systemPrompt": {
          "type": "string",
          "description": "System prompt to attack"
        },
        "modelName": {
          "type": "string",
          "description": "Model to test against"
        },
        "plugins": {
          "description": "Plugin list or \"all\""
        },
        "strategies": {
          "description": "Strategy list or \"none\""
        },
        "maxConcurrent": {
          "type": "integer",
          "default": 5
        }
      }
    }
  }
}

Response

All status codes

201Assessment started
400Bad Request — MISSING_ORG_ID, PROVIDER_KEY_MISSING, PROVIDER_UNSUPPORTED, VALIDATION_ERROR.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
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/security/assessment \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "targetName": "<Name of the target system>", "systemPrompt": "<System prompt to attack>", "modelName": "<Model to test against>", "maxConcurrent": 5 }'

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/security/assessment", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "targetName": "<Name of the target system>",
    "systemPrompt": "<System prompt to attack>",
    "modelName": "<Model to test against>",
    "maxConcurrent": 5
  }),
});
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/security/assessment",
    headers=headers,
    json={
    "targetName": "<Name of the target system>",
    "systemPrompt": "<System prompt to attack>",
    "modelName": "<Model to test against>",
    "maxConcurrent": 5
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"targetName":"<Name of the target system>","systemPrompt":"<System prompt to attack>","modelName":"<Model to test against>","maxConcurrent":5}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/security/assessment", 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 Security endpoints