How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Assistants API

Assistants provide a chat interface for asking questions and getting personalized, relevant answers for Qlik Answers.

Qlik Assistants API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Artificial Intelligence, Business Intelligence, Natural-Language, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 29 operations across 17 paths, organized into 5 resource areas, and defines 45 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

29 operations 17 paths 45 schemas 5 DELETE9 GET3 PATCH10 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/assistants
Resource Areas
5

Paths & Operations 29

Across 17 paths, the API surfaces 29 operations — 5 DELETE, 9 GET, 3 PATCH, 10 POST, 2 PUT. They span 5 resource areas: assistants, search, starters, threads, chat. Each is listed below with its method, path, parameters, and response codes.

assistants 7
GET
/api/v1/assistants
List assistants
6 params → 200400403
POST
/api/v1/assistants
Create an assistant
body → 201400403
GET
/api/v1/assistants/{assistantId}/feedback
Get feedback
1 param → 200400403404
POST
/api/v1/assistants/{assistantId}/sources/plaintexts
Bulk search source chunks
1 param body → 202400403404
GET
/api/v1/assistants/{id}
Get an assistant
1 param → 200400403404
PATCH
/api/v1/assistants/{id}
Update assistant properties
2 params body → 204400401403404429
DELETE
/api/v1/assistants/{id}
Delete an assistant
1 param → 204400403404
search 1
POST
/api/v1/assistants/{assistantId}/actions/search
Perform search on an assistant
searchAssistants 1 param body → 200400403404405500
starters 7
GET
/api/v1/assistants/{assistantId}/starters
List starters
5 params → 200400403404
POST
/api/v1/assistants/{assistantId}/starters
Create a starter
1 param body → 201400403404
GET
/api/v1/assistants/{assistantId}/starters/{starterId}
Get a starter
2 params → 200400403404
PUT
/api/v1/assistants/{assistantId}/starters/{starterId}
Update a starter
2 params body → 200400403404
DELETE
/api/v1/assistants/{assistantId}/starters/{starterId}
Delete a starter
2 params → 204400403404
PUT
/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}
Update a Followup
3 params body → 200400403404
DELETE
/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}
Delete a Followup
3 params → 204400403404
threads 12
GET
/api/v1/assistants/{assistantId}/threads
List threads
6 params → 200400403404
POST
/api/v1/assistants/{assistantId}/threads
Create a thread
1 param body → 201400403404
GET
/api/v1/assistants/{assistantid}/threads/{threadid}
Get a thread
2 params → 200400403404
PATCH
/api/v1/assistants/{assistantid}/threads/{threadid}
Update thread properties
2 params body → 204400401403404429
DELETE
/api/v1/assistants/{assistantid}/threads/{threadid}
Delete a thread
2 params → 204400403404
GET
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions
List interactions
6 params → 200400403404
POST
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions
Create an interaction
2 params body → 201400403404
GET
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}
Get an interaction
3 params → 200400403404
DELETE
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}
Delete an interaction
3 params → 204400403404
POST
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback
Create feedback
3 params body → 201400403404
PATCH
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}
Update feedback
4 params body → 204400403404
POST
/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews
Create feedback review
3 params body → 201400403404
chat 2
POST
/api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke
Execute synchronous prompt
2 params body → 200400403404500
POST
/api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream
Execute asynchronous prompt
2 params body → 200400403404405500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are Assistant (19 properties), ThreadWithMessages (11 properties), createAssistant (11 properties), createAssistantWithAvatar (11 properties). Each schema is shown below with its type and property counts.

Assistant
object
19 properties 15 required
assistantsResult
object
3 properties 1 required
chunk
object
5 properties 2 required
ChunksRefs
object
1 property 1 required
createAssistant
object
11 properties 8 required
createAssistantWithAvatar
object
11 properties 8 required
createFeedback
object
3 properties 2 required
createInteraction
object
5 properties 3 required
createReview
object
1 property 1 required
createStarter
object
4 properties 1 required
createThread
object
4 properties 1 required
errorResponse
object
2 properties
errorResponseCode
object
3 properties
errorResponseCodeCopy
object
3 properties
errorResponseCopy
object
2 properties
Feedback
object
7 properties 8 required
feedbackPatchArray
array
An array of JSON Patch documents.
feedbackSummary
object
10 properties 4 required
followup
object
4 properties 5 required
Interaction
object
10 properties 8 required
interactionsResult
object
3 properties 1 required
JSONPatch
object
A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
3 properties 3 required
JSONPatchArray
array
An array of JSON Patch documents.
kbChunkMeta
object
Metadata about the chunk
5 properties 5 required
Message
object
5 properties 5 required
MessageSource
object
6 properties 5 required
MessageSourceChunk
object
2 properties 1 required
pageLink
object
1 property
pageLinks
object
3 properties
promptInput
object
1 property
promptOutput
object
2 properties
promptOutputInvoke
object
3 properties
recommendedAnswer
object
2 properties 2 required
rejectionReason
integer
Rejection reason for a question: 1 - PROMPTINJECTION 2 - OUTOFCONTEXT 3 - TOOCOMPLEX
resultMeta
object
1 property
searchRequest
object
3 properties 1 required
searchResponse
object
1 property 1 required
source
object
5 properties
sourcesPlaintext
object
1 property
Starter
object
7 properties 6 required
startersResult
object
3 properties 1 required
Thread
object
10 properties 9 required
threadPatchArray
array
An array of JSON Patch documents.
threadsResult
object
3 properties 1 required
ThreadWithMessages
object
11 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-assistants.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Assistants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.