Update an agent (partial)
Partially updates an agent using JSON Merge Patch (RFC 7386).
Omitted fields are unchanged; null clears a field; arrays replace.
Authorizations
OAuth 2.0 / OIDC bearer token.
The tenant the request operates within.
Path Parameters
Agent identifier (prefixed UUIDv7).
Agent identifier. Accepts agt.<uuidv7> or a bare UUIDv7 on input; always returned prefixed.
^(agt\.)?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt.0192f4c8-2c5a-7b3e-9f1a-3c8d6e2b7a40"
Body
The fields to change, as a JSON Merge Patch (RFC 7386).
JSON Merge Patch body. Omitted fields are unchanged; null clears; connectors is replaced wholesale.
Note: the server currently honors only name, description, systemPrompt, model, and connectors. visibility, lifecycle, and labels are accepted but not yet persisted.
New agent name.
1 - 128"coder-v2"
New description; null clears it.
4096"Returns SNOMED CT codes for a clinical encounter."
New system prompt; null clears it.
"Respond with only the SNOMED CT code."
New model identifier; null falls back to the tenant default.
"corti-default"
private— creator / service principal only.unlisted— usable by ID, hidden from list results.public— listed tenant-wide.
private, unlisted, public "private"
ephemeral— short-lived; expired automatically.persistent— retained until explicitly deleted.
ephemeral, persistent Replacement connector list; null clears connectors.
Same envelope as Connector but without the server-generated id.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Replacement labels; null clears labels.
Response
The updated agent.
A configured agent — its metadata, model, and attached connectors.
Agent identifier. Accepts agt.<uuidv7> or a bare UUIDv7 on input; always returned prefixed.
^(agt\.)?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt.0192f4c8-2c5a-7b3e-9f1a-3c8d6e2b7a40"
Human-readable, unique-per-tenant agent name.
1 - 128private— creator / service principal only.unlisted— usable by ID, hidden from list results.public— listed tenant-wide.
private, unlisted, public "private"
ephemeral— short-lived; expired automatically.persistent— retained until explicitly deleted.
ephemeral, persistent Connectors attached to the agent, discriminated by type.
A connector attached to an agent, discriminated by type.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
When the agent was created.
When the agent was last updated.
Principal (user or service principal) that created the agent.
^(usr\.)?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"usr.0192f4c8-8bc0-7194-8570-92e3ce81d0a6"
Free-form agent description shown to users and in tooling.
4096System prompt prepended to every invocation.
Model identifier. Tenant default if omitted or null.
Open question — in the current implementation a model is configured per expert, not per agent (Expert.modelName), and an Agent has no model field at all. The desired end state is that there is no distinction between an expert and an agent, so model lives uniformly on this resource. Until that convergence lands, the precedence of an agent-level model over a connector/expert-level override is undecided and MUST be resolved before this field ships.
"corti-default"
Free-form string → string metadata for filtering and organisation. Not used for routing or auth.