Search Agents

GET 
/conversation-ai/agents/search

Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities.

Request

Version stringrequired

API Version

Available optionsv3

startAfter string

Start after is the agent id to start after, Serving as skip, send empty when first page

limit number

Records per page

query string

query to search on agent name, must be provided in lowercase

application/json

Successful response

application/json

Schema

Schema

agentsobject[]required

List of agents matching the search criteria.

totalCountnumberrequired

Total number of agents in the location (unfiltered count).

countnumberrequired

Number of agents in the current response (filtered/paginated count).

Example (auto)

{
  "agents": [
    {
      "id": "emp_123",
      "name": "John Doe",
      "businessName": "Tech Corp",
      "mode": "auto-pilot",
      "channels": [
        "SMS",
        "LIVE_CHAT"
      ],
      "waitTime": 30,
      "waitTimeUnit": "seconds",
      "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
    }
  ],
  "totalCount": 100,
  "count": 25
}