POST
/api/v1/ai-sbomSubmit AI-BoM artifact
Upserts the project's AI inventory from a submitted JSON body (e.g. from a CI pipeline): `models[]` into `model_inventory` (unique on project + name + version) and `dependencies[]` into `ai_dependencies` (unique on project + name + version). The body is validated against this endpoint's own schema — it does NOT accept or validate a CycloneDX or SPDX document; use GET with `?format=` to EXPORT one. Returns 201 with `{ message, projectId }`. Requires the `compliance` plan feature.
Authentication
Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.
Request body required
Example
{
"projectId": "00000000-0000-0000-0000-000000000000",
"models": [
{
"name": "string",
"version": "string",
"provider": "string",
"architecture": "string",
"trainingData": "string",
"license": "string",
"riskScore": 0
}
],
"dependencies": [
{
"name": "string",
"version": "string",
"license": "string",
"vulnerabilities": [
"string"
],
"riskLevel": "low"
}
]
}Schema
{
"application/json": {
"schema": {
"type": "object",
"properties": {
"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)$"
},
"models": {
"maxItems": 2000,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"version": {
"type": "string",
"maxLength": 100
},
"provider": {
"type": "string",
"maxLength": 120
},
"architecture": {
"type": "string",
"maxLength": 200
},
"trainingData": {
"type": "string",
"maxLength": 2000
},
"license": {
"type": "string",
"maxLength": 200
},
"riskScore": {
"type": "number",
"minimum": 0,
"maximum": 10
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"dependencies": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"version": {
"type": "string",
"maxLength": 100
},
"license": {
"type": "string",
"maxLength": 200
},
"vulnerabilities": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"riskLevel": {
"type": "string",
"enum": [
"low",
"medium",
"high",
"critical"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": [
"projectId"
],
"additionalProperties": false
}
}
}Response
200 example
{
"success": true
}All status codes
200Accepted.
201Created.
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.
Code samples
cURL
curl -X POST \
https://evalguard.ai/api/v1/ai-sbom \
-H "Authorization: Bearer $EVALGUARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "projectId": "00000000-0000-0000-0000-000000000000", "models": [ { "name": "string", "version": "string", "provider": "string", "architecture": "string", "trainingData": "string", "license": "string", "riskScore": 0 } ], "dependencies": [ { "name": "string", "version": "string", "license": "string", "vulnerabilities": [ "string" ], "riskLevel": "low" } ] }'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/ai-sbom", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"projectId": "00000000-0000-0000-0000-000000000000",
"models": [
{
"name": "string",
"version": "string",
"provider": "string",
"architecture": "string",
"trainingData": "string",
"license": "string",
"riskScore": 0
}
],
"dependencies": [
{
"name": "string",
"version": "string",
"license": "string",
"vulnerabilities": [
"string"
],
"riskLevel": "low"
}
]
}),
});
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/ai-sbom",
headers=headers,
json={
"projectId": "00000000-0000-0000-0000-000000000000",
"models": [
{
"name": "string",
"version": "string",
"provider": "string",
"architecture": "string",
"trainingData": "string",
"license": "string",
"riskScore": 0
}
],
"dependencies": [
{
"name": "string",
"version": "string",
"license": "string",
"vulnerabilities": [
"string"
],
"riskLevel": "low"
}
]
},
)
print(response.status_code, response.json())Go
package main
import (
"context"
"fmt"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","models":[{"name":"string","version":"string","provider":"string","architecture":"string","trainingData":"string","license":"string","riskScore":0}],"dependencies":[{"name":"string","version":"string","license":"string","vulnerabilities":["string"],"riskLevel":"low"}]}`)
req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/ai-sbom", 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