Generated by API Evangelist
Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for assistants Chat API
version: 1.0.0
extends: openapi/qliksense-chat-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke'].post
update:
x-apievangelist-phrasing:
intent: Ask an assistant and wait for the full answer
effect: write
questions:
- Can I send a prompt to an assistant and get the whole answer in one response?
- Is there a non-streaming way to chat with an assistant thread?
instructions:
- text: 'Ask assistant {assistantId} in thread {threadId}: {input}, and wait for the full reply.'
slots:
assistantId: path.assistantId
threadId: path.threadId
input: requestBody.input
- text: Send {input} to thread {threadId} of assistant {assistantId} synchronously.
slots:
input: requestBody.input
threadId: path.threadId
assistantId: path.assistantId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream'].post
update:
x-apievangelist-phrasing:
intent: Stream an assistant's answer
effect: write
questions:
- Can I stream an assistant's answer token by token as it is generated?
- Is there a streaming mode for prompts in an assistant thread?
instructions:
- text: Stream the answer from assistant {assistantId} in thread {threadId} for {input}.
slots:
assistantId: path.assistantId
threadId: path.threadId
input: requestBody.input
- text: Send {input} to thread {threadId} of assistant {assistantId} and stream the reply.
slots:
input: requestBody.input
threadId: path.threadId
assistantId: path.assistantId
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.