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

Qlik Knowledgebases API

Knowledgebases are collections of individual data sources, that are indexed for use in generating responses to user questions via Assistants for Qlik Answers.

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

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

This API exposes 18 operations across 12 paths, organized into 2 resource areas, and defines 40 schemas. It is described by OpenAPI 3.0.0.

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

18 operations 12 paths 40 schemas 3 DELETE6 GET1 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 18

Across 12 paths, the API surfaces 18 operations — 3 DELETE, 6 GET, 1 PATCH, 7 POST, 1 PUT. They span 2 resource areas: knowledgebases, search. Each is listed below with its method, path, parameters, and response codes.

knowledgebases 17
GET
/api/v1/knowledgebases
List knowledgebases
5 params → 200400403
POST
/api/v1/knowledgebases
Create new knowledgebase
body → 201400403
GET
/api/v1/knowledgebases/{id}
Retrieve a knowledgebase
1 param → 200400403404
PATCH
/api/v1/knowledgebases/{id}
Update a knowledgebase
2 params body → 204400401403404429
DELETE
/api/v1/knowledgebases/{id}
Delete a knowledgebase
1 param → 204400403404
POST
/api/v1/knowledgebases/{id}/datasources
Add a datasource to a knowledgebase
1 param body → 201400403404
PUT
/api/v1/knowledgebases/{id}/datasources/{datasourceId}
Update a knowledgebase datasource
2 params body → 200400403404
DELETE
/api/v1/knowledgebases/{id}/datasources/{datasourceId}
Delete a knowledgebase datasource
2 params → 204400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel
Cancel sync of a knowledgebase datasource
2 params → 200400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download
Download knowledgebase datasource reference
2 params body → 200400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync
Sync a knowledgebase datasource
3 params → 202400403404
GET
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories
List knowledgebase datasource sync histories
6 params → 200400403404
GET
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId}
Retrieve a knowledgebase datasource sync history
3 params → 200400403404
GET
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
Get a knowledgebase datasource schedule
2 params → 200400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
Create a knowledgebase datasource schedule
2 params body → 200201400403404
DELETE
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
Delete knowledgebase datasource schedule
2 params → 204400403404
GET
/api/v1/knowledgebases/{id}/histories
Retrieve knowledgebase sync history
5 params → 200400403404
search 1
POST
/api/v1/knowledgebases/{id}/actions/search
Search chunks from a knowledge base
1 param body → 200400403404405500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are syncHistoryDetails (15 properties), knowledgeBaseLight (15 properties), syncHistory (10 properties), dataSource (9 properties). Each schema is shown below with its type and property counts.

chunk
object
5 properties 2 required
chunking
object
5 properties 5 required
contentSummary
object
4 properties 4 required
createDataSource
object
Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both a…
3 properties 2 required
createKnowledgeBase
object
6 properties 2 required
dataSource
object
Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both a…
9 properties 3 required
dataSourceCrawlPattern
object
Include or exclude pattern
2 properties 2 required
dataSourceFileConfig
object
Specification on where to fetch the files for. This is required when the type == 'file'. Only one of path and files can be set. Path takes precedence if both a…
6 properties 2 required
dataSourceFileCrawlScope
object
Scope for the file crawler.
6 properties 1 required
dataSourceSync
object
Response when a datasource sync is started, contains the sync Id
1 property 1 required
dataSourceSyncStatus
object
4 properties 4 required
docStats
object
Summary of documents processed
9 properties 9 required
downloadFile
object
1 property 1 required
downloadFileResponse
object
Download information for the file.
6 properties 6 required
duration
object
5 properties 5 required
errorResponse
object
2 properties
errorResponseCode
object
3 properties
errorResponseCodeCopy
object
3 properties
errorResponseCopy
object
2 properties
indexingErrorCode
string
Stable, machine-readable error category for an indexing failure, shared across services (worker, indexer, assistants) and the UI so failures can be mapped to f…
JSONPatch
object
A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
3 properties 3 required
JSONPatchArray
array
An array of JSON Patch documents
kbChunkMeta
object
Metadata about the chunk
5 properties 5 required
knowledgeBase
knowledgeBaseLight
object
15 properties 11 required
knowledgeBasesResult
object
2 properties 1 required
pageLink
object
1 property
pageLinks
object
3 properties
resultMeta
object
1 property
schedule
object
2 properties
scheduleCalendar
object
An event specification relative to the calendar, similar to a traditional cron specification.
8 properties 8 required
scheduleInterval
object
For example, an every of 1 hour with offset of zero would match every hour, on the hour. The same every but an offset of 19 minutes would match every xx:19:00.
2 properties 1 required
scheduleRange
object
ScheduleRange represents a set of integer values, used to match fields of a calendar time in scheduleCalendar. If end < start, then end is interpreted as equal…
3 properties 1 required
scheduleWithManifest
object
7 properties 4 required
searchRequest
object
3 properties 1 required
searchResponse
object
1 property 1 required
syncErrorSummary
object
Aggregated view of all failures of a single category within one sync.
4 properties 2 required
syncHistory
object
10 properties 7 required
syncHistoryDetails
object
15 properties 6 required
syncHistoryResult
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-knowledgebases.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

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

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

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

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

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