Skip to content
POST/api/v1/agents/governance

Register agent / check permission / detect poisoning

Action-discriminated on action. register -> {name,type,owner,...} (201). check-permission -> {agentId,resource,permissionAction}. detect-poisoning -> {agentId,memories[]}.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "action": "register",
  "identity": {},
  "agentId": "string",
  "resource": "string",
  "memories": [
    {
      "content": "string",
      "source": "string"
    }
  ],
  "projectId": "00000000-0000-0000-0000-000000000000"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "register",
            "check-permission",
            "detect-poisoning"
          ]
        },
        "identity": {
          "type": "object",
          "additionalProperties": {}
        },
        "agentId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "resource": {
          "type": "string",
          "maxLength": 200
        },
        "memories": {
          "maxItems": 1000,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "content": {
                "type": "string",
                "maxLength": 50000
              },
              "source": {
                "type": "string",
                "maxLength": 200
              }
            },
            "required": [
              "content",
              "source"
            ],
            "additionalProperties": false
          }
        },
        "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)$"
        }
      },
      "required": [
        "action"
      ],
      "additionalProperties": {}
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Action result (register returns 201).
201Created (register branch returns 201).
400(no description)
401(no description)
403Forbidden - insufficient role for this operation.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/agents/governance \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "register", "identity": {}, "agentId": "string", "resource": "string", "memories": [ { "content": "string", "source": "string" } ], "projectId": "00000000-0000-0000-0000-000000000000" }'

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/agents/governance", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "action": "register",
    "identity": {},
    "agentId": "string",
    "resource": "string",
    "memories": [
      {
        "content": "string",
        "source": "string"
      }
    ],
    "projectId": "00000000-0000-0000-0000-000000000000"
  }),
});
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/agents/governance",
    headers=headers,
    json={
    "action": "register",
    "identity": {},
    "agentId": "string",
    "resource": "string",
    "memories": [
        {
            "content": "string",
            "source": "string"
        }
    ],
    "projectId": "00000000-0000-0000-0000-000000000000"
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"action":"register","identity":{},"agentId":"string","resource":"string","memories":[{"content":"string","source":"string"}],"projectId":"00000000-0000-0000-0000-000000000000"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/agents/governance", 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

Other Evals endpoints