AI Chatbot Platform API v3
AI Chatbot
Version 3
Retrieves a list of all AI chatbots within an application.
GET https://api-{application_id}.sendbird.com/v3/bots
The following table lists the parameters that this action supports.
Optional Parameter name Type Description token
string
Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set to 0.
limit
int
Specifies the number of bots to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
The following table lists the properties of an HTTP request that this action supports.
Optional Property name Type Description is_ai
boolean
Determines whether to retrieve a list of AI bots. If set to true, retrieves an array of bot objects that have ai property specified. If not specified, both AI and non-AI bots are retrieved in the list.
If successful, this action returns a list of bot resources in the response body.
{
"bots": [
{
"bot_callback_url": "",
"is_privacy_mode": false,
"enable_mark_as_read": true,
"show_member": false,
"channel_invitation_preference": 0,
"created_at": 1686141160,
"bot": {
"bot_userid": "Janes_ai_assistant",
"bot_nickname": "Jane's ai assistant",
"bot_profile_url": "",
"bot_require_auth_for_profile_image": false,
"bot_metadata": {},
"bot_token": "10f514b570affa358002ae1a3edcbb27cb5cd1f9",
"bot_type": "AI assistant"
},
"ai": {
"backend": "chatgpt",
"system_message": "You are a helpful assistant.",
"temperature": 1.0,
"max_tokens": 256,
"top_p": 1.0,
"presence_penalty": 0.0,
"frequency_penalty": 0.0
}
},
{
"bot_callback_url": "https://mealadvisor.com/bots/sendbird/dinner/",
"is_privacy_mode": false,
"enable_mark_as_read": true,
"show_member": false,
"channel_invitation_preference": 0,
"created_at": 1686136348,
"bot": {
"bot_userid": "AIJANE",
"bot_nickname": "AIJANE",
"bot_profile_url": "https://mealadvisor.com/bots/img/sendbird_03_512px.png",
"bot_require_auth_for_profile_image": false,
"bot_metadata": {},
"bot_token": "de8fb7659a113e96a8579d1fee0972f04faef677",
"bot_type": "marketer"
},
"ai": {
"backend": "chatgpt",
"system_message": "You are a helpful assistant.",
"temperature": "1.00"
}
}
],
"next": ""
}
List of response properties Property name Type Description bots[]
array of objects
An array of bots .
next
string
The value that can be used in the token parameter to retrieve the next page in the result set.
In the case of an error, an error object is returned. A detailed list of error codes is available here .