Skip to content
POST/api/v1/ai-sbom

Submit AI-BoM artifact

External submission of an AI-BoM (e.g., from a CI pipeline that builds the org's AI artifacts). Validates CycloneDX schema.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/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.
400(no description)
401(no description)
429(no description)

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

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/ai-sbom",
  body: {
    "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(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/ai-sbom",
    body={
    "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)

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

400401429

Other Security endpoints