{
  "info": {
    "title": "automl-predictions",
    "version": ""
  },
  "paths": {
    "/api/v1/automl-predictions/{predictionId}/coordinate-shap": {
      "get": {
        "tags": [
          "automl-predictions"
        ],
        "summary": "Get shapley values in coordinate form",
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {}
              }
            },
            "description": "Stream of coordinate shap values returned successfully."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Received a bad argument"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Access forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource not found."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource conflict"
          },
          "503": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource unavailable"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/refId"
          },
          {
            "$ref": "#/components/parameters/predictionId"
          }
        ],
        "description": "Returns a file containing the shapley values in coordinate form that are associated with a prediction ID.",
        "operationId": "getCoordinateShapForPrediction",
        "x-qlik-deprecated": true,
        "x-qlik-deprecated-sunset": "2026-02",
        "x-qlik-deprecated-version": "2025-08",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    },
    "/api/v1/automl-predictions/{predictionId}/jobs": {
      "post": {
        "tags": [
          "automl-predictions"
        ],
        "summary": "Retrieve jobs associated with a prediction",
        "responses": {
          "200": {
            "content": {
              "application/json": {}
            },
            "description": "OK Response"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Received a bad argument"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Access forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource not found."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource conflict"
          },
          "503": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource unavailable"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/predictionId"
          }
        ],
        "description": "Retrieve jobs that are associated with a prediction. Job with correlation type `prediction`.",
        "operationId": "getPredictionJobs",
        "x-qlik-deprecated": true,
        "x-qlik-deprecated-sunset": "2026-02",
        "x-qlik-deprecated-version": "2025-08",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-tier": {
          "tier": "2",
          "limit": 100
        }
      }
    },
    "/api/v1/automl-predictions/{predictionId}/not-predicted-reasons": {
      "get": {
        "tags": [
          "automl-predictions"
        ],
        "summary": "Get any rows where a prediction was not produced",
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {}
              }
            },
            "description": "Stream of not predicted reasons returned successfully."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Received a bad argument"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Access forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource not found."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource conflict"
          },
          "503": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource unavailable"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/refId"
          },
          {
            "$ref": "#/components/parameters/predictionId"
          }
        ],
        "description": "Returns a file containing any rows in a prediction operation where a prediction was unable to be produced.",
        "operationId": "getErrorsForPrediction",
        "x-qlik-deprecated": true,
        "x-qlik-deprecated-sunset": "2026-02",
        "x-qlik-deprecated-version": "2025-08",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    },
    "/api/v1/automl-predictions/{predictionId}/predictions": {
      "get": {
        "tags": [
          "automl-predictions"
        ],
        "summary": "Get a file containing predicted values",
        "responses": {
          "200": {
            "content": {
              "text/csv": {}
            },
            "description": "Prediction stream returned succesfully."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Received a bad argument"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Access forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource not found."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource conflict"
          },
          "503": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource unavailable"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/refId"
          },
          {
            "$ref": "#/components/parameters/predictionId"
          }
        ],
        "description": "Returns a file containing the predicted values that are associated with a prediction ID.",
        "operationId": "getConfigurationsForPrediction",
        "x-qlik-deprecated": true,
        "x-qlik-deprecated-sunset": "2026-02",
        "x-qlik-deprecated-version": "2025-08",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    },
    "/api/v1/automl-predictions/{predictionId}/shap": {
      "get": {
        "tags": [
          "automl-predictions"
        ],
        "summary": "Return a file containing shapley values",
        "responses": {
          "200": {
            "content": {
              "text/csv": {}
            },
            "description": "Stream of shap values returned successfully."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Received a bad argument"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Access forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource not found."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource conflict"
          },
          "503": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource unavailable"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/refId"
          },
          {
            "$ref": "#/components/parameters/predictionId"
          }
        ],
        "description": "Returns a file containing the shapley values that are associated with a prediction ID.",
        "operationId": "getShapForPrediction",
        "x-qlik-deprecated": true,
        "x-qlik-deprecated-sunset": "2026-02",
        "x-qlik-deprecated-version": "2025-08",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    },
    "/api/v1/automl-predictions/{predictionId}/source": {
      "get": {
        "tags": [
          "automl-predictions"
        ],
        "summary": "Return a file containing source values",
        "responses": {
          "200": {
            "content": {
              "text/csv": {
                "schema": {}
              }
            },
            "description": "Stream of source values and index field returned successfully."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Received a bad argument"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Access forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource not found."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource conflict"
          },
          "503": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/appErrorResponse"
                }
              }
            },
            "description": "Resource unavailable"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/refId"
          },
          {
            "$ref": "#/components/parameters/predictionId"
          }
        ],
        "description": "Returns a file containing the source values and an index field that are associated with a prediction ID.",
        "operationId": "getSourceForPrediction",
        "x-qlik-deprecated": true,
        "x-qlik-deprecated-sunset": "2026-02",
        "x-qlik-deprecated-version": "2025-08",
        "x-qlik-visibility": "public",
        "x-qlik-stability": "stable",
        "x-qlik-tier": {
          "tier": "1",
          "limit": 1000
        }
      }
    }
  },
  "openapi": "3.0.0",
  "components": {
    "parameters": {
      "predictionId": {
        "in": "path",
        "name": "predictionId",
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "required": true,
        "description": "The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced."
      },
      "refId": {
        "in": "query",
        "name": "refId",
        "schema": {
          "type": "string"
        },
        "description": ""
      }
    },
    "schemas": {
      "appErrorResponse": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "error": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "The unique code for the error"
          },
          "meta": {
            "type": "object",
            "properties": {
              "details": {
                "type": "string",
                "description": "Extra details for what may have caused the error"
              },
              "errorId": {
                "type": "string",
                "description": "The unique id of the error instance"
              },
              "argument": {
                "type": "string",
                "description": "The argument"
              },
              "resource": {
                "type": "string",
                "description": "The resource type that the error occurred on"
              },
              "resourceId": {
                "type": "string",
                "description": "The resource id that the error occurred on"
              }
            }
          },
          "issue": {
            "type": "string",
            "description": "The issue code"
          },
          "title": {
            "type": "string",
            "description": "A summary of what went wrong"
          },
          "errorId": {
            "type": "string",
            "description": "The unique id of the error instance"
          },
          "argument": {
            "type": "string",
            "description": "The argument"
          },
          "resource": {
            "type": "string",
            "description": "The resource type that the error occurred on"
          },
          "resourceId": {
            "type": "string",
            "description": "The resource id that the error occurred on"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://{tenant}.{region}.qlikcloud.com",
      "variables": {
        "region": {
          "default": "us",
          "description": "The region the tenant is hosted in"
        },
        "tenant": {
          "default": "your-tenant",
          "description": "Name of the tenant that will be called"
        }
      }
    }
  ]
}