Skip to main content
PUT
/
api
/
v1
/
agents
/
{agent_id}
Update Agent
curl --request PUT \
  --url https://agent-studio.thena.ai/api/v1/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "configuration": {
    "communication_style": "FORMAL",
    "core_capabilities": [
      "enterprise sales",
      "negotiation",
      "solution selling"
    ],
    "expertise_level": "EXPERT",
    "goal": "Drive enterprise sales",
    "knowledge_domains": [
      "enterprise sales",
      "B2B",
      "solution architecture"
    ],
    "personality_traits": [
      "strategic",
      "persuasive",
      "consultative"
    ],
    "role": "Senior Sales Representative",
    "tone": "Professional"
  },
  "description": "Updated description",
  "metadata": {
    "updated_by": "admin"
  },
  "name": "Updated Sales Assistant",
  "status": "inactive"
}'
{
  "bot_sub": "VVYZYKNJ10E18462MAKTHQRW4C142",
  "completed_flows_count": 42,
  "configuration": {
    "language": "English",
    "team_size": 5,
    "tone": "Professional"
  },
  "created_at": "2023-01-01T00:00:00Z",
  "description": "Customized sales assistant for my team",
  "files": [],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "created_by": "admin",
    "updated_by": "admin"
  },
  "name": "My Sales Assistant",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "pending_flows_count": 5,
  "status": "active",
  "team_id": [
    "team-1",
    "team-2"
  ],
  "template_id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2023-01-01T00:00:00Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

agent_id
string<uuid>
required

Body

application/json
name
string | null

New name for the agent

description
string | null

New description for the agent

configuration
object | null

Updated configuration settings

status
string | null

New status for the agent

avatar_url
string | null

New avatar URL for the agent

metadata
object | null

Updated metadata for the agent

Response

Successful Response

name
string
required

Name of the agent

configuration
object
required

Agent-specific configuration settings

id
string<uuid>
required

Unique identifier for the agent

template_id
string<uuid>
required

ID of the template this agent was created from

organization_id
string<uuid>
required

ID of the organization that owns this agent

status
string
required

Current status of the agent (active, inactive, etc)

created_at
string
required

When the agent was created

updated_at
string
required

When the agent was last updated

description
string | null

Description of the agent's purpose and capabilities

avatar_url
string | null

URL of the agent's avatar image

metadata
object

Additional metadata for the agent

files
AgentFile · object[]

List of files associated with this agent

team_id
string[] | null

List of team IDs this agent belongs to

completed_flows_count
integer
default:0

Count of successfully completed flow executions

pending_flows_count
integer
default:0

Count of pending and running flow executions

bot_sub
string | null

Bot subscriber ID used for executing flows

platform_app_installation_id
string | null

Platform app installation ID

platform_app_id
string | null

Platform app ID

platform_app_slug
string | null

Platform app slug

I