POST
/api/v1/compliance/checkRun a compliance check against a framework
Runs a full compliance assessment for an org against the selected framework by exercising the target model (BYOK apiKey/provider/baseUrl). Persists the assessment and returns per-requirement results + the assessmentId. Synchronous.
Authentication
Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.
Request body required
Example
{
"orgId": "00000000-0000-0000-0000-000000000000",
"framework": "<Framework id from ENHANCED_FRAMEWORK_REG>",
"model": "string",
"provider": "string",
"systemPrompt": "string",
"apiKey": "<Caller-supplied LLM credential.>",
"baseUrl": "https://example.com",
"projectId": "00000000-0000-0000-0000-000000000000",
"categories": [
"string"
],
"manualEvidence": [
{
"requirementId": "string",
"status": "met",
"evidence": "string",
"assessedBy": "string",
"assessedAt": "string"
}
],
"previousAssessmentId": "00000000-0000-0000-0000-000000000000",
"timeout": 1000
}Schema
{
"application/json": {
"schema": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"framework": {
"type": "string",
"minLength": 1,
"maxLength": 120,
"description": "Framework id from ENHANCED_FRAMEWORK_REGISTRY."
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"provider": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"systemPrompt": {
"type": "string",
"minLength": 1,
"maxLength": 100000
},
"apiKey": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"description": "Caller-supplied LLM credential."
},
"baseUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"categories": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 120
}
},
"manualEvidence": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"requirementId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"met",
"partial",
"not-met"
]
},
"evidence": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"assessedBy": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"assessedAt": {
"type": "string",
"maxLength": 40
}
},
"required": [
"requirementId",
"status",
"evidence",
"assessedBy"
],
"additionalProperties": false
}
},
"previousAssessmentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"timeout": {
"type": "integer",
"minimum": 1000,
"maximum": 600000
}
},
"required": [
"orgId",
"framework",
"model",
"provider",
"systemPrompt",
"apiKey"
],
"additionalProperties": false
}
}
}Response
201 example
{
"success": true
}All status codes
201Assessment result + assessmentId.
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.
404Not Found — NOT_FOUND.
429(no description)
500Internal Server Error — CHECK_FAILED, EVIDENCE_PERSIST_FAILED.
Code samples
cURL
curl -X POST \
https://evalguard.ai/api/v1/compliance/check \
-H "Authorization: Bearer $EVALGUARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "orgId": "00000000-0000-0000-0000-000000000000", "framework": "<Framework id from ENHANCED_FRAMEWORK_REG>", "model": "string", "provider": "string", "systemPrompt": "string", "apiKey": "<Caller-supplied LLM credential.>", "baseUrl": "https://example.com", "projectId": "00000000-0000-0000-0000-000000000000", "categories": [ "string" ], "manualEvidence": [ { "requirementId": "string", "status": "met", "evidence": "string", "assessedBy": "string", "assessedAt": "string" } ], "previousAssessmentId": "00000000-0000-0000-0000-000000000000", "timeout": 1000 }'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/compliance/check", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"orgId": "00000000-0000-0000-0000-000000000000",
"framework": "<Framework id from ENHANCED_FRAMEWORK_REG>",
"model": "string",
"provider": "string",
"systemPrompt": "string",
"apiKey": "<Caller-supplied LLM credential.>",
"baseUrl": "https://example.com",
"projectId": "00000000-0000-0000-0000-000000000000",
"categories": [
"string"
],
"manualEvidence": [
{
"requirementId": "string",
"status": "met",
"evidence": "string",
"assessedBy": "string",
"assessedAt": "string"
}
],
"previousAssessmentId": "00000000-0000-0000-0000-000000000000",
"timeout": 1000
}),
});
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/compliance/check",
headers=headers,
json={
"orgId": "00000000-0000-0000-0000-000000000000",
"framework": "<Framework id from ENHANCED_FRAMEWORK_REG>",
"model": "string",
"provider": "string",
"systemPrompt": "string",
"apiKey": "<Caller-supplied LLM credential.>",
"baseUrl": "https://example.com",
"projectId": "00000000-0000-0000-0000-000000000000",
"categories": [
"string"
],
"manualEvidence": [
{
"requirementId": "string",
"status": "met",
"evidence": "string",
"assessedBy": "string",
"assessedAt": "string"
}
],
"previousAssessmentId": "00000000-0000-0000-0000-000000000000",
"timeout": 1000
},
)
print(response.status_code, response.json())Go
package main
import (
"context"
"fmt"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","framework":"<Framework id from ENHANCED_FRAMEWORK_REG>","model":"string","provider":"string","systemPrompt":"string","apiKey":"<Caller-supplied LLM credential.>","baseUrl":"https://example.com","projectId":"00000000-0000-0000-0000-000000000000","categories":["string"],"manualEvidence":[{"requirementId":"string","status":"met","evidence":"string","assessedBy":"string","assessedAt":"string"}],"previousAssessmentId":"00000000-0000-0000-0000-000000000000","timeout":1000}`)
req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/compliance/check", 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
400401403404429500