AI Agents

Updates an AI Agent

Updates the details of an existing AI Agent identified by its unique aiAgentID. This endpoint allows you to modify various attributes of the AI Agent, such as the widget's appearance and behavior. The changes are applied immediately after the update request.

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

curl --request PUT \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"inputPlaceholder":"string","name":"string","primaryColor":"string","welcomeMessage":"string","widgetAppImageURL":"string","widgetAvatarURL":"string","widgetFontSize":0,"widgetSubtext":"string","widgetTitle":"string"}'

Path Parameters

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

Update AI Agent Request - [Map]

The updated AI Agent request details.

Attributes

inputPlaceholder - REQUIRED[String]
The placeholder text displayed in the widget's input field.
name - REQUIRED[String]
The new name of the AI Agent.
primaryColor - REQUIRED[String]
The new primary color of the widget, represented in HEX format.
welcomeMessage - REQUIRED[String]
The updated welcome message shown when the AI Agent starts the conversation.
widgetAppImageURL - REQUIRED[String]
The URL for the updated application image used in the widget.
widgetAvatarURL - REQUIRED[String]
The URL for the updated avatar image of the AI Agent.
widgetFontSize - REQUIRED[Integer]
The font size (in pixels) for the widget text.
widgetSubtext - REQUIRED[String]
The updated subtext displayed beneath the widget title.
widgetTitle - REQUIRED[String]
The updated title displayed in the widget's header.

Update AI Agent Request Shape

{
  "inputPlaceholder": "string",
  "name": "string",
  "primaryColor": "string",
  "welcomeMessage": "string",
  "widgetAppImageURL": "string",
  "widgetAvatarURL": "string",
  "widgetFontSize": 0,
  "widgetSubtext": "string",
  "widgetTitle": "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.