API Collection

Postman is a popular tool to help test and develop APIs. We have created a Postman collection to make it easier to integrate with Kore.ai APIs.

The entire collection is divided into two categories:

1. APIs related to the Bot Builder (Virtual Assistant Platform Builder) functionality.
2. APIs related to the Admin Console functionality.

For the complete list of APIs along with usage instructions, refer here.

Getting Started

To get started, download Postman and the API collection.

• Download and install Postman App from https://www.getpostman.com/.
• Download Kore.ai Postman Collection from https://github.com/Koredotcom/Public-APIs.
• Read the Using the XO Platform APIs article for more details on API Scope association and JWT token generation.

Once Postman is running, click ‘Import‘ and select the two JSON files in the Postman Collection package. After it has been imported, you see ‘Kore.ai Public APIs‘ under Collections, and you can select ‘PublicAPIEnv‘ as the Environment, as shown below.

Environment Configuration

Postman offers a configurable environment, essentially a set of key-value pairs. It allows you to create commonly used variables that can be referenced across multiple requests. You can read more about it here.

The pre-configured ‘PublicAPIEnv‘ environment contains a non-exhaustive set of variables that are referenced by the collection. Edit and replace these variables with your values.

To edit the values:

• Click the little Eye button next to the environment dropdown and then Edit.
• Hover over the variable you want to edit and click the Edit icon.

Testing APIs

You can choose any APIs in the collection and Send the API request to test the same.

1. After you import the collection or a sample CURL request, replace the host, botId, StreamId, ExtractionId, or any required details, as shown in the screenshot below.
2. Select the Headers tab and paste the {{YOUR_JWT_ACCESS_TOKEN}} that you have generated for your organization.
   
3. Select the Body tab and enter the required parameters if required. Each API has a link to the relevant developer documentation to use or execute that particular API. For more details, see the API List article.
4. Click Send.