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 Sense Knowledge Bases API

The Knowledge Bases API from Qlik Sense — 11 operation(s) for knowledge bases.

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

Tagged areas include Knowledge Bases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 17 operations across 11 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0.

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

17 operations 11 paths 34 schemas 3 DELETE6 GET1 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
wss://your-tenant.qlikcloud.com/app/
Resource Areas
1

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 3 DELETE, 6 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Knowledge Bases 17
GET
/api/v1/knowledgebases
List knowledgebases
getApiV1Knowledgebases 5 params → 200400403
POST
/api/v1/knowledgebases
Create new knowledgebase
postApiV1Knowledgebases body → 201400403
GET
/api/v1/knowledgebases/{id}
Retrieve a knowledgebase
getApiV1KnowledgebasesById 1 param → 200400403404
PATCH
/api/v1/knowledgebases/{id}
Update a knowledgebase
patchApiV1KnowledgebasesById 2 params body → 204400401403404429
DELETE
/api/v1/knowledgebases/{id}
Delete a knowledgebase
deleteApiV1KnowledgebasesById 1 param → 204400403404
POST
/api/v1/knowledgebases/{id}/datasources
Add a datasource to a knowledgebase
postApiV1KnowledgebasesByIdDatasources 1 param body → 201400403404
PUT
/api/v1/knowledgebases/{id}/datasources/{datasourceId}
Update a knowledgebase datasource
putApiV1KnowledgebasesByIdDatasourcesByDatasourceId 2 params body → 200400403404
DELETE
/api/v1/knowledgebases/{id}/datasources/{datasourceId}
Delete a knowledgebase datasource
deleteApiV1KnowledgebasesByIdDatasourcesByDatasourceId 2 params → 204400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel
Cancel sync of a knowledgebase datasource
postApiV1KnowledgebasesByIdDatasourcesByDatasourceIdActionsCancel 2 params → 200400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download
Download knowledgebase datasource reference
postApiV1KnowledgebasesByIdDatasourcesByDatasourceIdActionsDownload 2 params body → 200400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync
Sync a knowledgebase datasource
postApiV1KnowledgebasesByIdDatasourcesByDatasourceIdActionsSync 3 params → 202400403404
GET
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories
List knowledgebase datasource sync histories
getApiV1KnowledgebasesByIdDatasourcesByDatasourceIdHistories 6 params → 200400403404
GET
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId}
Retrieve a knowledgebase datasource sync history
getApiV1KnowledgebasesByIdDatasourcesByDatasourceIdHistoriesBySyncId 3 params → 200400403404
GET
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
Get a knowledgebase datasource schedule
getApiV1KnowledgebasesByIdDatasourcesByDatasourceIdSchedules 2 params → 200400403404
POST
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
Create a knowledgebase datasource schedule
postApiV1KnowledgebasesByIdDatasourcesByDatasourceIdSchedules 2 params body → 200201400403404
DELETE
/api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules
Delete knowledgebase datasource schedule
deleteApiV1KnowledgebasesByIdDatasourcesByDatasourceIdSchedules 2 params → 204400403404
GET
/api/v1/knowledgebases/{id}/histories
Retrieve knowledgebase sync history
getApiV1KnowledgebasesByIdHistories 5 params → 200400403404

Schemas 34

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

resultMeta
object
1 property
dataSourceCrawlPattern
object
Include or exclude pattern
2 properties 2 required
contentSummary
object
4 properties 4 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
downloadFile
object
1 property 1 required
knowledgeBaseLight
object
15 properties 11 required
dataSourceFileCrawlScope
object
Scope for the file crawler.
6 properties 1 required
knowledgeBase
scheduleWithManifest
object
7 properties 4 required
dataSourceSyncStatus
object
4 properties 4 required
docStats
object
Summary of documents processed
9 properties 9 required
createKnowledgeBase
object
6 properties 2 required
JSONPatch
object
A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
3 properties 3 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
syncErrorSummary
object
Aggregated view of all failures of a single category within one sync.
4 properties 2 required
knowledgeBasesResult
object
2 properties 1 required
scheduleCalendar
object
An event specification relative to the calendar, similar to a traditional cron specification.
8 properties 8 required
downloadFileResponse
object
Download information for the file.
6 properties 6 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
syncHistoryResult
object
3 properties 1 required
errorResponseCodeCopy
object
3 properties
JSONPatchArray
array
An array of JSON Patch documents
schedule
object
2 properties
duration
object
5 properties 5 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
errorResponseCopy
object
2 properties
pageLinks
object
3 properties
syncHistoryDetails
object
15 properties 6 required
pageLink
object
1 property
syncHistory
object
10 properties 7 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
chunking
object
5 properties 5 required
dataSourceSync
object
Response when a datasource sync is started, contains the sync Id
1 property 1 required
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-knowledge-bases-api-openapi.yml Raw ↑

Other APIs Qlik Sense publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Sense Engine API
Qlik Sense Repository API
Qlik Sense Proxy API
Qlik Data Integration API
Qlik Embedding API
Qlik Sense alerting actions API
Qlik Sense alerting settings API
Qlik Sense alerting tasks API
Where this information came from

This is an independent, third-party profile of Qlik Sense Knowledge Bases 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.