Assistants
Assistants provide a chat interface for asking questions and getting personalized, relevant answers for Qlik Answers.
Endpoints
Retrieves the list of assistants. The result can be filtered, sorted, and paginated.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Query Parameters
- limitinteger
The number of assistants to get.
- nextstring
Optional parameter to request the next page.
- prevstring
Optional parameter to request the previous page.
- sortstring
Optional resource field name to sort on, case insensitive, e.g.
name
. Can be prefixed with-
to set descending order; defaults to ascending.Can be one of: "NAME""-NAME""DESCRIPTION""-DESCRIPTION""CREATED""-CREATED""UPDATED""-UPDATED"
- countTotalbooleanDeprecated
Optional parameter to request total count for query.
Responses
200
application/json
Successful operation.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
data properties
- idstringRequired
Unique identifier of the assistant.
- namestringRequired
The name of the assistant.
- tagsarray of stringsRequired
The list of tags associated with the assistant.
- titlestring
The title of the assistant.
- ownerIdstringRequired
Unique identifier of the assistant owner.
- spaceIdstringRequired
Unique identifier of the space containing the assistant.
- tenantIdstringRequired
Unique identifier of the assistant tenant.
- createdAtstringRequired
Datetime when the assistant was created.
- createdBystringRequired
Unique identifier of the user who created the assistant.
- hasAvatarboolean
Indicates if the assistant has an avatar.
- updatedAtstringRequired
Datetime when the assistant was updated.
- updatedBystringRequired
Unique identifier of the user who last updated the assistant.
- descriptionstringRequired
The description of the assistant.
- systemMessagestringDeprecated
System prompt setting up conversation context.
- knowledgeBasesarray of stringsRequired
List of knowledgebases the assistant is using.
- welcomeMessagestringRequired
Initial message in the chat conversation.
- customPropertiesobjectRequired
freeform JSON to allow custom customization options.
- defaultPromptTypestring
Default prompt type for the assistant.
Can be one of: "thread""oneshot"
- orderedStarterIdsarray of strings
List of starter IDs in the order they will be sorted.
-
- metaobject
meta properties
- countTotalinteger
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "data": [ { "id": "507f191e810c19729de860ea", "name": "Organization-wide Assistant", "tags": [ "Red", "Sales" ], "title": "Assistant for Sales activities", "ownerId": "507f191e810c19729de860ea", "spaceId": "507f191e810c19729de860ea", "tenantId": "507f191e810c19729de860ea", "createdAt": "2021-10-02T14:20:50.52Z", "createdBy": "507f191e810c19729de860ea", "hasAvatar": true, "updatedAt": "2021-10-02T14:20:50.52Z", "updatedBy": "507f191e810c19729de860ea", "description": "This assistant is used for...", "systemMessage": "You are helpful Sales assistant. Provide concise and actionable insights.", "knowledgeBases": [ "507f191e810c19729de860ea" ], "welcomeMessage": "Welcome to Sales process support Assistant.", "customProperties": { "customErrors": { "outsideScopeError": "Outside of scope error", "complexQuestionError": "Complex question error", "promptInjectionError": "Prompt injection error" } }, "defaultPromptType": "thread", "orderedStarterIds": [ "507f191e810c19729de860ea", "787f191e810c19729de860er" ] } ], "meta": { "countTotal": 42 }, "links": { "next": { "href": "string" }, "prev": { "href": "string" }, "self": { "href": "string" } }}
Creates a new assistant.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Request Body
application/json
- application/jsonobject
application/json properties
- namestringRequired
The name of the assistant.
- tagsarray of stringsRequired
The list of tags for the assistant.
- titlestringRequired
The title of the assistant.
- spaceIdstringRequired
Unique identifier of the space to contain the assistant.
- descriptionstringRequired
The description of the assistant.
- systemMessagestringDeprecated
System prompt setting up conversation context.
- knowledgeBasesarray of stringsRequired
List of knowledgebases the assistant is using.
- welcomeMessagestringRequired
Initial message in the chat conversation.
- customPropertiesobjectRequired
freeform JSON to allow custom customization options.
- defaultPromptTypestring
Default prompt type for the assistant.
Can be one of: "thread""oneshot"
- orderedStarterIdsarray of strings
List of starter IDs in the order they will be sorted.
-
multipart/form-data
- multipart/form-dataobject
multipart/form-data properties
- namestringRequired
The name of the assistant.
- tagsarray of stringsRequired
The list of tags for the assistant.
- titlestringRequired
The title of the assistant.
- avatarstring
user uploaded avatar, filetype must be png
- spaceIdstringRequired
Unique identifier of the space to contain the assistant.
- descriptionstringRequired
The description of the assistant.
- systemMessagestringDeprecated
System prompt setting up conversation context.
- knowledgeBasesarray of stringsRequired
List of knowledgebases the assistant is using.
- welcomeMessagestringRequired
Initial message in the chat conversation.
- customPropertiesobjectRequired
freeform JSON to allow custom customization options.
- defaultPromptTypestring
Default prompt type for the assistant.
Can be one of: "thread""oneshot"
-
Responses
201
application/json
Successfully created an assistant.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the assistant.
- namestringRequired
The name of the assistant.
- tagsarray of stringsRequired
The list of tags associated with the assistant.
- titlestring
The title of the assistant.
- ownerIdstringRequired
Unique identifier of the assistant owner.
- spaceIdstringRequired
Unique identifier of the space containing the assistant.
- tenantIdstringRequired
Unique identifier of the assistant tenant.
- createdAtstringRequired
Datetime when the assistant was created.
- createdBystringRequired
Unique identifier of the user who created the assistant.
- hasAvatarboolean
Indicates if the assistant has an avatar.
- updatedAtstringRequired
Datetime when the assistant was updated.
- updatedBystringRequired
Unique identifier of the user who last updated the assistant.
- descriptionstringRequired
The description of the assistant.
- systemMessagestringDeprecated
System prompt setting up conversation context.
- knowledgeBasesarray of stringsRequired
List of knowledgebases the assistant is using.
- welcomeMessagestringRequired
Initial message in the chat conversation.
- customPropertiesobjectRequired
freeform JSON to allow custom customization options.
- defaultPromptTypestring
Default prompt type for the assistant.
Can be one of: "thread""oneshot"
- orderedStarterIdsarray of strings
List of starter IDs in the order they will be sorted.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"name":"Organization-wide assistant","tags":["Red","Sales"],"title":"Assistant for Sales activities","spaceId":"507f191e810c19729de860ea","description":"This assistant is used for...","systemMessage":"You are helpful Sales assistant. Provide concise and actionable insights.","knowledgeBases":["507f191e810c19729de860ea"],"welcomeMessage":"Welcome to Sales process support Assistant.","customProperties":{"customErrors":{"outsideScopeError":"Outside of scope error","complexQuestionError":"Complex question error","promptInjectionError":"Prompt injection error"}},"defaultPromptType":"thread","orderedStarterIds":["507f191e810c19729de860ea","787f191e810c19729de860er"]}'
const https = require('https') const data = JSON.stringify({"name":"Organization-wide assistant","tags":["Red","Sales"],"title":"Assistant for Sales activities","spaceId":"507f191e810c19729de860ea","description":"This assistant is used for...","systemMessage":"You are helpful Sales assistant. Provide concise and actionable insights.","knowledgeBases":["507f191e810c19729de860ea"],"welcomeMessage":"Welcome to Sales process support Assistant.","customProperties":{"customErrors":{"outsideScopeError":"Outside of scope error","complexQuestionError":"Complex question error","promptInjectionError":"Prompt injection error"}},"defaultPromptType":"thread","orderedStarterIds":["507f191e810c19729de860ea","787f191e810c19729de860er"]}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "name": "Organization-wide assistant", "tags": [ "Red", "Sales" ], "title": "Assistant for Sales activities", "spaceId": "507f191e810c19729de860ea", "description": "This assistant is used for...", "systemMessage": "You are helpful Sales assistant. Provide concise and actionable insights.", "knowledgeBases": [ "507f191e810c19729de860ea" ], "welcomeMessage": "Welcome to Sales process support Assistant.", "customProperties": { "customErrors": { "outsideScopeError": "Outside of scope error", "complexQuestionError": "Complex question error", "promptInjectionError": "Prompt injection error" } }, "defaultPromptType": "thread", "orderedStarterIds": [ "507f191e810c19729de860ea", "787f191e810c19729de860er" ]}
Response
{ "id": "507f191e810c19729de860ea", "name": "Organization-wide Assistant", "tags": [ "Red", "Sales" ], "title": "Assistant for Sales activities", "ownerId": "507f191e810c19729de860ea", "spaceId": "507f191e810c19729de860ea", "tenantId": "507f191e810c19729de860ea", "createdAt": "2021-10-02T14:20:50.52Z", "createdBy": "507f191e810c19729de860ea", "hasAvatar": true, "updatedAt": "2021-10-02T14:20:50.52Z", "updatedBy": "507f191e810c19729de860ea", "description": "This assistant is used for...", "systemMessage": "You are helpful Sales assistant. Provide concise and actionable insights.", "knowledgeBases": [ "507f191e810c19729de860ea" ], "welcomeMessage": "Welcome to Sales process support Assistant.", "customProperties": { "customErrors": { "outsideScopeError": "Outside of scope error", "complexQuestionError": "Complex question error", "promptInjectionError": "Prompt injection error" } }, "defaultPromptType": "thread", "orderedStarterIds": [ "507f191e810c19729de860ea", "787f191e810c19729de860er" ]}
Retrieves feedback summary for the assistant.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant from which to retrieve feedback summary.
Responses
200
application/json
Successfully retrieved the feedback summary for the assistant.
- application/jsonobject
application/json properties
- likesintegerRequired
Amount of likes for a thread or an assistant.
- otherinteger
Count of answers which users disliked and gave "other" as reason.
- reviewsintegerRequired
Amount of reviews for a thread or an assistant.
- dislikesintegerRequired
Amount of dislikes for a thread or an assistant.
- unhelpfulinteger
Count of answers which users marked as "unhelpful".
- inaccurateinteger
Count of answers which users marked as "inaccurate".
- irrelevantinteger
Count of answers which users marked as "irrelevant".
- repetitiveinteger
Count of answers which users marked as "repetitive".
- unansweredinteger
Count of questions for which the assistant provided no answer.
- interactionsintegerRequired
Amount of interactions for a thread or an assistant.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/feedback" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/feedback', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "likes": 42, "other": 42, "reviews": 42, "dislikes": 42, "unhelpful": 42, "inaccurate": 42, "irrelevant": 42, "repetitive": 42, "unanswered": 42, "interactions": 42}
Perform a bulk search for the plaintext of source chunks for the assistant.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to search for source chunks.
Request Body
application/json
- application/jsonobject
application/json properties
- chunkIdsarray of stringsRequired
Unique identifier of the Chunk.
-
Responses
202
application/json
Successfully retrieved plaintext of the chunks.
- application/jsonobject
application/json properties
- textByChunkIdobject
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The resource was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/sources/plaintexts" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"chunkIds":["c2ef42d9-7164-4fb0-bdbb-6534ae37263e","486ada2c-f895-4961-8ba5-7995f1026d26"]}'
const https = require('https') const data = JSON.stringify({"chunkIds":["c2ef42d9-7164-4fb0-bdbb-6534ae37263e","486ada2c-f895-4961-8ba5-7995f1026d26"]}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/sources/plaintexts', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "chunkIds": [ "c2ef42d9-7164-4fb0-bdbb-6534ae37263e", "486ada2c-f895-4961-8ba5-7995f1026d26" ]}
Response
{ "textByChunkId": { "chunk1_id": "chunk1_text", "chunk2_id": "chunk2_text" }}
Retrieves the list of starters for the assistant.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Query Parameters
- limitinteger
The number of starters to get.
- nextstring
Optional parameter to request the next page.
- prevstring
Optional parameter to request the previous page.
- sortstring
Optional resource field name to sort on, case insensitive, e.g.
name
. Can be prefixed with-
to set descending order; defaults to ascending.Can be one of: "QUESTION""-QUESTION""CREATED""-CREATED""UPDATED""-UPDATED"
Path Parameters
- assistantIdstringRequired
The ID of the assistant from which to retrieve starters.
Responses
200
application/json
Successfully retrieved the assistant's starters.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
data properties
- idstringRequired
Unique identifier of the starter.
- questionstringRequired
Starter sample question.
- createdAtstringRequired
Datetime when the starter was created.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- updatedAtstringRequired
Datetime when the starter was updated.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- metaobject
meta properties
- countTotalinteger
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "data": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "createdAt": "2021-10-02T14:20:50.52Z", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "updatedAt": "2021-10-02T14:20:50.52Z", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "meta": { "countTotal": 42 }, "links": { "next": { "href": "string" }, "prev": { "href": "string" }, "self": { "href": "string" } }}
Creates a new starter for the assistant.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to create the starter.
Request Body
application/json
- application/jsonobject
application/json properties
- questionstringRequired
Starter sample question.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- additionalContextstring
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobject
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
Responses
201
application/json
Successfully created a new assistant starter.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the starter.
- questionstringRequired
Starter sample question.
- createdAtstringRequired
Datetime when the starter was created.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- updatedAtstringRequired
Datetime when the starter was updated.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
400
application/json
The request is in incorrect format or starter limit exceeded.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"question":"Where was Genghis Khan buried?","followups":[{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}],"additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}'
const https = require('https') const data = JSON.stringify({"question":"Where was Genghis Khan buried?","followups":[{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}],"additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "question": "Where was Genghis Khan buried?", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Response
{ "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "createdAt": "2021-10-02T14:20:50.52Z", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "updatedAt": "2021-10-02T14:20:50.52Z", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Retrieves the specified starter.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant containing the requested starter.
- starterIdstringRequired
The ID of the starter to retrieve.
Responses
200
application/json
Successfully retrieved the starter.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the starter.
- questionstringRequired
Starter sample question.
- createdAtstringRequired
Datetime when the starter was created.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- updatedAtstringRequired
Datetime when the starter was updated.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The starter was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters/{starterId}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "createdAt": "2021-10-02T14:20:50.52Z", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "updatedAt": "2021-10-02T14:20:50.52Z", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Updates the specified starter.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant containing the requested starter.
- starterIdstringRequired
The ID of the starter to retrieve.
Request Body
application/json
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the starter.
- questionstringRequired
Starter sample question.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
Responses
200
application/json
Successfully updated the starter.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the starter.
- questionstringRequired
Starter sample question.
- createdAtstringRequired
Datetime when the starter was created.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- updatedAtstringRequired
Datetime when the starter was updated.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The record was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}" \-X PUT \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","followups":[{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}],"additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}'
const https = require('https') const data = JSON.stringify({"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","followups":[{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}],"additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters/{starterId}', 'method': 'PUT', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Response
{ "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "createdAt": "2021-10-02T14:20:50.52Z", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "updatedAt": "2021-10-02T14:20:50.52Z", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Deletes the starter and all of its resources.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant containing the requested starter.
- starterIdstringRequired
The ID of the starter to delete.
Responses
204
Successful operation.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}" \-X DELETE \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters/{starterId}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Updates the specified Followup.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant containing the requested Followup.
- followupIdstringRequired
The ID of the Followup to update.
- starterIdstringRequired
The ID of the starter containing the requested Followup.
Request Body
application/json
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
Responses
200
application/json
Successfully updated the Followup.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the starter.
- questionstringRequired
Starter sample question.
- createdAtstringRequired
Datetime when the starter was created.
- followupsarray of objects
List of followups.
followups properties
- idstringRequired
Unique identifier of the Followup.
- questionstringRequired
Starter sample question.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
- updatedAtstringRequired
Datetime when the starter was updated.
- additionalContextstringRequired
Optional context collected from curated meant to be leveraged by LLM-based question recommendation system.
- recommendedAnswerobjectRequired
recommendedAnswer properties
- contentstringRequired
Starter answer content.
- contentTypestringRequired
Answer type of content.
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The record was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}" \-X PUT \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}'
const https = require('https') const data = JSON.stringify({"id":"507f191e810c19729de860ea","question":"Where was Genghis Khan buried?","additionalContext":"string","recommendedAnswer":{"content":"string","contentType":"text | markdown | html"}}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}', 'method': 'PUT', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Response
{ "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "createdAt": "2021-10-02T14:20:50.52Z", "followups": [ { "id": "507f191e810c19729de860ea", "question": "Where was Genghis Khan buried?", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" } } ], "updatedAt": "2021-10-02T14:20:50.52Z", "additionalContext": "string", "recommendedAnswer": { "content": "string", "contentType": "text | markdown | html" }}
Deletes the specified Followup.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant containing the requested Followup.
- followupIdstringRequired
The ID of the Followup to delete.
- starterIdstringRequired
The ID of the starter containing the requested Followup.
Responses
204
Successful operation.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The Followup was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}" \-X DELETE \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Retrieves the list of threads for the assistant.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Query Parameters
- filterstring
Optional parameter to filter threads.
- limitinteger
The number of assistants to get.
- nextstring
Optional parameter to request the next page.
- prevstring
Optional parameter to request the previous page.
- sortstring
Optional resource field name to sort on, case insensitive, e.g.
name
. Can be prefixed with-
to set descending order; defaults to ascending.Can be one of: "NAME""-NAME""CREATED""-CREATED""UPDATED""-UPDATED"
Path Parameters
- assistantIdstringRequired
The ID of the assistant from which to retrieve threads.
Responses
200
application/json
Successfully retrieved the threads for the assistant.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
data properties
- idstringRequired
Unique identifier of the thread.
- namestringRequired
The name of the thread.
- ownerIdstringRequired
- favoritebooleanRequired
If thread is marked as favorite.
- createdAtstringRequired
Datetime when the thread was created.
- deletedAtstring
Datetime when the thread was deleted.
- updatedAtstringRequired
Datetime when the thread was updated.
- hasFeedbackbooleanRequired
If feedback was provided for a thread interaction.
- summaryStatsobjectRequired
summaryStats properties
- likesintegerRequired
Amount of likes for a thread or an assistant.
- otherinteger
Count of answers which users disliked and gave "other" as reason.
- reviewsintegerRequired
Amount of reviews for a thread or an assistant.
- dislikesintegerRequired
Amount of dislikes for a thread or an assistant.
- unhelpfulinteger
Count of answers which users marked as "unhelpful".
- inaccurateinteger
Count of answers which users marked as "inaccurate".
- irrelevantinteger
Count of answers which users marked as "irrelevant".
- repetitiveinteger
Count of answers which users marked as "repetitive".
- unansweredinteger
Count of questions for which the assistant provided no answer.
- interactionsintegerRequired
Amount of interactions for a thread or an assistant.
-
-
- metaobject
meta properties
- countTotalinteger
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "data": [ { "id": "507f191e810c19729de860ea", "name": "Initial conversation", "ownerId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "favorite": false, "createdAt": "2021-10-02T14:20:50.52Z", "deletedAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:50.52Z", "hasFeedback": false, "summaryStats": { "likes": 42, "other": 42, "reviews": 42, "dislikes": 42, "unhelpful": 42, "inaccurate": 42, "irrelevant": 42, "repetitive": 42, "unanswered": 42, "interactions": 42 } } ], "meta": { "countTotal": 42 }, "links": { "next": { "href": "string" }, "prev": { "href": "string" }, "self": { "href": "string" } }}
Creates a new thread for the assistant.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to create the thread.
Request Body
application/json
- application/jsonobject
application/json properties
- namestringRequired
The name of the thread.
-
Responses
201
application/json
Successfully created a new assistant thread.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the thread.
- namestringRequired
The name of the thread.
- ownerIdstringRequired
- favoritebooleanRequired
If thread is marked as favorite.
- createdAtstringRequired
Datetime when the thread was created.
- deletedAtstring
Datetime when the thread was deleted.
- updatedAtstringRequired
Datetime when the thread was updated.
- hasFeedbackbooleanRequired
If feedback was provided for a thread interaction.
- summaryStatsobjectRequired
summaryStats properties
- likesintegerRequired
Amount of likes for a thread or an assistant.
- otherinteger
Count of answers which users disliked and gave "other" as reason.
- reviewsintegerRequired
Amount of reviews for a thread or an assistant.
- dislikesintegerRequired
Amount of dislikes for a thread or an assistant.
- unhelpfulinteger
Count of answers which users marked as "unhelpful".
- inaccurateinteger
Count of answers which users marked as "inaccurate".
- irrelevantinteger
Count of answers which users marked as "irrelevant".
- repetitiveinteger
Count of answers which users marked as "repetitive".
- unansweredinteger
Count of questions for which the assistant provided no answer.
- interactionsintegerRequired
Amount of interactions for a thread or an assistant.
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"name":"Initial conversation"}'
const https = require('https') const data = JSON.stringify({"name":"Initial conversation"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "name": "Initial conversation"}
Response
{ "id": "507f191e810c19729de860ea", "name": "Initial conversation", "ownerId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "favorite": false, "createdAt": "2021-10-02T14:20:50.52Z", "deletedAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:50.52Z", "hasFeedback": false, "summaryStats": { "likes": 42, "other": 42, "reviews": 42, "dislikes": 42, "unhelpful": 42, "inaccurate": 42, "irrelevant": 42, "repetitive": 42, "unanswered": 42, "interactions": 42 }}
Retrieves a thread for the assistant.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Path Parameters
- assistantidstringRequired
The ID of the assistant containing the requested thread.
- threadidstringRequired
The ID of the thread to retrieve.
Responses
200
application/json
Successfully retrieved the thread.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the thread.
- namestringRequired
The name of the thread.
- ownerIdstringRequired
Unique identifier of the thread owner.
- favoritebooleanRequired
If thread is marked as favorite.
- messagesarray of objectsRequired
messages properties
- idstringRequired
- rolestringRequired
human or ai role.
- contentstringRequired
Message content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- createdAtstringRequired
Datetime when the interaction was created.
-
- createdAtstringRequired
Datetime when the thread was created.
- deletedAtstring
Datetime when the thread was deleted.
- updatedAtstringRequired
Datetime when the thread was updated.
- hasFeedbackbooleanRequired
If feedback was provided for a thread interaction.
- summaryStatsobjectRequired
summaryStats properties
- likesintegerRequired
Amount of likes for a thread or an assistant.
- otherinteger
Count of answers which users disliked and gave "other" as reason.
- reviewsintegerRequired
Amount of reviews for a thread or an assistant.
- dislikesintegerRequired
Amount of dislikes for a thread or an assistant.
- unhelpfulinteger
Count of answers which users marked as "unhelpful".
- inaccurateinteger
Count of answers which users marked as "inaccurate".
- irrelevantinteger
Count of answers which users marked as "irrelevant".
- repetitiveinteger
Count of answers which users marked as "repetitive".
- unansweredinteger
Count of questions for which the assistant provided no answer.
- interactionsintegerRequired
Amount of interactions for a thread or an assistant.
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The thread was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantid}/threads/{threadid}" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantid}/threads/{threadid}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "id": "507f191e810c19729de860ea", "name": "Initial conversation", "ownerId": "507f191e810c19729de860ea", "favorite": false, "messages": [ { "id": "10d347c4-f28a-4faf-93f0-48e781aaf303", "role": "ai", "content": "Somewhere in an unmarked grave", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "createdAt": "2021-10-02T14:20:50.52Z" } ], "createdAt": "2021-10-02T14:20:50.52Z", "deletedAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:50.52Z", "hasFeedback": false, "summaryStats": { "likes": 42, "other": 42, "reviews": 42, "dislikes": 42, "unhelpful": 42, "inaccurate": 42, "irrelevant": 42, "repetitive": 42, "unanswered": 42, "interactions": 42 }}
Updates the properties of an existing thread with JSON Patch-formatted data.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantidstringRequired
The ID of the assistant containing the requested thread.
- threadidstringRequired
The ID of the thread to retrieve.
Request Body
Requiredapplication/json
An array of JSON Patch documents.
- application/jsonarray of objects
An array of JSON Patch documents.
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
A JSON Pointer.
- valuestring|number|booleanRequired
The value to be used for this operation.
One of:- string
- number
- boolean
-
-
Responses
204
Thread updated successfully.
400
application/json
Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
401
application/json
Not authorized.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The term to patch was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
429
application/json
The request has been rate-limited.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantid}/threads/{threadid}" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"replace","path":"/name","value":"new name"}]'
const https = require('https') const data = JSON.stringify([{"op":"replace","path":"/name","value":"new name"}]) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantid}/threads/{threadid}', 'method': 'PATCH', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
[ { "op": "replace", "path": "/name", "value": "new name" }]
Deletes the specified thread and all of its resources.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantidstringRequired
The ID of the assistant containing the requested thread.
- threadidstringRequired
The ID of the thread to retrieve.
Responses
204
Successful operation.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantid}/threads/{threadid}" \-X DELETE \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantid}/threads/{threadid}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Execute prompt in synchronous non-streaming mode.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The id of the Assistant containing requested Thread
- threadIdstringRequired
The id of the Thread to retrieve
Request Body
application/json
- application/jsonobject
application/json properties
- inputobject
input properties
- promptstring
Input prompt string for the Assistant to respond to.
- promptTypestring
Sets the prompt type to thread.
Can be one of: "thread"
- includeTextboolean
Returns text from chunks in sources output. Default value is false.
-
-
Responses
200
application/json
Prompt is successfully executed.
- application/jsonobject
application/json properties
- outputstring
Assistant's response to the prompt
- sourcesarray of objects
List of sources used to generate AI messages
sources properties
- chunksarray of objects
List of Chunks used for "AI" generated messages
- sourcestring
path to the document used
- documentIdstring
reference to Document used for "AI" generated messages
- datasourceIdstring
reference to DataSource used for "AI" generated messages
- knowledgebaseIdstring
reference to KnowledgeBase used for "AI" generated messages
-
- questionstring
Question asked by the user for assistant to answer
-
400
application/json
The request is in incorrect format
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
Assistant is not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
500
application/json
Prompt processing error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"input":{"prompt":"What is a LLM?","promptType":"thread","includeText":true}}'
const https = require('https') const data = JSON.stringify({"input":{"prompt":"What is a LLM?","promptType":"thread","includeText":true}}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "input": { "prompt": "What is a LLM?", "promptType": "thread", "includeText": true }}
Response
{ "output": "LLM stands for Large Language Model", "sources": [ { "chunks": [ { "text": "LLM stands for Large Language Model", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "question": "What was the primary goal of the Apollo program?"}
Execute prompt in asynchronous streaming mode.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The id of the Assistant containing requested Thread
- threadIdstringRequired
The id of the Thread to retrieve
Request Body
application/json
- application/jsonobject
application/json properties
- inputobject
input properties
- promptstring
Input prompt string for the Assistant to respond to.
- promptTypestring
Sets the prompt type to thread.
Can be one of: "thread"
- includeTextboolean
Returns text from chunks in sources output. Default value is false.
-
-
Responses
200
application/json
Prompt is successfully executed.
- application/jsonobject
application/json properties
- outputstring
Assistant's response to the prompt
- sourcesarray of objects
List of sources used to generate AI messages
sources properties
- chunksarray of objects
List of Chunks used for "AI" generated messages
- sourcestring
path to the document used
- documentIdstring
reference to Document used for "AI" generated messages
- datasourceIdstring
reference to DataSource used for "AI" generated messages
- knowledgebaseIdstring
reference to KnowledgeBase used for "AI" generated messages
-
-
400
application/json
The request is in incorrect format
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
Method is not allowed.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
405
application/json
Assistant is not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
500
application/json
Prompt processing error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Custom error codes
- AE-1 - Internal processing error
- AE-2 - Incorrect request
- AE-3 - Authentication issue
- AE-4 - Prompt is rejected
- AE-5 - Resource is not found
- AE-6 - API usage rate limit is exceeded
- AE-7 - Method is not allowed
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"input":{"prompt":"What is a LLM?","promptType":"thread","includeText":true}}'
const https = require('https') const data = JSON.stringify({"input":{"prompt":"What is a LLM?","promptType":"thread","includeText":true}}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "input": { "prompt": "What is a LLM?", "promptType": "thread", "includeText": true }}
Response
{ "output": "LLM stands for Large Language Model", "sources": [ { "chunks": [ { "text": "LLM stands for Large Language Model", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ]}
Retrieves the list of interactions for the thread.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Query Parameters
- limitinteger
The number of feedback to get.
- nextstring
Optional parameter to request the next page.
- prevstring
Optional parameter to request the previous page.
- sortstring
Optional resource field name to sort on, case insensitive, e.g.
created
. Can be prefixed with-
to set descending order; defaults to ascending.Can be one of: "CREATED""-CREATED""UPDATED""-UPDATED"
Path Parameters
- assistantIdstringRequired
The ID of the assistant from which to retrieve the interactions.
- threadIdstringRequired
The ID of the thread from which to retrieve the interactions.
Responses
200
application/json
Successfully retrieved the thread interactions.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
data properties
- idstringRequired
- ownerIdstringRequired
Unique identifier of user which created the interaction.
- requeststringRequired
Interaction request content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- feedbackobject
feedback properties
- idstringRequired
Unique feedback identifier.
- voteintegerRequired
Integer representation of feedback given (-1 = negative, 1 = positive).
- reasonstringRequired
Reason for feedback.
- commentstringRequired
Optional comment for feedback.
- reviewedAtstring
Datetime when the feedback was reviewed.
- reviewerIdstringRequired
Unique feedback reviewer identifier.
- reviewStatusstringRequired
Feedback review status.
-
- rejectedboolean
Indicator the system marked request as suspicious.
- responsestringRequired
Interaction response content.
- threadIdstringRequired
ID of the thread to which the interaction belongs.
- createdAtstringRequired
Datetime when the interaction was created.
- updatedAtstringRequired
Datetime when the interaction was updated.
-
- metaobject
meta properties
- countTotalinteger
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The feedback was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "data": [ { "id": "10d347c4-f28a-4faf-93f0-48e781aaf303", "ownerId": "65e310c43fb1cf46654e0878", "request": "Where was Genghis Khan buried?", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "feedback": { "id": "507f191e810c19729de860ea", "vote": 1, "reason": "inaccurate | irrelevant | repetitive | unhelpful | other", "comment": "string", "reviewedAt": "2021-10-02T14:20:50.52Z", "reviewerId": "507f191e810c19729de860ea", "reviewStatus": "reviewed | unreviewed" }, "rejected": true, "response": "Somewhere in an unmarked grave", "threadId": "125c24c4-668c-4c97-bef8-30d910169913", "createdAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:55.52Z" } ], "meta": { "countTotal": 42 }, "links": { "next": { "href": "string" }, "prev": { "href": "string" }, "self": { "href": "string" } }}
Creates a new interaction for the thread.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to create the interaction.
- threadIdstringRequired
The ID of the thread in which to create the interaction.
Request Body
application/json
- application/jsonobject
application/json properties
- requeststringRequired
Interaction request content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- rejectedboolean
Indicator the system marked request as suspicious.
- responsestringRequired
Interaction response content.
- rejectionReasoninteger
Rejection reason for a question:
- 1 - PROMPT_INJECTION
- 2 - OUT_OF_CONTEXT
- 3 - TOO_COMPLEX
Can be one of: 123
-
Responses
201
application/json
Successfully created a new thread interaction.
- application/jsonobject
application/json properties
- idstringRequired
- ownerIdstringRequired
Unique identifier of user which created the interaction.
- requeststringRequired
Interaction request content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- feedbackobject
feedback properties
- idstringRequired
Unique feedback identifier.
- voteintegerRequired
Integer representation of feedback given (-1 = negative, 1 = positive).
- reasonstringRequired
Reason for feedback.
- commentstringRequired
Optional comment for feedback.
- reviewedAtstring
Datetime when the feedback was reviewed.
- reviewerIdstringRequired
Unique feedback reviewer identifier.
- reviewStatusstringRequired
Feedback review status.
-
- rejectedboolean
Indicator the system marked request as suspicious.
- responsestringRequired
Interaction response content.
- threadIdstringRequired
ID of the thread to which the interaction belongs.
- createdAtstringRequired
Datetime when the interaction was created.
- updatedAtstringRequired
Datetime when the interaction was updated.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant or the thread was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"request":"Where was Genghis Khan buried?","sources":[{"chunks":[{"text":"string","chunkId":"10d347c4-f28a-4faf-93f0-48e781aaf303"}],"source":"Reference.md","documentId":"10d347c4-f28a-4faf-93f0-48e781aaf303","datasourceId":"10d347c4-f28a-4faf-93f0-48e781aaf303","lastIndexedAt":"2021-10-02T14:20:50.52Z","knowledgebaseId":"10d347c4-f28a-4faf-93f0-48e781aaf303"}],"rejected":true,"response":"Somewhere in an unmarked grave","rejectionReason":1}'
const https = require('https') const data = JSON.stringify({"request":"Where was Genghis Khan buried?","sources":[{"chunks":[{"text":"string","chunkId":"10d347c4-f28a-4faf-93f0-48e781aaf303"}],"source":"Reference.md","documentId":"10d347c4-f28a-4faf-93f0-48e781aaf303","datasourceId":"10d347c4-f28a-4faf-93f0-48e781aaf303","lastIndexedAt":"2021-10-02T14:20:50.52Z","knowledgebaseId":"10d347c4-f28a-4faf-93f0-48e781aaf303"}],"rejected":true,"response":"Somewhere in an unmarked grave","rejectionReason":1}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "request": "Where was Genghis Khan buried?", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "rejected": true, "response": "Somewhere in an unmarked grave", "rejectionReason": 1}
Response
{ "id": "10d347c4-f28a-4faf-93f0-48e781aaf303", "ownerId": "65e310c43fb1cf46654e0878", "request": "Where was Genghis Khan buried?", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "feedback": { "id": "507f191e810c19729de860ea", "vote": 1, "reason": "inaccurate | irrelevant | repetitive | unhelpful | other", "comment": "string", "reviewedAt": "2021-10-02T14:20:50.52Z", "reviewerId": "507f191e810c19729de860ea", "reviewStatus": "reviewed | unreviewed" }, "rejected": true, "response": "Somewhere in an unmarked grave", "threadId": "125c24c4-668c-4c97-bef8-30d910169913", "createdAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:55.52Z"}
Retrieves an interaction for the thread.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to retrieve the interaction.
- interactionIdstringRequired
The ID of the interaction to retrieve.
- threadIdstringRequired
The ID of the thread in which to retrieve the interaction.
Responses
200
application/json
Successfully retrieved the interaction.
- application/jsonobject
application/json properties
- idstringRequired
- ownerIdstringRequired
Unique identifier of user which created the interaction.
- requeststringRequired
Interaction request content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- feedbackobject
feedback properties
- idstringRequired
Unique feedback identifier.
- voteintegerRequired
Integer representation of feedback given (-1 = negative, 1 = positive).
- reasonstringRequired
Reason for feedback.
- commentstringRequired
Optional comment for feedback.
- reviewedAtstring
Datetime when the feedback was reviewed.
- reviewerIdstringRequired
Unique feedback reviewer identifier.
- reviewStatusstringRequired
Feedback review status.
-
- rejectedboolean
Indicator the system marked request as suspicious.
- responsestringRequired
Interaction response content.
- threadIdstringRequired
ID of the thread to which the interaction belongs.
- createdAtstringRequired
Datetime when the interaction was created.
- updatedAtstringRequired
Datetime when the interaction was updated.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The interaction was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "id": "10d347c4-f28a-4faf-93f0-48e781aaf303", "ownerId": "65e310c43fb1cf46654e0878", "request": "Where was Genghis Khan buried?", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "feedback": { "id": "507f191e810c19729de860ea", "vote": 1, "reason": "inaccurate | irrelevant | repetitive | unhelpful | other", "comment": "string", "reviewedAt": "2021-10-02T14:20:50.52Z", "reviewerId": "507f191e810c19729de860ea", "reviewStatus": "reviewed | unreviewed" }, "rejected": true, "response": "Somewhere in an unmarked grave", "threadId": "125c24c4-668c-4c97-bef8-30d910169913", "createdAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:55.52Z"}
Deletes the specified interaction and all of its resources.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to delete the interaction.
- interactionIdstringRequired
The ID of the interaction to delete.
- threadIdstringRequired
The ID of the thread in which to delete the interaction.
Responses
204
Successful operation.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The resource was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}" \-X DELETE \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Creates feedback for the thread.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to create the feedback.
- interactionIdstringRequired
The ID of the interaction in which to create the feedback.
- threadIdstringRequired
The ID of the thread in which to create the feedback.
Request Body
application/json
- application/jsonobject
application/json properties
- voteintegerRequired
Integer representation of feedback given (-1 = negative, 1 = positive).
- reasonstringRequired
Reason for feedback.
- commentstring
Optional comment for feedback.
-
Responses
201
application/json
Successfully created a new thread feedback.
- application/jsonobject
application/json properties
- idstringRequired
- ownerIdstringRequired
Unique identifier of user which created the interaction.
- requeststringRequired
Interaction request content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- feedbackobject
feedback properties
- idstringRequired
Unique feedback identifier.
- voteintegerRequired
Integer representation of feedback given (-1 = negative, 1 = positive).
- reasonstringRequired
Reason for feedback.
- commentstringRequired
Optional comment for feedback.
- reviewedAtstring
Datetime when the feedback was reviewed.
- reviewerIdstringRequired
Unique feedback reviewer identifier.
- reviewStatusstringRequired
Feedback review status.
-
- rejectedboolean
Indicator the system marked request as suspicious.
- responsestringRequired
Interaction response content.
- threadIdstringRequired
ID of the thread to which the interaction belongs.
- createdAtstringRequired
Datetime when the interaction was created.
- updatedAtstringRequired
Datetime when the interaction was updated.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The resource was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"vote":1,"reason":"inaccurate | irrelevant | repetitive | unhelpful | other","comment":"string"}'
const https = require('https') const data = JSON.stringify({"vote":1,"reason":"inaccurate | irrelevant | repetitive | unhelpful | other","comment":"string"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "vote": 1, "reason": "inaccurate | irrelevant | repetitive | unhelpful | other", "comment": "string"}
Response
{ "id": "10d347c4-f28a-4faf-93f0-48e781aaf303", "ownerId": "65e310c43fb1cf46654e0878", "request": "Where was Genghis Khan buried?", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "feedback": { "id": "507f191e810c19729de860ea", "vote": 1, "reason": "inaccurate | irrelevant | repetitive | unhelpful | other", "comment": "string", "reviewedAt": "2021-10-02T14:20:50.52Z", "reviewerId": "507f191e810c19729de860ea", "reviewStatus": "reviewed | unreviewed" }, "rejected": true, "response": "Somewhere in an unmarked grave", "threadId": "125c24c4-668c-4c97-bef8-30d910169913", "createdAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:55.52Z"}
Updates feedback for the thread.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant containing the requested feedback.
- feedbackIdstringRequired
The ID of the feedback to update.
- interactionIdstringRequired
The ID of the interaction containing the requested Feedback.
- threadIdstringRequired
The ID of the thread containing the requested feedback.
Request Body
application/json
An array of JSON Patch documents.
- application/jsonarray of objects
An array of JSON Patch documents.
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
A JSON Pointer.
- valuestring|number|booleanRequired
The value to be used for this operation.
One of:- string
- number
- boolean
-
-
Responses
204
Successfully updated the feedback.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The resource was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"replace","path":"/reason","value":"irrelevant"}]'
const https = require('https') const data = JSON.stringify([{"op":"replace","path":"/reason","value":"irrelevant"}]) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}', 'method': 'PATCH', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
[ { "op": "replace", "path": "/reason", "value": "irrelevant" }]
Creates feedback review for the thread.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- assistantIdstringRequired
The ID of the assistant in which to create the feedback review.
- interactionIdstringRequired
The ID of the interaction in which to create the feedback review.
- threadIdstringRequired
The ID of the thread in which to create the feedback review.
Request Body
application/json
- application/jsonobject
application/json properties
- reviewStatusstringRequired
Review status.
-
Responses
201
application/json
Successfully created a new thread feedback.
- application/jsonobject
application/json properties
- idstringRequired
- ownerIdstringRequired
Unique identifier of user which created the interaction.
- requeststringRequired
Interaction request content.
- sourcesarray of objectsRequired
List of sources used to generate AI messages (interactions).
sources properties
- chunksarray of objectsRequired
List of Chunks used for "AI" generated messages.
chunks properties
- textstring
Chunk text for "AI" generated message source.
- chunkIdstringRequired
Chunk unique identifier for "AI" generated message source.
-
- sourcestringRequired
Path to the document used.
- documentIdstringRequired
Reference to Document used for "AI" generated messages.
- datasourceIdstringRequired
Reference to DataSource used for "AI" generated messages.
- lastIndexedAtstring
Datetime when the knowledgebase was last indexed.
- knowledgebaseIdstringRequired
Reference to KnowledgeBase used for "AI" generated messages.
-
- feedbackobject
feedback properties
- idstringRequired
Unique feedback identifier.
- voteintegerRequired
Integer representation of feedback given (-1 = negative, 1 = positive).
- reasonstringRequired
Reason for feedback.
- commentstringRequired
Optional comment for feedback.
- reviewedAtstring
Datetime when the feedback was reviewed.
- reviewerIdstringRequired
Unique feedback reviewer identifier.
- reviewStatusstringRequired
Feedback review status.
-
- rejectedboolean
Indicator the system marked request as suspicious.
- responsestringRequired
Interaction response content.
- threadIdstringRequired
ID of the thread to which the interaction belongs.
- createdAtstringRequired
Datetime when the interaction was created.
- updatedAtstringRequired
Datetime when the interaction was updated.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The user does not have privileges to perform the requested action.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
A resource was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"reviewStatus":"reviewed | unreviewed"}'
const https = require('https') const data = JSON.stringify({"reviewStatus":"reviewed | unreviewed"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "reviewStatus": "reviewed | unreviewed"}
Response
{ "id": "10d347c4-f28a-4faf-93f0-48e781aaf303", "ownerId": "65e310c43fb1cf46654e0878", "request": "Where was Genghis Khan buried?", "sources": [ { "chunks": [ { "text": "string", "chunkId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "source": "Reference.md", "documentId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "datasourceId": "10d347c4-f28a-4faf-93f0-48e781aaf303", "lastIndexedAt": "2021-10-02T14:20:50.52Z", "knowledgebaseId": "10d347c4-f28a-4faf-93f0-48e781aaf303" } ], "feedback": { "id": "507f191e810c19729de860ea", "vote": 1, "reason": "inaccurate | irrelevant | repetitive | unhelpful | other", "comment": "string", "reviewedAt": "2021-10-02T14:20:50.52Z", "reviewerId": "507f191e810c19729de860ea", "reviewStatus": "reviewed | unreviewed" }, "rejected": true, "response": "Somewhere in an unmarked grave", "threadId": "125c24c4-668c-4c97-bef8-30d910169913", "createdAt": "2021-10-02T14:20:50.52Z", "updatedAt": "2021-10-02T14:20:55.52Z"}
Retrieves the specified assistant.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories |
Path Parameters
- idstringRequired
The ID of the assistant to retrieve.
Responses
200
application/json
Successfully retrieved the assistant.
- application/jsonobject
application/json properties
- idstringRequired
Unique identifier of the assistant.
- namestringRequired
The name of the assistant.
- tagsarray of stringsRequired
The list of tags associated with the assistant.
- titlestring
The title of the assistant.
- ownerIdstringRequired
Unique identifier of the assistant owner.
- spaceIdstringRequired
Unique identifier of the space containing the assistant.
- tenantIdstringRequired
Unique identifier of the assistant tenant.
- createdAtstringRequired
Datetime when the assistant was created.
- createdBystringRequired
Unique identifier of the user who created the assistant.
- hasAvatarboolean
Indicates if the assistant has an avatar.
- updatedAtstringRequired
Datetime when the assistant was updated.
- updatedBystringRequired
Unique identifier of the user who last updated the assistant.
- descriptionstringRequired
The description of the assistant.
- systemMessagestringDeprecated
System prompt setting up conversation context.
- knowledgeBasesarray of stringsRequired
List of knowledgebases the assistant is using.
- welcomeMessagestringRequired
Initial message in the chat conversation.
- customPropertiesobjectRequired
freeform JSON to allow custom customization options.
- defaultPromptTypestring
Default prompt type for the assistant.
Can be one of: "thread""oneshot"
- orderedStarterIdsarray of strings
List of starter IDs in the order they will be sorted.
-
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{id}" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{id}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "id": "507f191e810c19729de860ea", "name": "Organization-wide Assistant", "tags": [ "Red", "Sales" ], "title": "Assistant for Sales activities", "ownerId": "507f191e810c19729de860ea", "spaceId": "507f191e810c19729de860ea", "tenantId": "507f191e810c19729de860ea", "createdAt": "2021-10-02T14:20:50.52Z", "createdBy": "507f191e810c19729de860ea", "hasAvatar": true, "updatedAt": "2021-10-02T14:20:50.52Z", "updatedBy": "507f191e810c19729de860ea", "description": "This assistant is used for...", "systemMessage": "You are helpful Sales assistant. Provide concise and actionable insights.", "knowledgeBases": [ "507f191e810c19729de860ea" ], "welcomeMessage": "Welcome to Sales process support Assistant.", "customProperties": { "customErrors": { "outsideScopeError": "Outside of scope error", "complexQuestionError": "Complex question error", "promptInjectionError": "Prompt injection error" } }, "defaultPromptType": "thread", "orderedStarterIds": [ "507f191e810c19729de860ea", "787f191e810c19729de860er" ]}
Updates the properties of an existing assistant with JSON Patch-formatted data.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Header Parameters
- if-matchstring
Optional header to do conditional updates. Using the Etag value that was returned the last time the assistant was fetched.
Path Parameters
- idstringRequired
The assistant ID.
Request Body
Requiredapplication/json
An array of JSON Patch documents.
- application/jsonarray of objects
An array of JSON Patch documents.
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
A JSON Pointer.
- valuestring|number|booleanRequired
The value to be used for this operation.
One of:- string
- number
- boolean
-
-
Responses
204
Assistant updated successfully.
400
application/json
Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
401
application/json
Not authorized.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The term to patch was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
429
application/json
The request has been rate-limited.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{id}" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"},{"op":"add","path":"/defaultPromptType","value":"thread"},{"op":"remove","path":"/avatar"},{"op":"add","path":"/avatar","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="},{"op":"replace","path":"/avatar","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="}]'
const https = require('https') const data = JSON.stringify([{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"},{"op":"add","path":"/defaultPromptType","value":"thread"},{"op":"remove","path":"/avatar"},{"op":"add","path":"/avatar","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="},{"op":"replace","path":"/avatar","value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="}]) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{id}', 'method': 'PATCH', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
[ { "op": "replace", "path": "/name", "value": "new name" }, { "op": "replace", "path": "/description", "value": "new description" }, { "op": "add", "path": "/defaultPromptType", "value": "thread" }, { "op": "remove", "path": "/avatar" }, { "op": "add", "path": "/avatar", "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg==" }, { "op": "replace", "path": "/avatar", "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg==" }]
Deletes the assistant and all of its resources.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories |
Path Parameters
- idstringRequired
The ID of the assistant to delete.
Responses
204
Successful operation.
400
application/json
The request is in incorrect format.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
403
application/json
The operation failed due to insufficient permissions.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
404
application/json
The assistant was not found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
- titlestring
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/assistants/{id}" \-X DELETE \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/assistants/{id}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli