REST API

This page documents the DialoX REST API.

Authorization¶

All REST calls need authorization using an API token. The API token can be found in the studio, under Settings → Connect → REST API.

The authorization header is specified as follows:

Authorization: Bearer f181eab8c44ef9ff8d6fedbed7692b0b

Alternatively, the API key can be added to the URL as a query parameter named api_key, for instance;

https://bsqd.me/api/bot/66bfa5d1-ad06-409f-b7a6-112f5fa94ab5?api_key=f181eab8c44ef9ff8d6fedbed7692b0b

REST endpoints falling under /api/:bot/user/:user_id/conversation are subject to a rate limit at a maximum of 100 requests per 60 seconds.

Other REST endpoints are currently not rate limited.