AutoML dataset predictions

Download specification

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.

Get shapley values in coordinate form

Deprecated

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)
Categories build
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.
Deprecated sunset 2026-02

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    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/csvany

400

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

403

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

404

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

409

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

503

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on
GET /api/v1/automl-predictions/{predictionId}/coordinate-shap 
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/coordinate-shap" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/coordinate-shap',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

Retrieve jobs associated with a prediction

Deprecated

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

Facts

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

Path Parameters

  • predictionIdstring
    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/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

403

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

404

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

409

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

503

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on
POST /api/v1/automl-predictions/{predictionId}/jobs 
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/jobs" \
-X POST \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/jobs',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

Get any rows where a prediction was not produced

Deprecated

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)
Categories build
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.
Deprecated sunset 2026-02

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    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/csvany

400

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

403

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

404

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

409

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

503

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on
GET /api/v1/automl-predictions/{predictionId}/not-predicted-reasons 
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/not-predicted-reasons" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/not-predicted-reasons',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

Get a file containing predicted values

Deprecated

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

Facts

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

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    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/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

403

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

404

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

409

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

503

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on
GET /api/v1/automl-predictions/{predictionId}/predictions 
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/predictions" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/predictions',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

Return a file containing shapley values

Deprecated

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

Facts

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

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    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/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

403

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

404

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

409

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

503

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on
GET /api/v1/automl-predictions/{predictionId}/shap 
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/shap" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/shap',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

Return a file containing source values

Deprecated

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)
Categories build
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.
Deprecated sunset 2026-02

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    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/csvany

400

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

403

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

404

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

409

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

503

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on
GET /api/v1/automl-predictions/{predictionId}/source 
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/source" \
-H "Authorization: Bearer <access_token>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/source',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)