Knowledgebases are collections of individual data sources, that are indexed for use in generating responses to user questions via Assistants for Qlik Answers.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/knowledgebases-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "knowledgebases",
"version": ""
},
"paths": {
"/api/v1/knowledgebases": {
"get": {
"tags": [
"knowledgebases"
],
"summary": "List knowledgebases",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/knowledgeBasesResult"
}
}
},
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The user does not have privileges to perform the requested action."
}
},
"parameters": [
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"description": "The number of knowledgebases to get."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"description": "Optional parameter to request the next page."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"description": "Optional parameter to request the previous page."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"NAME",
"-NAME",
"DESCRIPTION",
"-DESCRIPTION",
"CREATED",
"-CREATED",
"UPDATED",
"-UPDATED"
],
"type": "string"
},
"description": "Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending."
},
{
"in": "query",
"name": "countTotal",
"schema": {
"type": "boolean",
"default": false
},
"description": "Optional parameter to request total count for query",
"x-qlik-deprecated": true
}
],
"description": "Returns a list of all knowledgebases the user has access to.",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"knowledgebases"
],
"summary": "Create new knowledgebase",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/knowledgeBaseLight"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Knowledgebase version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the knowledgebase"
}
},
"description": "Successfully created a new knowledgebase."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The user does not have privileges to perform the requested action."
}
},
"description": "Creates a new knowledgebase.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createKnowledgeBase"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}": {
"get": {
"tags": [
"knowledgebases"
],
"summary": "Retrieve a knowledgebase",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/knowledgeBase"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Knowledgebase version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the knowledgebase"
}
},
"description": "Successfully retrieved the knowledgebase."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The knowledgebase is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase to retrieve."
}
],
"description": "Retrieves a specific knowledgebase.",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"knowledgebases"
],
"summary": "Update a knowledgebase",
"responses": {
"204": {
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Knowledgebase version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the knowledgebase"
}
},
"description": "Knowledgebase updated successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "Not authorized."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The term to patch was not found."
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"headers": {
"retry-after": {
"schema": {
"type": "integer",
"default": 1
},
"description": "The amount of seconds to wait before retrying the request."
}
},
"description": "Request has been rate limited."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The knowledgebase id."
},
{
"in": "header",
"name": "if-match",
"schema": {
"type": "string",
"example": "if-match: B323333"
},
"description": "Optional header to do conditional updates. Using the Etag value that was returned the last time the knowledgebase was fetched."
}
],
"description": "Updates properties of a specific knowledgebase.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JSONPatchArray"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"knowledgebases"
],
"summary": "Delete a knowledgebase",
"responses": {
"204": {
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The knowledgebase is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase to delete."
}
],
"description": "Deletes a knowledgebase and all of its resources.",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}/actions/search": {
"post": {
"tags": [
"search"
],
"summary": "Search chunks from a knowledge base",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchResponse"
}
}
},
"description": "Chunks retrieved successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The user does not have privileges to perform the requested action."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Knowledgebase is not found."
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Method is not allowed."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Prompt processing error."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "507f191e810c19729de860ea"
},
"required": true,
"description": "The ID of the knowledgebase"
}
],
"description": "Execute search with either `SIMPLE` or `FULL` mode. SIMPLE does semantic search while FULL will also do reranking and include keyword based chunks. Use topN to control number of chunks in response, max limit is 50. Default to 5.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchRequest"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}/datasources": {
"post": {
"tags": [
"knowledgebases"
],
"summary": "Add a datasource to a knowledgebase",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataSource"
}
}
},
"description": "Successfully added a datasource to the knowledgebase."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The user does not have privileges to perform the requested action."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The knowledgebase is not found."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase."
}
],
"description": "Adds a datasource to a knowledgebase.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createDataSource"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}/datasources/{datasourceId}": {
"put": {
"tags": [
"knowledgebases"
],
"summary": "Update a knowledgebase datasource",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataSource"
}
}
},
"description": "Successfully updated the datasource."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The record is not found"
}
},
"parameters": [
{
"in": "path",
"name": "datasourceId",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the datasource to update."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of a knowledgebase."
}
],
"description": "Updates a specified datasource.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataSource"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"knowledgebases"
],
"summary": "Delete a knowledgebase datasource",
"responses": {
"204": {
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The knowledgebase is not found"
}
},
"parameters": [
{
"in": "path",
"name": "datasourceId",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the datasource to delete."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase the datasource belongs to."
}
],
"description": "Deletes a specified datasource and all its resources.",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel": {
"post": {
"tags": [
"knowledgebases"
],
"summary": "Cancel sync of a knowledgebase datasource",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataSourceSync"
}
}
},
"description": "Successfully cancelled sync."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The user does not have privileges to perform the requested action."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The resource does not exist."
}
},
"parameters": [
{
"in": "path",
"name": "datasourceId",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the datasource to cancel sync for."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase the datasource belongs to."
}
],
"description": "Cancels ongoing sync for a specified datasource.",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download": {
"post": {
"tags": [
"knowledgebases"
],
"summary": "Download knowledgebase datasource reference",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/downloadFileResponse"
}
}
},
"description": "Download a file from a datasource."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The user does not have privileges to perform the requested action."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The resource does not exist."
}
},
"parameters": [
{
"in": "path",
"name": "datasourceId",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the datasource to download from."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase the datasource belongs to."
}
],
"description": "Downloads a specified reference.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/downloadFile"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync": {
"post": {
"tags": [
"knowledgebases"
],
"summary": "Sync a knowledgebase datasource",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dataSourceSync"
}
}
},
"description": "Successfully started sync."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The request is in incorrect format."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The user does not have privileges to perform the requested action."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponseCopy",
"x-qlik-merge-conflict": true
}
}
},
"description": "The resource does not exist."
}
},
"parameters": [
{
"in": "path",
"name": "datasourceId",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the datasource to sync."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "f256b3e4-03e0-4f74-ae46-a4d43882ee5d"
},
"required": true,
"description": "The id of the knowledgebase the datasource belongs to."
},
{
"in": "query",
"name": "migrate",
"schema": {
"type": "boolean"
},
"description": "Optional parameter to migrate indexed files to docdetails collection"
}
],
"description": "Starts syncing a specified dataso
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-knowledgebases.json