Skip to main content
This guide shows you how to create and configure an agent with connectors, metadata, and labels. You will learn the full agent CRUD lifecycle using the v2 Agentic API.

Prerequisites

Create a minimal agent

The simplest agent has just a name. All other fields are optional:
The response includes the agent’s 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 visibility and labels fields are in private preview — accepted by the API but not yet persisted. All agents are returned as visibility: "private" and labels are silently dropped.
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:
The visibility, lifecycle, label, and q listing filters are in private preview — accepted by the API but silently ignored. Only pageSize and pageToken are functional.

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:
The connectors array in a PATCH replaces the entire list. To modify individual connectors without replacing the whole array, use the connector sub-resource endpoints.
The server currently honors only name, description, systemPrompt, model, and connectors in PATCH requests. The visibility, lifecycle, and labels fields are accepted but not yet persisted.

Delete an agent

Deleting a persistent agent is irreversible. Ephemeral agents expire automatically.

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