Qlik Sense Knowledge Bases API

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

Documentation GitHub OpenAPI

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/knowledgebases List knowledge bases · List knowledgebases #

Ask an LLM

“Which knowledge bases do I have access to?”

“Can I page through and sort my knowledge bases?”

Tell an agent

List my knowledge bases.

List {limit} knowledge bases sorted by {sort}.

POST /api/v1/knowledgebases Create a knowledge base · Create new knowledgebase #

Ask an LLM

“Can I create a new knowledge base to feed an assistant?”

“Does a knowledge base have to live in a space?”

Tell an agent

Create knowledge base {name} in space {spaceId}.

Create knowledge base {name} in space {spaceId} with advanced indexing {advancedIndexing}.

GET /api/v1/knowledgebases/{id} Get a knowledge base · Retrieve a knowledgebase #

Ask an LLM

“Can I view the details and datasources of one knowledge base?”

“Where do I look up a single knowledge base by ID?”

Tell an agent

Show knowledge base {id}.

Get the details of knowledge base {id}.

PATCH /api/v1/knowledgebases/{id} Update a knowledge base · Update a knowledgebase #

Ask an LLM

“Can I rename a knowledge base or change its description?”

“Is a partial update of knowledge base properties supported?”

Tell an agent

Update knowledge base {id}.

Patch the properties of knowledge base {id} if it matches {ifMatch}.

DELETE /api/v1/knowledgebases/{id} Delete a knowledge base · Delete a knowledgebase #

Ask an LLM

“Can I delete a whole knowledge base?”

“Are all datasources removed when a knowledge base is deleted?”

Tell an agent destructive · confirm first

Delete knowledge base {id}.

Remove knowledge base {id} and all of its resources.

POST /api/v1/knowledgebases/{id}/datasources Add a datasource to a knowledge base · Add a datasource to a knowledgebase #

Ask an LLM

“Can I add a folder of documents as a source for a knowledge base?”

“What types of datasource can a knowledge base pull from?”

Tell an agent

Add datasource {name} of type {type} to knowledge base {id}.

Attach a new {type} source named {name} to knowledge base {id}.

PUT /api/v1/knowledgebases/{id}/datasources/{datasourceId} Update a knowledge base datasource · Update a knowledgebase datasource #

Ask an LLM

“Can I change the chunking or file settings of an existing knowledge base source?”

“Which fields are required when replacing a knowledge base datasource?”

Tell an agent

Update datasource {datasourceId} in knowledge base {id}.

Change chunking of source {datasourceId} in knowledge base {id} to {chunking}.

DELETE /api/v1/knowledgebases/{id}/datasources/{datasourceId} Remove a datasource from a knowledge base · Delete a knowledgebase datasource #

Ask an LLM

“Can I remove one source from a knowledge base without deleting the whole thing?”

“What happens to indexed content when a datasource is deleted?”

Tell an agent destructive · confirm first

Delete datasource {datasourceId} from knowledge base {id}.

Remove source {datasourceId} and its resources from knowledge base {id}.

POST /api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/cancel Cancel a datasource sync · Cancel sync of a knowledgebase datasource #

Ask an LLM

“Can I stop a knowledge base datasource sync that is still running?”

“Is there a way to abort an in-progress source sync?”

Tell an agent destructive · confirm first

Cancel the sync of datasource {datasourceId} in knowledge base {id}.

Abort the running sync for source {datasourceId} of knowledge base {id}.

POST /api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/download Download a datasource reference document · Download knowledgebase datasource reference #

Ask an LLM

“Can I download the original document a knowledge base source references?”

“Which path do I give to download a referenced file?”

Tell an agent

Download reference {path} from datasource {datasourceId} in knowledge base {id}.

Get the source file at {path} behind datasource {datasourceId} of knowledge base {id}.

POST /api/v1/knowledgebases/{id}/datasources/{datasourceId}/actions/sync Sync a datasource into a knowledge base · Sync a knowledgebase datasource #

Ask an LLM

“Can I trigger a fresh sync of one knowledge base source?”

“Is there an option to migrate the index while syncing a source?”

Tell an agent

Sync datasource {datasourceId} into knowledge base {id}.

Start a sync of source {datasourceId} in knowledge base {id} with migrate {migrate}.

GET /api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories List sync history of a datasource · List knowledgebase datasource sync histories #

Ask an LLM

“When was one knowledge base source last synced, and did those syncs succeed?”

“Why would a datasource sync history request return a 404?”

Tell an agent

List sync history for datasource {datasourceId} in knowledge base {id}.

Show the last {limit} syncs of source {datasourceId} in knowledge base {id}.

GET /api/v1/knowledgebases/{id}/datasources/{datasourceId}/histories/{syncId} Get details of one datasource sync · Retrieve a knowledgebase datasource sync history #

Ask an LLM

“Can I see the detailed result of one specific datasource sync run?”

“What went wrong in one particular knowledge base sync?”

Tell an agent

Get sync {syncId} of datasource {datasourceId} in knowledge base {id}.

Show the detailed outcome of sync run {syncId} for source {datasourceId} in knowledge base {id}.

GET /api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules Get a datasource sync schedule · Get a knowledgebase datasource schedule #

Ask an LLM

“Is a knowledge base source set to sync automatically on a schedule?”

“What calendar or interval does a datasource schedule use?”

Tell an agent

Show the sync schedule of datasource {datasourceId} in knowledge base {id}.

Check when source {datasourceId} of knowledge base {id} is scheduled to sync.

POST /api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules Schedule a datasource sync · Create a knowledgebase datasource schedule #

Ask an LLM

“Can I make a knowledge base source resync automatically?”

“Can a source sync schedule use calendars or fixed intervals?”

Tell an agent

Schedule datasource {datasourceId} in knowledge base {id} to sync every {intervals}.

Set a calendar schedule {calendars} for source {datasourceId} of knowledge base {id}.

DELETE /api/v1/knowledgebases/{id}/datasources/{datasourceId}/schedules Remove a datasource sync schedule · Delete knowledgebase datasource schedule #

Ask an LLM

“Can I stop a knowledge base source from syncing on a schedule?”

“Does deleting a schedule remove the datasource itself?”

Tell an agent destructive · confirm first

Delete the sync schedule of datasource {datasourceId} in knowledge base {id}.

Turn off scheduled syncing for source {datasourceId} of knowledge base {id}.

GET /api/v1/knowledgebases/{id}/histories Get sync history of a whole knowledge base · Retrieve knowledgebase sync history #

Ask an LLM

“When was a knowledge base last synced across all its sources?”

“Can I page through every sync recorded for a knowledge base?”

Tell an agent

Show the sync history for knowledge base {id}.

List {limit} sync runs across all sources of knowledge base {id}.

Qlik Sense Knowledge Bases API

Operations 17

Documentation

Specifications

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification