Skip to Content

Agents

Agents represent registered AI agents within your tenant. Each agent has a unique identifier and metadata used for behavioral fingerprinting and filtering.

POST/v1/agents

Register a new agent.

Request body:

FieldTypeRequiredDescription
agentIdstringYesUnique identifier (1–128 chars, alphanumeric, hyphens, underscores)
namestringYesDisplay name (1–256 chars)
descriptionstringNoAgent description (max 1024 chars)
frameworkstringNoAI framework (e.g. "langchain", "crewai") (max 128 chars)
environmentstringNoDeployment environment (max 64 chars)
integrationModestringNoOne of: collector, sdk, http, sidecar

Agent creation is subject to plan quotas. Free plans are limited to 1 agent; Pro plans allow more.


GET/v1/agents

List all registered agents.


GET/v1/agents/:id

Get a single agent by UUID.

Returns 404 if the agent does not exist or belongs to another tenant.


PATCH/v1/agents/:id

Update agent metadata. Only supplied fields are changed.

Request body: Same fields as POST, all optional.


GET/v1/agents/:id/sessions

List sessions for a specific agent.

Query parameters:

ParamTypeDefaultDescription
limitnumber20Results per page (1–100)
cursorstringPagination cursor from nextCursor
Last updated on