Skip to main content
Retrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings.

Autorización

string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
string
default:"2021-07-28"
required
Versión de la API.

Path parameters

string
default:"EmployeeId123"
required
Conversations AI agent id

Respuestas

string
default:"emp_123"
required
Unique identifier for the agent.
string
default:"John Doe"
required
Name of the agent.
string
default:"Tech Corp"
Name of the business the agent represents.
string
default:"auto-pilot"
required
Current operating mode of the agent. Posibles valores: ‘off’, ‘suggestive’, ‘auto-pilot’
string[]
required
Communication channels the agent operates on.
number
default:"30"
required
Wait time before agent responds.
string
default:"seconds"
required
Unit for wait time. Posibles valores: ‘minutes’, ‘seconds’
boolean
default:"False"
required
Indicates if sleep functionality is enabled.
number
default:"2"
Duration of sleep period.
string
default:"hours"
Unit of sleep time. Posibles valores: ‘hours’, ‘minutes’, ‘seconds’
object[]
required
List of actions associated with this agent.
boolean
default:"False"
required
Indicates if this agent is a primary agent.
number
default:"25"
required
Maximum number of messages in auto-pilot mode before requiring human intervention.
string
default:"Assist customers with inquiries"
The goal of the agent.
string
default:"Friendly and helpful"
Personality traits of the agent.
string
default:"Provide excellent customer service"
Instructions for the agent.
string[]
Array of knowledge base IDs associated with this agent.
boolean
default:"False"
Whether the bot sleeps on manual outbound messages.
boolean
default:"False"
Whether the bot sleeps on workflow outbound messages.

Ejemplo