To retrieve the list of the bots available in an account.
This API requires JWT generated by an application created only from Bot Admin Console.
| Method | GET |
| Endpoint | https://{{host}}/api/public/bots?offset=0&limit=50s |
| Content Type | application/json |
| Authorization | auth: {{JWT}}
|
| API Scope |
|
Path Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
| offset | Optional | Defines the number of pages to skip or retrieve. It defaults to 0 if unspecified, with a maximum value of 10. For example, 10. |
| limit | Optional | Specifies the number of bot records to retrieve, with a maximum limit of 50. For example, 50. |
Sample Request
curl -X GET \
'https://{{host}}/api/public/bots?offset=0&limit=50' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Sample Response
{
"total": 69,
"availableMore": true,
"bots": [
{
"_id": "st-eb254250-d9ea-5dfb-a369-7e104a115e51",
"purpose": "customer",
"createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91",
"defaultLanguage": "en",
"accountId": "5c04ae921ad9976d311e9b4b",
"type": "default",
"resourceid": "btstreams",
"status": "configured",
"name": "GitHub Sample_1543832655266",
"description": "Bot built using Github API’s to familiarize you with a few basic features of the platform. Provide the IDP information and Trying the bot with your Git repo. Start exploring the configurations to know more about alert, action and knowledge tasks."
},
{
"_id": "st-656dffde-34e7-58c6-885b-25a38112739d",
"purpose": "employee",
"createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91",
"defaultLanguage": "en",
"accountId": "5c04ae921ad9976d311e9b4b",
"type": "default",
"resourceid": "btstreams",
"status": "configured",
"name": "Travel Planning Sample_1543832655269",
"description": "This sample bots holds the 5 task types that the platform offers. The bot is built using open APIs to get flight information, location information and weather details. Explore and train the bot for natural language to better respond to your intent."
}
]
}