Skip to main content

Connecting to the Qlik Sense Natural Language Query API

ON THIS PAGE

Connecting to the Qlik Sense Natural Language Query API

Connections to the Natural Language (NL) Query API endpoints are made using HTTPS by default. To access the API endpoints, the Virtual Proxy in Qlik Sense should be configured with one of the available authentication methods. See Virtual proxies for more information. Additional CORS configuration may be required.

When communicating with the NL Query API, the URL has the following form:

https://hostname/api/v1/nl/query

Enable the app for chat

Apps can only be queried through the API if they are enabled for chat. To enable an app for chat, see Making apps available in Insight Advisor Chat.

API connection examples

The following example shows how to get a list of available apps. Postman is used to make the API request.

The following example shows how to get a list of measures from an app. Postman is used to make the API request.

The following example shows how to use recommendations for follow-up queries. Postman is used to make the API request.

The following example shows how to render a visualization that is returned from the API. Postman is used to make the API request.

The following example shows how to ignore the current context (app or entity) of a conversation when making a query. Postman is used to make the API request.

The following example shows how to reset the context of a conversation. Postman is used to make the API request.

The following example shows how to remove the entire context object from a conversation. Postman is used to make the API request.