AI Agents

Get all AI Agents

Retrieves a list of all AI Agents associated with a specific account and application. This endpoint provides information about each AI Agent in your account, including its configuration and metadata.

GET/v1/accounts/:accountID/applications/:applicationID/ai-agents

curl --request GET \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Path Parameters

:accountID - REQUIRED[String]
The referenced account ID.
:applicationID - REQUIRED[String]
The referenced application ID.

AI Agents Response - [Map]

A list of AI Agents.

Attributes

aiAgents - REQUIRED[Array]
The list of AI Agents.
List Contents (aiAgents)- type of [Map]
- aiAgents[0].aiAgentID - REQUIRED[String]
  A unique identifier assigned to the AI Agent.
- aiAgents[0].createdAt - REQUIRED[String]
  The timestamp indicating when the AI Agent was created.
- aiAgents[0].inputPlaceholder - REQUIRED[String]
  The placeholder text displayed in the AI widget's input field.
- aiAgents[0].name - REQUIRED[String]
  The user-defined name of the AI Agent.
- aiAgents[0].primaryColor - REQUIRED[String]
  The primary theme color of the widget, represented as a HEX code.
- aiAgents[0].type - REQUIRED[String]
  The type of AI Agent [chatbot, search].
- aiAgents[0].updatedAt - REQUIRED[String]
  The timestamp indicating the last update to the AI Agent.
- aiAgents[0].welcomeMessage - REQUIRED[String]
  The default welcome message displayed when the AI Agent starts interacting with a user.
- aiAgents[0].widgetAppImageURL - REQUIRED[String]
  The URL of the application image used in the widget.
- aiAgents[0].widgetAvatarURL - REQUIRED[String]
  The URL of the avatar image representing the AI Agent.
- aiAgents[0].widgetFontSize - REQUIRED[Integer]
  The font size of the text within the widget, specified in pixels.
- aiAgents[0].widgetSubtext - REQUIRED[String]
  A short descriptive text appearing below the widget header.
- aiAgents[0].widgetTitle - REQUIRED[String]
  The title displayed in the widget's header.
totalAiAgents - REQUIRED[Integer]
The total number of AI Agents in the list.

AI Agents Response Shape

{
  "aiAgents": [
    {
      "aiAgentID": "string",
      "createdAt": "string",
      "inputPlaceholder": "string",
      "name": "string",
      "primaryColor": "string",
      "type": "string",
      "updatedAt": "string",
      "welcomeMessage": "string",
      "widgetAppImageURL": "string",
      "widgetAvatarURL": "string",
      "widgetFontSize": 0,
      "widgetSubtext": "string",
      "widgetTitle": "string"
    }
  ],
  "totalAiAgents": 0
}

Errors

A common set of Error Responses can be found here.