AutoML dataset predictions

Use your ML deployment to generate batch data in file format to predict future outcomes on new data.

Deprecation notice

This API is deprecated and will be removed on or after February 3, 2026. The complete end-to-end machine learning capability is now available in the Machine Learning API.

Endpoints

GET

/api/v1/automl-predictions/{predictionId}/coordinate-shap
POST

/api/v1/automl-predictions/{predictionId}/jobs
GET

/api/v1/automl-predictions/{predictionId}/not-predicted-reasons
GET

/api/v1/automl-predictions/{predictionId}/predictions
GET

/api/v1/automl-predictions/{predictionId}/shap
GET

/api/v1/automl-predictions/{predictionId}/source

Returns a file containing the shapley values in coordinate form that are associated with a prediction ID.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-02

Query Parameters

refId string

Path Parameters

predictionId string

Required

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

format = "uuid"

Responses

200

Stream of coordinate shap values returned successfully.

text/csv any

400

Received a bad argument

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

403

Access forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

404

Resource not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

409

Resource conflict

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

503

Resource unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

GET /api/v1/automl-predictions/{predictionId}/coordinate-shap

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automlPredictions.getAutomlPredictionCoordinateShap(
  'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/automl-predictions/{predictionId}/coordinate-shap yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automl-predictions/{predictionId}/coordinate-shap" \
-H "Authorization: Bearer <access_token>"

Retrieve jobs that are associated with a prediction. Job with correlation type prediction.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-02

Path Parameters

predictionId string

Required

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

format = "uuid"

Responses

200

OK Response

400

Received a bad argument

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

403

Access forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

404

Resource not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

409

Resource conflict

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

503

Resource unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

POST /api/v1/automl-predictions/{predictionId}/jobs

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automlPredictions.createAutomlPredictionJob(
  'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
)

# qlik-cli has not implemented support for POST /api/v1/automl-predictions/{predictionId}/jobs yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automl-predictions/{predictionId}/jobs" \
-X POST \
-H "Authorization: Bearer <access_token>"

Returns a file containing any rows in a prediction operation where a prediction was unable to be produced.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-02

Query Parameters

refId string

Path Parameters

predictionId string

Required

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

format = "uuid"

Responses

200

Stream of not predicted reasons returned successfully.

text/csv any

400

Received a bad argument

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

403

Access forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

404

Resource not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

409

Resource conflict

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

503

Resource unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

GET /api/v1/automl-predictions/{predictionId}/not-predicted-reasons

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automlPredictions.getAutomlPredictionNotPredictedReasons(
  'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/automl-predictions/{predictionId}/not-predicted-reasons yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automl-predictions/{predictionId}/not-predicted-reasons" \
-H "Authorization: Bearer <access_token>"

Returns a file containing the predicted values that are associated with a prediction ID.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-02

Query Parameters

refId string

Path Parameters

predictionId string

Required

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

format = "uuid"

Responses

200

Prediction stream returned succesfully.

400

Received a bad argument

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

403

Access forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

404

Resource not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

409

Resource conflict

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

503

Resource unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

GET /api/v1/automl-predictions/{predictionId}/predictions

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automlPredictions.getAutomlPredictionPredictions(
  'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/automl-predictions/{predictionId}/predictions yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automl-predictions/{predictionId}/predictions" \
-H "Authorization: Bearer <access_token>"

Returns a file containing the shapley values that are associated with a prediction ID.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-02

Query Parameters

refId string

Path Parameters

predictionId string

Required

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

format = "uuid"

Responses

200

Stream of shap values returned successfully.

400

Received a bad argument

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

403

Access forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

404

Resource not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

409

Resource conflict

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

503

Resource unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

GET /api/v1/automl-predictions/{predictionId}/shap

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automlPredictions.getAutomlPredictionShap(
  'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/automl-predictions/{predictionId}/shap yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automl-predictions/{predictionId}/shap" \
-H "Authorization: Bearer <access_token>"

Returns a file containing the source values and an index field that are associated with a prediction ID.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-02

Query Parameters

refId string

Path Parameters

predictionId string

Required

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

format = "uuid"

Responses

200

Stream of source values and index field returned successfully.

text/csv any

400

Received a bad argument

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

403

Access forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

404

Resource not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

409

Resource conflict

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

503

Resource unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  meta object
  
  Show meta properties
  
  details string
  
  Extra details for what may have caused the error
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on
  
  issue string
  
  The issue code
  
  title string
  
  A summary of what went wrong
  
  errorId string
  
  The unique id of the error instance
  
  argument string
  
  The argument
  
  resource string
  
  The resource type that the error occurred on
  
  resourceId string
  
  The resource id that the error occurred on

GET /api/v1/automl-predictions/{predictionId}/source

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automlPredictions.getAutomlPredictionSource(
  'c35f4b70-3ce4-4a30-b62b-2aef16943bc4',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/automl-predictions/{predictionId}/source yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automl-predictions/{predictionId}/source" \
-H "Authorization: Bearer <access_token>"

AutoML dataset predictions

Endpoints

Get shapley values in coordinate form

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

503

Retrieve jobs associated with a prediction

Facts

Path Parameters

Responses

200

400

401

403

404

409

503

Get any rows where a prediction was not produced

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

503

Get a file containing predicted values

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

503

Return a file containing shapley values

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

503

Return a file containing source values

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

409

503