AI Agents

Get all AI Agents

Retrieves all AI Agents associated to the account.

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

curl --request GET \
  --url http://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]

List of AI agents.

Attributes

aiAgents - REQUIRED[Array]
The list of AI agents.
List Contents (aiAgents)- type of [Map]
- aiAgents[0].aiAgentID - REQUIRED[String]
  The unique identifier for the AI agent.
- aiAgents[0].createdAt - REQUIRED[String]
  The date the AI agent was created.
- aiAgents[0].inputPlaceholder - REQUIRED[String]
  The widget input field placeholder that the user will see.
- aiAgents[0].name - REQUIRED[String]
  The name of the AI agent.
- aiAgents[0].primaryColor - REQUIRED[String]
  The primary color the widget.
- aiAgents[0].updatedAt - REQUIRED[String]
  The date the AI agent was last updated.
- aiAgents[0].welcomeMessage - REQUIRED[String]
  The AI agents welcoming message when it enters chant.
- aiAgents[0].widgetAppImageURL - REQUIRED[String]
  The URL for the app image.
- aiAgents[0].widgetAvatarURL - REQUIRED[String]
  The URL for the support agent avatar.
- aiAgents[0].widgetFontSize - REQUIRED[Integer]
  The widget font size as px units.
- aiAgents[0].widgetSubtext - REQUIRED[String]
  The widget subtext.
- aiAgents[0].widgetTitle - REQUIRED[String]
  The widget header title.
totalAiAgents - REQUIRED[Integer]
The number of AI agents in the list.

Ai Agents Response Shape

{
  "aiAgents": [
    {
      "aiAgentID": "string",
      "createdAt": "string",
      "inputPlaceholder": "string",
      "name": "string",
      "primaryColor": "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.