1. Home
  2. Kore.ai Conversational Platform
  3. SDKs & APIs
  4. Using Kore.ai APIs
  5. Get Bots API

Get Bots API

To retrieve the list of bots available in an account.

GET https://{{host}}/api/public/bots

Query Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
offset Optional Specify the page number from which to start fetching the bots created in the account. If unspecified, it starts from 0, which is the first page of the list of bots.
limit Optional The number of bots to fetch. The maximum applicable limit is 50.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \

http://{{host}}/api/public/bots \

-H 'auth: YOUR_JWT_ACCESS_TOKEN' \

Sample Response

{
    "total": 3,
    "availableMore": true,
    "bots": [
        {
            "_id": "st-008c3w91-c69a-4ef3-a3b7-bd942bc371ab",
            "createdBy": "u-81f22c33-22f5-58ce-84fb-d894ece4baeb",
            "defaultLanguage": "en",
            "type": "taskbot",
            "purpose": "customer",
            "accountId": "57f38c8452ee95351620b261",
            "resourceid": "btstreams",
            "status": "published",
            "name": "TestBot",
            "description": "Test Bot"
        },
        {
            "_id": "st-009b228e-4080-5f1a-8ef1-64f90e17fbac",
            "createdBy": "u-04361202-0169-56c2-a7b1-b5495861b2ad",
            "type": "taskbot",
            "purpose": "customer",
            "defaultLanguage": "en",
            "accountId": "57f38c8452ee95351620b261",
            "resourceid": "btstreams",
            "status": "configured",
            "name": "ShopBot",
            "description": "Shop bot"
        },
        {
            "_id": "st-00a9b235-48e9-53fe-bb66-2de082872cde",
            "createdBy": "u-accb0713-df37-336e-b030-85dd1fb49e82",
            "type": "taskbot",
            "purpose": "customer",
            "defaultLanguage": "en",
            "accountId": "57f58c8452ee95351620b261",
            "resourceid": "btstreams",
            "status": "published",
            "name": "Test Voice Bot",
            "description": "Test Bot for Voice Pilot"
        }
    ]
}

Was this article helpful to you? Yes No