AI Agents

Create an AI Agent

Creates a new AI Agent in your account. The number of AI Agents you can create depends on the subscription plan associated with your account.

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

curl --request POST \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","type":"string"}'

Path Parameters

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

Add AI Agent Request - [Map]

The AI Agent to add to the account.

Attributes

name - REQUIRED[String]
A user-friendly name for the AI Agent. This label helps distinguish different AI Agents.
type - REQUIRED[String]
Specifies the type of AI Agent to create [chatbot, search].

Add AI Agent Request Shape

{
  "name": "string",
  "type": "string"
}

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.