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

Register an AI asset

Registers a model/agent/app into the governance registry (role=admin, audited).

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",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "kind": "model",
  "description": "string",
  "owner": "string",
  "lifecycleStage": "dev",
  "riskTier": "minimal",
  "fragmentLinks": {
    "modelPricingKey": "string",
    "vendorId": "string",
    "aiSbomId": "string",
    "shadowAiSightingId": "string",
    "providerId": "string"
  },
  "tags": [
    "string"
  ]
}
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)$"
        },
        "projectId": {
          "nullable": true,
          "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)$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "kind": {
          "type": "string",
          "enum": [
            "model",
            "agent",
            "application",
            "dataset",
            "pipeline",
            "mcp_server",
            "knowledge_base"
          ]
        },
        "description": {
          "type": "string",
          "maxLength": 4000
        },
        "owner": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "lifecycleStage": {
          "default": "dev",
          "type": "string",
          "enum": [
            "dev",
            "staging",
            "prod",
            "retired"
          ]
        },
        "riskTier": {
          "default": "minimal",
          "type": "string",
          "enum": [
            "unacceptable",
            "high",
            "limited",
            "minimal"
          ]
        },
        "fragmentLinks": {
          "type": "object",
          "properties": {
            "modelPricingKey": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "vendorId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "aiSbomId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "shadowAiSightingId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "providerId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            }
          },
          "additionalProperties": false
        },
        "tags": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60
          }
        }
      },
      "required": [
        "orgId",
        "name",
        "kind",
        "owner",
        "lifecycleStage",
        "riskTier"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Registered.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
409Conflict — ASSET_EXISTS, CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/ai-assets \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "name": "string", "kind": "model", "description": "string", "owner": "string", "lifecycleStage": "dev", "riskTier": "minimal", "fragmentLinks": { "modelPricingKey": "string", "vendorId": "string", "aiSbomId": "string", "shadowAiSightingId": "string", "providerId": "string" }, "tags": [ "string" ] }'

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-assets", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "kind": "model",
    "description": "string",
    "owner": "string",
    "lifecycleStage": "dev",
    "riskTier": "minimal",
    "fragmentLinks": {
      "modelPricingKey": "string",
      "vendorId": "string",
      "aiSbomId": "string",
      "shadowAiSightingId": "string",
      "providerId": "string"
    },
    "tags": [
      "string"
    ]
  }),
});
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-assets",
    headers=headers,
    json={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "kind": "model",
    "description": "string",
    "owner": "string",
    "lifecycleStage": "dev",
    "riskTier": "minimal",
    "fragmentLinks": {
        "modelPricingKey": "string",
        "vendorId": "string",
        "aiSbomId": "string",
        "shadowAiSightingId": "string",
        "providerId": "string"
    },
    "tags": [
        "string"
    ]
},
)
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","projectId":"00000000-0000-0000-0000-000000000000","name":"string","kind":"model","description":"string","owner":"string","lifecycleStage":"dev","riskTier":"minimal","fragmentLinks":{"modelPricingKey":"string","vendorId":"string","aiSbomId":"string","shadowAiSightingId":"string","providerId":"string"},"tags":["string"]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/ai-assets", 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

400401403409429500

Other Compliance endpoints