Skip to navigation
Workspace APIWorkspace Agents

Update an agent identity

View as Markdown

Partially updates the agent identity — name, role, handle, avatar, visibility. The version config is edited through PUT /agents/:agentRef/draft instead. Authorization: organization administrators only. 409 handle_taken if the requested handle is used by another agent. A private agent is visible only to its owner; every other caller gets 404. Response: { data: { agent, draft, published } }.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agentRefstringRequired

Request

This endpoint expects an object.
namestringOptional1-200 characters
rolestringOptional<=200 characters
handlestringOptionalformat: "^[a-z0-9][a-z0-9-]{0,30}[a-z0-9]$"2-32 characters
avatarobjectOptional
visibilityenumOptional
Allowed values:

Response

The updated agent.
dataobject

Errors

404
Not Found Error
409
Conflict Error