Documentation Index Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities.
GET https://services.leadconnectorhq.com/conversation-ai/agents/search
Autorizacion Bearer token generado desde el portal Leadway. Ver Autenticacion . Version
string
default: "2021-07-28"
required
Version de la API.
Query parameters startAfter
string
default: "Exampleee123"
Start after is the agent id to start after, Serving as skip, send empty when first page
query to search on agent name, must be provided in lowercase
Respuestas
200 - Successful response
List of agents matching the search criteria. id
string
default: "emp_123"
required
Unique identifier for the agent.
name
string
default: "John Doe"
required
Name of the agent.
businessName
string
default: "Tech Corp"
Name of the business the agent represents.
mode
string
default: "auto-pilot"
required
Current operating mode of the agent. Posibles valores: ‘off’, ‘suggestive’, ‘auto-pilot’
Communication channels the agent operates on.
waitTime
number
default: "30"
required
Wait time before agent responds.
waitTimeUnit
string
default: "seconds"
required
Unit for wait time. Posibles valores: ‘minutes’, ‘seconds’
sleepEnabled
boolean
default: "False"
required
Indicates if sleep functionality is enabled.
Duration of sleep period.
Unit of sleep time. Posibles valores: ‘hours’, ‘minutes’, ‘seconds’
List of actions associated with this agent.
isPrimary
boolean
default: "False"
required
Indicates if this agent is a primary agent. (First agent created for a account is primary by default)
autoPilotMaxMessages
number
default: "25"
required
Maximum number of messages in auto-pilot mode before requiring human intervention.
Goal configuration for the agent.
Array of knowledge base IDs associated with this agent.
createdAt
string
default: "2024-01-01T00:00:00Z"
required
Timestamp when the agent was created.
updatedAt
string
default: "2024-01-01T00:00:00Z"
required
Timestamp when the agent was last updated.
Whether the bot sleeps on manual outbound messages.
Whether the bot sleeps on workflow outbound messages.
totalCount
number
default: "100"
required
Total number of agents in the account (unfiltered count).
count
number
default: "25"
required
Number of agents in the current response (filtered/paginated count).
{ "agents" : [ { "id" : "emp_123" , "name" : "John Doe" , "businessName" : "Tech Corp" , "mode" : "auto-pilot" , "channels" : [ "SMS" , "LIVE_CHAT" ], "waitTime" : 30 , "waitTimeUnit" : "seconds" , "sleepEnabled" : false , "sleepTime" : 2 , "sleepTimeUnit" : "hours" , "actions" : [ { "id" : "action_123" , "type" : "triggerWorkflow" } ], "isPrimary" : false , "autoPilotMaxMessages" : 25 , "goal" : { "prompt" : "Assist customers" , "type" : "custom" , "actionId" : null }, "knowledgeBaseIds" : [ "kb_123" , "kb_456" ], "createdAt" : "2024-01-01T00:00:00Z" , "updatedAt" : "2024-01-01T00:00:00Z" , "sleepOnManualMessage" : false , "sleepOnWorkflowMessage" : false } ], // truncado: 3 lineas mas }
422 - Unprocessable Entity
Ejemplo curl -X GET 'https://services.leadconnectorhq.com/conversation-ai/agents/search' \ -H 'Authorization: Bearer YOUR_TOKEN' \ -H 'Version: 2021-07-28'
