Skip to content
POST/api/v1/agents

Submit agent trace steps

Ingests agent execution steps (NemoClaw plugin) into trace_spans. Requires projectId (query/body/header) and agentName; steps[] optional. Returns 201 with { traceId, sessionId, agentName, stepsReceived }. NOT an agent-registration endpoint.

Authentication

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

Request body required

Example

{
  "agentName": "<Agent display name. Required UNLESS the >",
  "agent_name": "string",
  "sessionId": "<snake_case alias session_id also accepte>",
  "session_id": "string",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "steps": [
    {}
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "agentName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Agent display name. Required UNLESS the snake_case alias agent_name is supplied — exactly one of agentName / agent_name is mandatory (400 MISSING_AGENT_NAME if both absent)."
        },
        "agent_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "sessionId": {
          "type": "string",
          "maxLength": 200,
          "description": "snake_case alias session_id also accepted; generated if omitted."
        },
        "session_id": {
          "type": "string",
          "maxLength": 200
        },
        "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)$",
          "description": "Required if not supplied via ?projectId or x-project-id header."
        },
        "steps": {
          "maxItems": 1000,
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "additionalProperties": {}
    }
  }
}

Response

200 example

{
  "traceId": "string",
  "sessionId": "string",
  "agentName": "string",
  "stepsReceived": 0
}

All status codes

200Steps ingested (returned with 201).
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 '{ "agentName": "<Agent display name. Required UNLESS the >", "agent_name": "string", "sessionId": "<snake_case alias session_id also accepte>", "session_id": "string", "projectId": "00000000-0000-0000-0000-000000000000", "steps": [ {} ] }'

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: {
    "agentName": "<Agent display name. Required UNLESS the >",
    "agent_name": "string",
    "sessionId": "<snake_case alias session_id also accepte>",
    "session_id": "string",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "steps": [
      {}
    ]
  },
});
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={
    "agentName": "<Agent display name. Required UNLESS the >",
    "agent_name": "string",
    "sessionId": "<snake_case alias session_id also accepte>",
    "session_id": "string",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "steps": [
        {}
    ]
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"agentName":"<Agent display name. Required UNLESS the >","agent_name":"string","sessionId":"<snake_case alias session_id also accepte>","session_id":"string","projectId":"00000000-0000-0000-0000-000000000000","steps":[{}]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/agents", 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

400401403429

Other Evals endpoints