Skip to main content
PUT
Update Agent

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
AgentConfig · object | null

Updated configuration settings

status
string | null

New status for the agent

avatar_url
string | null

New avatar URL for the agent

metadata
Metadata · object | null

Updated metadata for the agent

Response

Successful Response

name
string
required

Name of the agent

configuration
AgentConfig · 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
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