Skip to main content
PATCH
Update an agent and atomically replace its attachment set

Authorizations

X-Api-Key
string
header
required

Workspace API key, created in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Agent UUID. Missing, inaccessible, and malformed IDs return an opaque 404.

Body

application/json
workspaceId
string<uuid>

Optional for workspace-scoped API keys.

name
string
Required string length: 1 - 255
color
string
Required string length: 1 - 64
avatar
string

Avatar id. Omit on create for a random emoji; null is rejected.

Pattern: ^(emojis|apps|other)/[a-z0-9-]{1,64}$
description
string | null
Maximum string length: 4096
model
string

Provider-qualified model id, for example deepseek/deepseek-flash (the default), openai/gpt-6-luna or anthropic/claude-opus-5-5. auto is accepted as an alias for the default model and is stored as deepseek/deepseek-flash.

Required string length: 1 - 255
devices
object[]

An agent uses at most one device. Supplying the array replaces the current attachment atomically (single RPC) — this is the "move my agent to another phone" flow. At most one entry is accepted; a second is rejected with a 400.

Maximum array length: 1

Response

Agent updated

data
object
required