Getting Started

Chatness is a platform that allows you to build chatbots for your business. It provides a set of tools that you can use to create, manage, and deploy your chatbots. The Chatness API is a RESTful API that allows you to interact with the Chatness platform programmatically. You can use it to create, manage, and deploy your chatbots.

We are currently in beta. If you have any questions or feedback, please contact us.

Base URL

The Chatness API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. All endpoints are versioned with a prefix and the current stable version is v1

To access our API, be sure to include the following URL in your requests:

Chatness API URL

  https://api.chatness.ai/v1

Errors

You can tell if your request was not successful by checking the status code when receiving an API response. We stand to the standard HTTP status codes, so you can use the same logic you would use with any other API. If a response comes back unsuccessful, it will always be >=400 and <=500, learn more about the api errors.

Official SDKs

Currently we provide official SDKs for node and browser platforms. You can find them on Chatness' Github.
Learn more about the Chatness SDK and all its capabilities.

Postman

We provide a Postman collection with all the endpoints and examples for you to test and play around with the API.

Run In Postman

Rate Limiting

The Chatness API has a rate limit of 360 requests per minute. If you exceed this limit, you will receive a 429 error response.

Authentication

At Chatness you can authenticate your requests as an Organization to perform operations on resourcers, or authenticate as a Contact to have identified conversations within your chatbots. Learn more about Chatness authentication.

Pagination

Some endpoints return a list of resources. By default, 10 items are returned at a time. You can specify further pages with the ?page parameter. You can also set a custom page size up to 100 with the ?limit parameter. Note that for technical reasons not all endpoints respect the ?limit parameter, see the documentation of each individual endpoint to learn whether it supports ?limit and how much you can increase it.