Skip to main content
PUT
/
agent
/
update-description
{
    "agentId": "2fe35eeb-5aa6-4564-94c2-2ce44e65625d",
    "description": "New Description"
}

{
    "status": "success",
    "message": "Agent 2fe35eeb-5aa6-4564-94c2-2ce44e65625d description updated",
    "agentId": "2fe35eeb-5aa6-4564-94c2-2ce44e65625d",
    "description": "New Description"
}
This endpoint is used to update the description of an agent.

​
Request Parameters

​
agentId
string
required
The unique identifier for the agent (UUID format)
​
description
string
required
The new description for the agent

​
Response

​
status
string
Status of the operation (e.g., “success”)
​
message
string
Success message indicating the agent description was updated
​
agentId
string
The agent ID that was updated (UUID format)
​
description
string
The updated agent description

​
Behavior

  • Updates the description for the specified agent in our internal database

​
Authentication

B2B JWT token OR Privy authentication token and headers

​
Headers

When using Privy authentication token, include the following header:
  • x-privy-id-token: Privy ID token
{
    "agentId": "2fe35eeb-5aa6-4564-94c2-2ce44e65625d",
    "description": "New Description"
}

{
    "status": "success",
    "message": "Agent 2fe35eeb-5aa6-4564-94c2-2ce44e65625d description updated",
    "agentId": "2fe35eeb-5aa6-4564-94c2-2ce44e65625d",
    "description": "New Description"
}