Update Agent Metadata

PATCH 
/agent-studio/agent/:agentId

Updates agent metadata such as name, description, and status.

Request

Version stringrequired

API Version

Available optionsv3

agentId stringrequired

Agent ID whose metadata is being updated

source string

Origin channel attributed to this write for auditing (e.g. public_api, internal)

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID for authorization (cannot be updated)

namestring

Name of the agent

descriptionstring

Description of the agent

statusstring
Status of the agent
Available optionsactiveinactivearchived

Example (auto)

{
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "name": "Updated Customer Support Agent",
  "description": "Updated AI agent with enhanced customer support capabilities",
  "status": "active"
}

application/json

Agent metadata updated successfully

application/json

Schema

Schema

successbooleanrequired

Success status

messagestringrequired

Response message

dataobjectrequired

Updated agent or version data

Example (auto)

{
  "success": true,
  "message": "Agent updated successfully",
  "data": {
    "agentId": "p1q2r3s4t5u6v7w8x9y0z1a2",
    "versionId": "v1a2b3c4d5e6f7g8h9i0",
    "name": "Updated Customer Support Agent",
    "description": "Updated AI agent with enhanced customer support capabilities",
    "status": "active",
    "updatedAt": "2024-02-27T11:45:00.000Z"
  }
}