API Reference

The API.chat is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

For the chatbot scenario, we use XML-based notation. You can read more about it here. Scenario resource is the only one that uses XML-object.

Subscribe to API.Chat blog mailing list for updates.

JUST GETTING STARTED?


Check out our development quickstart guide.

Base URL

https://bot.api.chat

Authentication

The API.chat uses API keys to authenticate requests. You can view and manage your API keys on the Subscriptions Page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via header auth. Provide your API in a header Ocp-Apim-Subscription-Key 

curl -v -X GET "https://bot.api.chat/bots/"
-H "Cache-Control: no-cache"
-H "Ocp-Apim-Subscription-Key: XXXXXXXXXXXXXXXXXXXXXXXXX"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

APIs