/api/v1/regulatory-reportsGenerate a regulatory report
Creates a DRAFT regulatory report row for a project and framework. Body: projectId and framework required; `title` optional (defaults to `<framework> Report - <YYYY-MM-DD>`); `autoPopulate` optional — when true, up to 50 eval_runs, 50 security_scans and 50 compliance_checks from the project are attached as the report's `evidence` array. There is no period/date-range parameter and no report body is rendered: `sections` is created empty and `status` is 'draft'. Requires the admin role, compliance:create and the `compliance` plan feature. Returns 201 with the created row.
Authentication
Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.
Request body required
Example
{
"projectId": "string",
"framework": "string",
"title": "string",
"autoPopulate": false
}Schema
{
"application/json": {
"schema": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"framework": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"title": {
"type": "string",
"maxLength": 500
},
"autoPopulate": {
"type": "boolean"
}
},
"required": [
"projectId",
"framework"
],
"additionalProperties": {}
}
}
}Response
202 example
{
"job_id": "00000000-0000-0000-0000-000000000000"
}All status codes
Code samples
cURL
curl -X POST \
https://evalguard.ai/api/v1/regulatory-reports \
-H "Authorization: Bearer $EVALGUARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "projectId": "string", "framework": "string", "title": "string", "autoPopulate": false }'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/regulatory-reports", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"projectId": "string",
"framework": "string",
"title": "string",
"autoPopulate": false
}),
});
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/regulatory-reports",
headers=headers,
json={
"projectId": "string",
"framework": "string",
"title": "string",
"autoPopulate": False
},
)
print(response.status_code, response.json())Go
package main
import (
"context"
"fmt"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"projectId":"string","framework":"string","title":"string","autoPopulate":false}`)
req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/regulatory-reports", 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)
}