Skip to main content
PUT
/
v1
/
agents
/
{agent_id}
Update Agent
curl --request PUT \
  --url https://api.agenthuman.com/v1/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "avatar_image_url": {},
  "voice_agent": {}
}
'
{
  "success": true,
  "agent": {
    "agent_id": "agnt_01J8ZK4R2N5M6P7Q8W4T",
    "name": "Updated Agent Name",
    "avatar_image_url": "https://cdn.example.com/avatars/new.jpg",
    "created_at": "2024-01-15T10:00:00Z",
    "voice_agent": {
      "provider": "ElevenLabs",
      "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
      "auth_method": "api_key"
    }
  }
}
All fields are optional. Only fields included in the request body will be updated. For voice_agent, fields are merged with the existing values — you can update individual sub-fields without overwriting others.

Path Parameters

agent_id
string
required
The unique agent identifier (starts with agnt_).

Body

name
string
New display name for the agent. Must be a non-empty string.
avatar_image_url
string | null
New avatar image URL. Pass null to remove the avatar.
voice_agent
object
Partial voice AI configuration update. Only provided fields are changed.
  • provider (string, optional): New provider name
  • agent_id (string, optional): New provider agent ID
  • auth_method (string, optional): One of public, api_key or token

Response

success
boolean
Whether the update was successful.
agent
object
The updated Agent object.
{
  "success": true,
  "agent": {
    "agent_id": "agnt_01J8ZK4R2N5M6P7Q8W4T",
    "name": "Updated Agent Name",
    "avatar_image_url": "https://cdn.example.com/avatars/new.jpg",
    "created_at": "2024-01-15T10:00:00Z",
    "voice_agent": {
      "provider": "ElevenLabs",
      "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
      "auth_method": "api_key"
    }
  }
}