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 Predictions API

The predictions API from Qlik Sense — 6 operation(s) for predictions.

Qlik Sense Predictions 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 Predictions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 12 operations across 6 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0.

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

12 operations 6 paths 47 schemas 2 DELETE3 GET2 PATCH4 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 12

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

Predictions 12
POST
/api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run
Generate predictions in a synchronous request/response
predictRealtimeWithAlias 6 params body → 200400401403404409503default
GET
/api/v1/ml/deployments/{deploymentId}/batch-predictions
List batch prediction configurations
getBatchPredictions 5 params → 200400401403404500502503
POST
/api/v1/ml/deployments/{deploymentId}/batch-predictions
Create a prediction configuration
postBatchPrediction 1 param body → 201400401403404500502503
GET
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
Retrieve a batch prediction
getBatchPrediction 2 params → 200400401403404500502503
PATCH
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
Updates a batch prediction
patchBatchPrediction 2 params body → 204400401403404500502503
DELETE
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
Delete a batch prediction
deleteBatchPrediction 2 params → 204400401403404500502503
POST
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict
Run a batch prediction
predictBatchPrediction 2 params → 202400401403404500502503
GET
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
Get a batch prediction schedule
getBatchPredictionSchedule 2 params → 200400401403404500502503
PATCH
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
Update a batch prediction schedule
patchBatchPredictionSchedule 2 params body → 204400401403404500502503
PUT
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
Add a batch prediction schedule
putBatchPredictionSchedule 2 params body → 201400401403404500502503
DELETE
/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
Delete a batch prediction schedule
deleteBatchPredictionSchedule 2 params → 204400401403404500502503
POST
/api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run
Generate predictions in a synchronous request/response
predictRealtime 5 params body → 200400401403404409503default

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are PredictionJobResponse (20 properties), BatchPrediction (17 properties), BatchPredictionSchedule (9 properties), BatchPredictionWriteback (7 properties). Each schema is shown below with its type and property counts.

BatchPredictionFindResponse
object
3 properties 2 required
BatchPrediction
object
A batch prediction job configuration
17 properties
DeploymentId
string
ID of a model deployment
RealTimePredictionSchema
object
1 property
RealtimePredictionInput
object
Input values for creating realtime predictions
2 properties
OutputFile
object
5 properties 5 required
ErrorMessage
string
JSON string of error object
ParentJobId
string
ID of the current job's parent
FindResponseMeta
object
Meta for FIND operations
1 property 1 required
Failure
object
2 properties 1 required
IndexColumn
string
A optional column name upon which to create an index. Must be unique for every row. If not included, Qlik will create a unique index column.
PredictionJobResponse
object
20 properties 20 required
JobType
string
The type for this job
BatchPredictionSchedulePatch
array
BatchPredictionPostResponse
object
1 property 1 required
BatchPredictionScheduleInput
object
Input values for a batch prediction schedule
1 property
BatchPredictionGetResponse
object
1 property 1 required
APIError
object
An error object
4 properties 2 required
AliasId
string
ID of an alias
ModelId
string
ID of the model
BatchPredictionScheduleInputAttributes
object
Configuration to schedule a batch prediction
5 properties 4 required
FileType
string
Dataset file type
DataSetId
string
The Qlik catalog dataset ID
EntityId
string
ID of this entity
Errors
array
JSON string with list of error objects
CorrType
string
Types names of correlated resources (batch 'prediction' and experimentversion)
BatchPredictionScheduleGetResponse
object
1 property 1 required
BatchPredictionActionResponse
object
Response for batch prediction predict action that indicates job and status
1 property 1 required
RealtimePrediction
object
Input values for creating realtime predictions
1 property
SpaceId
string
Space ID for this entity (empty string for personal space)
EnumSortBatchPredictions
string
TenantId
string
Tenant ID for this entity
BatchPredictionSchedulePutResponse
object
1 property 1 required
RealTimePredictionInputSchema
object
1 property
ResponseLinks
object
Resource links included in paginated responses
5 properties 5 required
AnyType
Use for fields that can be any type (string, number, etc.)
BatchPredictionPatch
array
BatchPredictionInput
object
Input values for creating a batch prediction configuration
1 property
OwnerId
string
ID of owner/user for this entity
CorrId
string
The ID of a correlated resource of corrType
BatchPredictionWriteback
object
Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog. Note that for predictions based on time…
7 properties 3 required
DeletedAt
string
Timestamp when this is deleted
BatchPredictionStatus
string
Status of this batch prediction
EntityName
string
Name of this entity
CreatedAt
string
Timestamp when this was created
BatchPredictionSchedule
object
Batch prediction job schedule
9 properties
UpdatedAt
string
Timestamp when this was updated

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-predictions-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 Predictions 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.