Prerequisites
- An access token or client credentials
- Your tenant name
- Basic understanding of connectors and core concepts
Create a minimal agent
The simplest agent has just a name. All other fields are optional:id (a prefixed UUIDv7), visibility (default: private), lifecycle (default: ephemeral), and an empty connectors array.
Create an agent with connectors
To make an agent useful, attach connectors at creation time:The
model field is supported in the v2 API. In the current implementation, a model is configured per connector rather than per agent; the precedence of an agent-level model over connector-level models is being finalized.List agents
Filter agents by visibility, lifecycle, labels, or free-text search:Get a single agent
Patch an agent
Use JSON Merge Patch to update an agent. Omitted fields are unchanged;null clears; connectors is replaced wholesale:
Delete an agent
Common patterns
Ephemeral vs. persistent
- Ephemeral (
lifecycle: "ephemeral"): Short-lived agents that expire automatically. Good for one-off tasks and testing. - Persistent (
lifecycle: "persistent"): Retained until explicitly deleted. Good for production agents.
Private vs. public
- Private (
visibility: "private"): Only the creator can use the agent. - Unlisted (
visibility: "unlisted"): Usable by anyone who knows the ID, but hidden from list results. - Public (
visibility: "public"): Listed tenant-wide.
Next steps
- Learn how to send a message to your agent
- Learn how to manage connectors individually
- Read about connector auth for outbound connectors