POST/api/v1/agents

Register an agent

Creates a new agent registration. Mass-assignment-safe (ADR-0017): only name, description, model, system_prompt, tools, memory_config accepted.

Authentication

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

Request body required

Example

{
  "name": "string",
  "model": "string",
  "system_prompt": "string",
  "tools": [
    {}
  ],
  "memory_config": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "name",
        "model"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "system_prompt": {
          "type": "string"
        },
        "tools": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "memory_config": {
          "type": "object"
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Agent created.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/agents \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "string", "model": "string", "system_prompt": "string", "tools": [ {} ], "memory_config": {} }'

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/agents",
  body: {
    "name": "string",
    "model": "string",
    "system_prompt": "string",
    "tools": [
      {}
    ],
    "memory_config": {}
  },
});
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/agents",
    body={
    "name": "string",
    "model": "string",
    "system_prompt": "string",
    "tools": [
        {}
    ],
    "memory_config": {}
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/agents", map[string]any{"name": "string", "model": "string", "system_prompt": "string", "tools": []any{map[string]any{}}, "memory_config": map[string]any{}})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401403429

Other Evals endpoints