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

Generate a red-team report from an assessment

Generates (and caches) a red-team report for an assessmentId. If assessmentResult is supplied it is used directly; otherwise the result is fetched from the assessment endpoint (must be completed).

Authentication

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

Request body required

Example

{
  "assessmentId": "<Assessment id to report on.>",
  "assessmentResult": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "assessmentId"
      ],
      "properties": {
        "assessmentId": {
          "type": "string",
          "description": "Assessment id to report on."
        },
        "assessmentResult": {
          "type": "object",
          "description": "Optional AssessmentResult to generate from directly."
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Existing cached report.
201Report generated.
400(no description)
401(no description)
404Assessment not found or not yet completed.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/security/report \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "assessmentId": "<Assessment id to report on.>", "assessmentResult": {} }'

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/security/report",
  body: {
    "assessmentId": "<Assessment id to report on.>",
    "assessmentResult": {}
  },
});
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/security/report",
    body={
    "assessmentId": "<Assessment id to report on.>",
    "assessmentResult": {}
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"assessmentId":"<Assessment id to report on.>","assessmentResult":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/security/report", 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

400401404429

Other Security endpoints