AI Agent

AI Agent - AI Agent Management
- GET aiagent/aiAgents - Get the list of AI Agents
- GET aiagent/aiAgents/{id} - Get a single AI Agent
- POST aiagent/aiAgents - Create a new AI Agent
- PUT aiagent/aiAgents/{id} - Update the AI Agent
- DELETE aiagent/aiAgents/{id} - Delete the AI Agent
- GET aiagent/aiAgents/{id}/overview - Get AI Agent Overview

AI Agent JSON Format

AI Agent is represented as simple flat JSON objects with the following keys:

Name	Type	Description
`id`	guid	Id of the AI agent.
`siteId`	integer	Site Id.
`name`	string	Name of the AI agent.
`description`	string	Description of the AI agent.
`tone`	enum	Tone of communication used by the AI agent. Allowed values are: `friendly`, `neutral`, `professional`, `humorous`.
`isCustomAvatar`	bool	Whether to use a custom avatar (true) or a system avatar (false).
`customizeAvatar`	string	URL of the custom avatar image. Required when isCustomAvatar is true.
`systemAvatarId`	guid	ID of the system avatar. Required when isCustomAvatar is false.
`language`	string	Primary language code for the AI agent (e.g., "en" for English).
`channel`	string	Communication channel for the AI agent (e.g., "Live Chat").
`paymentStatus`	enum	Current payment status. Allowed values are: `paid`, `trial`.
`avatar`	string	URL of the avatar.
`instructions`	string	Instructions for the AI agent.

Get the list of AI Agents

GET aiagent/aiAgents

Parameters:

Name	Type	in	Required	Description
`siteId`	integer	query	yes	Site Id.
`pageSize`	integer	query	no	Number of ai agents to return per page.
`pageIndex`	integer	query	no	Page number to retrieve. Default is 1.

Response:

An array of AI Agent

Example

Sample Request:

curl https://api11.comm100.io/aiagent/aiAgents?siteId=10000 \ 
    -X GET \ 
    -H 'Authorization: Bearer {access_token}'

Response:
HTTP/1.1 200 OK

[
    {
        "id": "a12b3828-4417-4075-9426-3c6aa222d676",
        "name": "common_agent",
        "description": "",
        "tone": "friendly",
        "isCustomAvatar": false,
        "systemAvatarId": "aaa40b08-1b98-489b-99f1-f4af129a848c",
        "language": "en",
        "channel": "Live Chat",
        "lastUpdatedTime": "2025-03-03T09:05:43.13Z",
        "paymentStatus": "paid",
        "avatar": "https://api11.comm100.io/aiagent/chatbots/a12b3828-4417-4075-9426-3c6aa222d676/avatar?siteId=10000&version=b07a408a09b7eaeaa740b57fdb4622e3&signature=uIQLEM1ZTEDCie-Nvztj7-pTOuY",
        "instructions": "-   Provide accurate and helpful responses to visitors' questions.\n-   Be friendly, professional, and concise in all interactions.\n-   Avoid answering questions by your own knowledge.\n-   Avoid providing personal opinions or unverified information."
    }
]

Get a single AI Agent

GET aiagent/aiAgents/{id}

Parameters:

Name	Type	in	Required	Description
`siteId`	integer	query	yes	Site Id.
`id`	guid	path	yes	Id of the AI agent.

Response:

AI Agent

Example

Sample Request:

curl https://api11.comm100.io/aiagent/aiAgents/f9928d68-92e6-4487-a2e8-8234fc9d1f48?siteId=10000 \ 
    -X GET \ 
    -H 'Authorization: Bearer {access_token}'

Response:
HTTP/1.1 200 OK

{
    "id": "a12b3828-4417-4075-9426-3c6aa222d676",
    "name": "common_agent",
    "description": "",
    "tone": "friendly",
    "isCustomAvatar": false,
    "systemAvatarId": "aaa40b08-1b98-489b-99f1-f4af129a848c",
    "language": "en",
    "channel": "Live Chat",
    "lastUpdatedTime": "2025-03-03T09:05:43.13Z",
    "paymentStatus": "paid",
    "avatar": "https://api11.comm100.io/aiagent/chatbots/a12b3828-4417-4075-9426-3c6aa222d676/avatar?siteId=10000&version=b07a408a09b7eaeaa740b57fdb4622e3&signature=uIQLEM1ZTEDCie-Nvztj7-pTOuY",
    "instructions": "-   Provide accurate and helpful responses to visitors' questions.\n-   Be friendly, professional, and concise in all interactions.\n-   Avoid answering questions by your own knowledge.\n-   Avoid providing personal opinions or unverified information."
}

Create a new AI Agent

POST aiagent/aiAgents

Parameters:

Name	Type	in	Required	Description
`siteId`	integer	query	yes	Site Id.
`name`	string	body	yes	Name of the AI agent.
`description`	string	body	no	Description of the AI agent.
`tone`	enum	body	no	Tone of communication used by the AI agent. Allowed values are: `friendly`, `neutral`, `professional`, `humorous`.
`isCustomAvatar`	bool	body	no	Whether to use a custom avatar (true) or a system avatar (false).
`customizeAvatar`	string	body	no	RL of the custom avatar image. Required when isCustomAvatar is true.
`systemAvatarId`	guid	body	no	ID of the system avatar. Required when isCustomAvatar is false.
`language`	string	body	no	Primary language code for the AI agent (e.g., "en" for English).
`channel`	string	body	no	Communication channel for the AI agent (e.g., "Live Chat").
`paymentStatus`	enum	body	no	Current payment status. Allowed values are: `paid`, `trial`.
`instructions`	string	body	no	Instructions for the AI agent.

Response:

AI Agent

Example

Sample Request:

curl https://api11.comm100.io/aiagent/aiAgents \ 
    -X POST \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"siteId":10000,"name":"common-agent","description":"","tone":"friendly","language":"en","systemAvatarId":"aaa40b08-1b98-489b-99f1-f4af129a848c","channel":"Live Chat","paymentStatus":"paid","instructions":"-   Provide accurate and helpful responses to visitors' questions.\n-   Be friendly, professional, and concise in all interactions.\n-   Avoid answering questions by your own knowledge.\n-   Avoid providing personal opinions or unverified information.","isCustomAvatar":false}'

Response:
HTTP/1.1 201 OK

{
    "id": "ec9f351e-d7d7-45fc-81aa-2fdd9e706f17",
    "name": "common-agent",
    "description": "",
    "tone": "friendly",
    "isCustomAvatar": false,
    "systemAvatarId": "aaa40b08-1b98-489b-99f1-f4af129a848c",
    "language": "en",
    "channel": "Live Chat",
    "lastUpdatedTime": "2025-03-04T06:41:55.1033333Z",
    "paymentStatus": "paid",
    "avatar": "https://api11.comm100.io/aiagent/chatbots/ec9f351e-d7d7-45fc-81aa-2fdd9e706f17/avatar?siteId=10000&version=b07a408a09b7eaeaa740b57fdb4622e3&signature=TRXt8Oq9QQa9Wz8p93l3bTTfvrU",
    "assistantId": "asst_eG0ekZgjRMXZ2At9GTPiwTK8",
    "instructions": "-   Provide accurate and helpful responses to visitors' questions.\n-   Be friendly, professional, and concise in all interactions.\n-   Avoid answering questions by your own knowledge.\n-   Avoid providing personal opinions or unverified information."
}

Update the AI Agent

PUT aiagent/aiAgents/{id}

Parameters:

Name	Type	in	Required	Description
`siteId`	integer	query	yes
`id`	guid	path	yes	ID of the AI agent to update.
`name`	string	body	no	Updated name for the AI agent.
`description`	string	body	no	Updated description of the AI agent.
`tone`	enum	body	no	Tone of communication used by the AI agent. Allowed values are: `friendly`, `neutral`, `professional`, `humorous`.
`isCustomAvatar`	bool	body	no	Whether to use a custom avatar (true) or a system avatar (false).
`customizeAvatar`	string	body	no	RL of the custom avatar image. Required when isCustomAvatar is true.
`systemAvatarId`	guid	body	no	ID of the system avatar. Required when isCustomAvatar is false.
`language`	string	body	no	Primary language code for the AI agent (e.g., "en" for English).
`channel`	string	body	no	Communication channel for the AI agent (e.g., "Live Chat").
`paymentStatus`	enum	body	no	Current payment status. Allowed values are: `paid`, `trial`.
`instructions`	string	body	no	Instructions for the AI agent.

Response:

AI Agent

Delete the AI Agent

DELETE aiagent/aiAgents/{id}

Parameters:

Name	Type	in	Required	Description
`siteId`	integer	query	yes	Site Id.
`id`	guid	path	yes	ID of the AI agent to delete.

Response:

No Content

Get AI Agent Overview

GET aiagent/aiAgents/{id}/overview

Parameters:

Name	Type	in	Required	Description
`siteId`	integer	query	yes	Site Id.
`startTime`	string	query	no	Start datetime for the overview data.
`endTime`	string	query	no	End datetime for the overview data.

Response:

Name	Type	Description
`topicsCount`	integer	Number of topics configured in this AI agent.
`functionsCount`	integer	Number of functions available to this AI agent.
`learningsCount`	integer	Number of learning items added to this AI agent.
`collectedLeadsCount`	integer	Number of leads collected by this AI agent.
`bookedMeetingsCount`	integer	Number of meetings booked through this AI agent.

Example

Sample Request:

curl https://api11.comm100.io/aiagent/aiAgents/ec9f351e-d7d7-45fc-81aa-2fdd9e706f17/overview?siteId=10000 \ 
    -X GET \ 
    -H 'Authorization: Bearer { access_token }'

Response:
HTTP/1.1 200 OK

{
    "topicsCount": 1,
    "functionsCount": 0,
    "learningsCount": 0,
    "collectedLeadsCount": 0,
    "bookedMeetingsCount": 0
}