Skip to main content
PATCH
Update agent
Read Get agent, then send its revision as expectedRevision, the fields to change, and an Idempotency-Key. Omitted fields stay unchanged. Use avatarUrl: null to clear an image. A stale revision or handle conflict returns 409; reread and review the change before retrying with a new key.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string
required

Stable key for this exact mutation. Reusing it with different input returns 409.

Required string length: 1 - 200

Path Parameters

agentId
string
required

Body

application/json
expectedRevision
integer
required
Required range: 1 <= x <= 2147483647
handle
string
Pattern: ^[a-z0-9](?:[a-z0-9-]{0,39}[a-z0-9])?$
name
string
Required string length: 1 - 160
description
string
Maximum string length: 5000
avatarUrl
string<uri> | null
Maximum string length: 2000
visibility
enum<string>
Available options:
PRIVATE,
RESTRICTED,
PUBLIC

Response

Current owner-scoped result. A mutation retry returns its saved response.

agent
object
required
Last modified on October 19, 2026