x-cpod-domain: agents

Agents

Platform agent registry — autonomous AI agents that can execute skills and workflows.

Try in explorer client.agents

Agent

An autonomous AI agent with defined capabilities and execution context.

REST path/api/v1/agents

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.agents.list()

// create:
await client.agents.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  name: "example name",
  app_id: "example app_id",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid→User	User id from the caller's JWT (sub).
updated_by	uuid→User	User id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid→User	User id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
name*	string	Agent name.
description	string	Agent description and capabilities.
type	enum	Agent execution mode.`autonomoussupervisedcollaborative`
status	enum	Agent status.`activeinactiveerror`
skills	json	List of skill IDs this agent can execute.
config	json	Agent configuration and parameters.
execution_context	json	Runtime context for agent execution.
permissions	json	Permission scopes granted to this agent.

Docs

Agent