AI Agents

Create an AI Agent

Creates a new AI Agent. You are limited to create AI Agents dependent on the plan your account is subscribed to.

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

curl --request POST \
  --url http://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"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]
An easy to remember label for this AI agent.

Add Ai Agent Request Shape

{
  "name": "string"
}

Ai Agent Response - [Map]

The detailed AI agent information.

Attributes

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

Ai Agent Response Shape

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