AI Agents

Get an AI Agent

Retrieves detailed information about a specific AI Agent identified by its unique aiAgentID. This endpoint allows you to fetch the configuration and metadata of a single AI Agent associated with a specific account and application.

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

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

Path Parameters

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

AI Agent Response - [Map]

The detailed AI Agent information.

Attributes

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

AI Agent Response Shape

{
  "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"
}

Errors

A common set of Error Responses can be found here.