REST API

📘

WebSocket API Recommended

We would advise you to use the WebSocket API instead of the REST API. The WebSocket version supports additional features such as audio streaming and voice activation detection that are not supported by the REST API.

The Voysis API provides per provider REST based access to your custom Voysis conversational service. The Voysis API is customised for each customer integration. As such the specific structure of the ‘entities’ and ‘context’ parameters used in the query entity is left generic as it is dependent upon the customer use cases and scope of integration.

Swagger Definition

The API is fully specified by a Swagger definition, downloadable here

For a human-browsable form of the API, load the JSON definition into the online Swagger editor (http://editor.swagger.io/#/).