AAW REST API

API is alive accessible

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "message": "Welcome to Kinetica Active Analytics Workbench"
  },
  "success": "true"
}

bad input parameter

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/admin/cluster/deployment/{model_deployment_id}/info

Retrieve Kubernetes cluster state and details for a particular model deployment

Retrieve Kubernetes cluster state and details for a particular model deployment

Parameters

model_deployment_id (integer) – The model deployment entity id

Example request:

GET /kml/admin/cluster/deployment/{model_deployment_id}/info HTTP/1.1
Host: example.com

Status Codes

Report generated and returned

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/admin/cluster/deployment/{model_deployment_id}/logs

Retrieve Kubernetes cluster logs for a particular model deployment

Retrieve Kubernetes cluster logs for a particular model deployment

Parameters

model_deployment_id (integer) – The model deployment entity id

Example request:

GET /kml/admin/cluster/deployment/{model_deployment_id}/logs HTTP/1.1
Host: example.com

Status Codes

Report generated and returned

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "deployment": "kml-mgr-00049",
    "deployment-type": "BLACKBOX",
    "replicas": [
      {
        "replica": "kml-mgr-00049",
        "replica-log": [
          "string"
        ]
      }
    ]
  },
  "success": "true"
}

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/admin/cluster/deployments

List of currently active Kubernetes jobs and deployments, with underlying pods

List of currently active Kubernetes jobs and deployments, with underlying pods

Example request:

GET /kml/admin/cluster/deployments HTTP/1.1
Host: example.com

Status Codes

Report generated and returned

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "deployments": [
      "kml-mgr-00049"
    ]
  },
  "success": "true"
}

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/admin/cluster/familytree

Hierarcal summary of kubernetes jobs and deployments, with underlying pods

Hierarcal summary of kubernetes jobs and deployments, with underlying pods

Example request:

GET /kml/admin/cluster/familytree HTTP/1.1
Host: example.com

Status Codes

Report generated and returned

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "deployments": [
      {
        "deployment": "kml-mgr-00049",
        "replicas": [
          "kml-inp-00008-5c84d95977-jprmh"
        ]
      }
    ]
  },
  "success": "true"
}

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/admin/cluster/prepull

pre-pull container image

Allows pre-pulling container into Kubernetes as a DaemonSet and keeping a hot image per node to speed up deployment times

Example request:

POST /kml/admin/cluster/prepull HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "container_ref": "string"
 }

Status Codes

500 Internal Server Error

model deployed

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "name": "string"
  },
  "success": "true"
}

system error

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/admin/defaults/podresources

System-level pod resource limits

Obtain system-level pod resource limits

Example request:

GET /kml/admin/defaults/podresources HTTP/1.1
Host: example.com

Status Codes

500 Internal Server Error

Pod resource limits

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "cpu_max": 2000,
    "cpu_min": 500,
    "cpu_units": "millicore (m)",
    "gpu_max": 8,
    "gpu_min": 1,
    "gpu_units": "GPGPU",
    "mem_max": 2048,
    "mem_min": 512,
    "mem_units": "mebibyte (Mi)"
  },
  "success": "true"
}

system error

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/audit/deployment/{model_deployment_id}/inference/{guid}'

Return node graph data for a given model inference

List searchable input and output fields for specified model, for use with system auditing

Parameters

model_deployment_id (integer) – The model deployment entity id
guid (string) – UUID of a system inference

Example request:

GET /kml/audit/deployment/{model_deployment_id}/inference/{guid}' HTTP/1.1
Host: example.com

Status Codes

inference details

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "guid": "5e2350f6-1d7e-4183-9e3c-ea8878db6c5a",
    "model_deployment_id": 187,
    "node_map": [
      {
        "node_children": [
          1
        ],
        "node_details": {},
        "node_id": 1,
        "node_type": "inference"
      }
    ]
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/audit/model/{model_instance_id}/deployments

Return deployments with matching search criteria

Return deployments with matching search criteria, for use with system auditing

Parameters

model_instance_id (integer) – The model instance entity id

Example request:

POST /kml/audit/model/{model_instance_id}/deployments HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "audit_config": {
     "dates": {
       "end": "2020-10-28 12:22:10",
       "start": "2020-05-26 12:22:10"
     },
     "fields": [
       {
         "field": "string",
         "operator": "=",
         "value": "string"
       }
     ]
   }
 }

Status Codes

list of matching deployments

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "audit_id": 187,
    "deployment_matches": [
      {
        "deployment_desc": "string",
        "deployment_id": 1,
        "deployment_name": "string",
        "deployment_type": "CONTINUOUS",
        "inference_matches": 1,
        "total_inferences": 1
      }
    ],
    "model_instance_id": 187
  },
  "success": "true"
}

invalid input, object invalid

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

an existing item already exists

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/audit/model/{model_instance_id}/fields

List searchable input and output fields for specified model

List searchable input and output fields for specified model

Parameters

model_instance_id (integer) – The model instance entity id

Example request:

GET /kml/audit/model/{model_instance_id}/fields HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "auditable_fields": [
      {
        "field": "column_x",
        "ops": [
          "\u003e="
        ]
      }
    ],
    "model_instance_id": 187
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/audit/{audit_id}/deployment/{model_deployment_id}/inferences

Retrieve inference data for a selected model and stored search criteria

Retrieve inference data for a selected model stored search criteria, for use with system auditing

Parameters

audit_id (integer) – The audit entity id
model_deployment_id (integer) – The model deployment entity id
offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination

Example request:

GET /kml/audit/{audit_id}/deployment/{model_deployment_id}/inferences HTTP/1.1
Host: example.com

Status Codes

list of matching inferences

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "audit_id": 187,
    "inferences": [
      {}
    ],
    "limit": 187,
    "matches_returned": 187,
    "model_deployment_id": 187,
    "offset": 187,
    "total_number_of_records": 187
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/audit/{audit_id}/view

View audit entity details

View audit entity details

Parameters

audit_id (integer) – The audit entity id

Example request:

GET /kml/audit/{audit_id}/view HTTP/1.1
Host: example.com

Status Codes

search entity

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "audit_config": {
        "dates": {},
        "fields": {},
        "search_expression": {}
      },
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/credential/create

Create credential

Create credential

Example request:

POST /kml/credential/create HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "credential_config": {},
   "credential_desc": "description metadata for credential",
   "credential_name": "name metadata for credential",
   "credential_type": "DOCKER"
 }

Status Codes

Credential successfully created

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "credential_config": {},
      "credential_type": "DOCKER",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "k8s_secrets_handle": "string"
    }
  },
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/credential/quicklist

System Inventory of Credential

System Inventory of Credentials

Parameters

offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination
state (string) – return only entities with specified state
archived (string) – include (archived=true) archived or not (archived=false) entities in response results

Example request:

GET /kml/credential/quicklist HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "inventory": [
    {
      "credential_config": {},
      "credential_type": "DOCKER",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "k8s_secrets_handle": "string"
    }
  ],
  "n_records_returned": 1,
  "total_records_available": 1
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/credential/{credential_id}/archive

Archive credential entity

Archive credential entity

Parameters

credential_id (integer) – The credential entity id

Example request:

GET /kml/credential/{credential_id}/archive HTTP/1.1
Host: example.com

Status Codes

Resulting entity description

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "credential_config": {},
      "credential_type": "DOCKER",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "k8s_secrets_handle": "string"
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/credential/{credential_id}/view

View credential entity details

View credential entity details. This will show descriptive metadata, status, timestamps, and configurations. Secrets will not be visible.

Parameters

credential_id (integer) – The credential entity id

Example request:

GET /kml/credential/{credential_id}/view HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "credential_config": {},
      "credential_type": "DOCKER",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "k8s_secrets_handle": "string"
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/dataset/create

Create dataset

Create dataset

Example request:

POST /kml/dataset/create HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "dataset_desc": "my docker private registry on DockerHub",
   "dataset_name": "my docker private registry",
   "source_config": {
     "cols": [
       "string"
     ],
     "filterex": "genre=='rap'",
     "tbl": "artists"
   }
 }

Status Codes

Dataset successfully created

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "source_config": {
        "cols": [
          "string"
        ],
        "filterex": "genre=='rap'",
        "tbl": "artists"
      }
    }
  },
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/dataset/quicklist

System Inventory of Dataset Entities

System Inventory of Dataset Entities

Parameters

offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination
state (string) – return only entities with specified state
archived (string) – include (archived=true) archived or not (archived=false) entities in response results

Example request:

GET /kml/dataset/quicklist HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "inventory": [
    {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "source_config": {
        "cols": [
          "string"
        ],
        "filterex": "genre=='rap'",
        "tbl": "artists"
      }
    }
  ],
  "n_records_returned": 1,
  "total_records_available": 1
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/dataset/testtrainsplit

Create dataset

Split dataset into test and train subsets

Example request:

POST /kml/dataset/testtrainsplit HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "pct_test": 40,
   "pct_train": 40,
   "src_tbl": "diabetes_dataset_complete"
 }

Status Codes

Dataset successfully created

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "created": {}
}

422 Unprocessable Entity

setup error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/dataset/{dataset_id}/archive

Archive dataset entity

Archive dataset entity

Parameters

dataset_id (integer) – The dataset entity id

Example request:

GET /kml/dataset/{dataset_id}/archive HTTP/1.1
Host: example.com

Status Codes

Resulting entity description

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "source_config": {
        "cols": [
          "string"
        ],
        "filterex": "genre=='rap'",
        "tbl": "artists"
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/dataset/{dataset_id}/clone

Clone dataset entity details

Clone dataset entity details

Parameters

dataset_id (integer) – The dataset entity id

Example request:

GET /kml/dataset/{dataset_id}/clone HTTP/1.1
Host: example.com

Status Codes

Dataset cloned successfully into separate and distinct new entity

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "source_config": {
        "cols": [
          "string"
        ],
        "filterex": "genre=='rap'",
        "tbl": "artists"
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/dataset/{dataset_id}/grab

Grab all data from dataset

Grab all data from dataset, JSONified. Meant for small datasets

Parameters

dataset_id (integer) – The dataset entity id

Example request:

GET /kml/dataset/{dataset_id}/grab HTTP/1.1
Host: example.com

Status Codes

JSONified dataset

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

file with specified ID not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/dataset/{dataset_id}/preview

Preview dataset

Preview dataset

Parameters

dataset_id (integer) – The dataset entity id

Status Codes

Dataset preview succeeded

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

422 Unprocessable Entity

Dataset preview error

Example response:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/dataset/{dataset_id}/view

View dataset entity details

View dataset entity details

Parameters

dataset_id (integer) – The dataset entity id

Example request:

GET /kml/dataset/{dataset_id}/view HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "source_config": {
        "cols": [
          "string"
        ],
        "filterex": "genre=='rap'",
        "tbl": "artists"
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/featureset/create

Create featureset

Create featureset

Example request:

POST /kml/featureset/create HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "config_inline": {
     "dataset_id_fitting": 1,
     "xforms": [
       {
         "feat_type": "onehot",
         "in_col_name": "string",
         "out_col_name": "string"
       }
     ]
   },
   "config_relational": {
     "mv_name": "holdings_realtime_px",
     "mv_timestamp_col": "px_last_tick_time"
   },
   "featureset_desc": "NYSE Level II Quote Stream",
   "featureset_name": "NYSE Real Time"
 }

Status Codes

Successfully created featureset

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "config_inline": {
        "dataset_id_fitting": 1,
        "xforms": [
          {
            "feat_type": "onehot",
            "in_col_name": "string",
            "out_col_name": "string"
          }
        ]
      },
      "config_relational": {
        "mv_name": "holdings_realtime_px",
        "mv_timestamp_col": "px_last_tick_time"
      },
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      }
    }
  },
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/featureset/import

Import Featureset

Import Featureset

Example request:

POST /kml/featureset/import HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "feat_mem": {
     "processing_time": 0.00187,
     "response": {
       "created": {
         "config_inline": {
           "dataset_id_fitting": 1,
           "xforms": [
             {
               "feat_type": "onehot",
               "in_col_name": "string",
               "out_col_name": "string"
             }
           ]
         },
         "config_relational": {
           "mv_name": "holdings_realtime_px",
           "mv_timestamp_col": "px_last_tick_time"
         },
         "entity": {
           "create_dt": "1979-09-29T22:00:33.001Z",
           "doc_state": "DRAFT",
           "entity_desc": "black scholes merton pricing and risk model for american options",
           "entity_id": 36,
           "entity_name": "black scholes merton pricing model",
           "entity_state": "PENDING",
           "entity_type": "MODEL_INSTANCE",
           "update_dt": "2008-09-17T03:11:33.001Z",
           "visibility": "VISIBLE"
         }
       }
     },
     "success": "true"
   },
   "featureset_desc": "string",
   "featureset_name": "string"
 }

Status Codes

Featureset apply response

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "created": {
    "config_inline": {
      "dataset_id_fitting": 1,
      "xforms": [
        {
          "feat_type": "onehot",
          "in_col_name": "string",
          "out_col_name": "string"
        }
      ]
    },
    "config_relational": {
      "mv_name": "holdings_realtime_px",
      "mv_timestamp_col": "px_last_tick_time"
    },
    "entity": {
      "create_dt": "1979-09-29T22:00:33.001Z",
      "doc_state": "DRAFT",
      "entity_desc": "black scholes merton pricing and risk model for american options",
      "entity_id": 36,
      "entity_name": "black scholes merton pricing model",
      "entity_state": "PENDING",
      "entity_type": "MODEL_INSTANCE",
      "update_dt": "2008-09-17T03:11:33.001Z",
      "visibility": "VISIBLE"
    }
  }
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/featureset/quicklist

System Inventory of FeatureSet Entities

System Inventory of FeatureSet Entities

Parameters

offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination
state (string) – return only entities with specified state
archived (string) – include (archived=true) archived or not (archived=false) entities in response results

Example request:

GET /kml/featureset/quicklist HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "inventory": [
    {
      "config_inline": {
        "dataset_id_fitting": 1,
        "xforms": [
          {
            "feat_type": "onehot",
            "in_col_name": "string",
            "out_col_name": "string"
          }
        ]
      },
      "config_relational": {
        "mv_name": "holdings_realtime_px",
        "mv_timestamp_col": "px_last_tick_time"
      },
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      }
    }
  ],
  "n_records_returned": 1,
  "total_records_available": 1
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/featureset/{featureset_id}/apply

Apply Featureset

Apply Featureset

Parameters

featureset_id (integer) – Entity ID of featureset to be applied

Example request:

POST /kml/featureset/{featureset_id}/apply HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "sink_table": "string",
   "source_table": "string"
 }

Status Codes

Featureset dump

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "featureset_applied": 1,
  "recreate_sink_table": "true",
  "sink_table": "string",
  "source_table": "string"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/featureset/{featureset_id}/archive

Archive featureset entity

Archive featureset entity

Parameters

featureset_id (integer) – The featureset entity id

Example request:

GET /kml/featureset/{featureset_id}/archive HTTP/1.1
Host: example.com

Status Codes

Resulting entity description

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "config_inline": {
        "dataset_id_fitting": 1,
        "xforms": [
          {
            "feat_type": "onehot",
            "in_col_name": "string",
            "out_col_name": "string"
          }
        ]
      },
      "config_relational": {
        "mv_name": "holdings_realtime_px",
        "mv_timestamp_col": "px_last_tick_time"
      },
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/featureset/{featureset_id}/clone

Clone featureset entity details

Clone featureset entity details

Parameters

featureset_id (integer) – The featureset entity id

Example request:

GET /kml/featureset/{featureset_id}/clone HTTP/1.1
Host: example.com

Status Codes

Featureset cloned successfully into separate and distinct new entity

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "config_inline": {
        "dataset_id_fitting": 1,
        "xforms": [
          {
            "feat_type": "onehot",
            "in_col_name": "string",
            "out_col_name": "string"
          }
        ]
      },
      "config_relational": {
        "mv_name": "holdings_realtime_px",
        "mv_timestamp_col": "px_last_tick_time"
      },
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      }
    }
  },
  "success": "true"
}

Featureset being cloned was not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/featureset/{featureset_id}/export

Export

Export featureset entity details

Parameters

featureset_id (integer) – The featureset entity id

Example request:

GET /kml/featureset/{featureset_id}/export HTTP/1.1
Host: example.com

Status Codes

Featureset dump

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/featureset/{featureset_id}/view

View featureset entity details

View featureset entity details

Parameters

featureset_id (integer) – The featureset entity id

Example request:

GET /kml/featureset/{featureset_id}/view HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "config_inline": {
        "dataset_id_fitting": 1,
        "xforms": [
          {
            "feat_type": "onehot",
            "in_col_name": "string",
            "out_col_name": "string"
          }
        ]
      },
      "config_relational": {
        "mv_name": "holdings_realtime_px",
        "mv_timestamp_col": "px_last_tick_time"
      },
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/ingest/create

Create ingest

Create ingest

Example request:

POST /kml/ingest/create HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "ingest_config": {},
   "ingest_desc": "NYSE Level II Quote Stream",
   "ingest_mode": "CONTINUOUS",
   "ingest_name": "NYSE Real Time",
   "ingest_type": "BYOC"
 }

Status Codes

Ingest successfully created

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "file_id": 1,
      "ingest_config": {},
      "ingest_mode": "CONTINUOUS",
      "ingest_type": "BYOC"
    }
  },
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/ingest/quicklist

System Inventory of Ingests

System Inventory of Ingests

Parameters

offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination
state (string) – return only entities with specified state
archived (string) – include (archived=true) archived or not (archived=false) entities in response results

Example request:

GET /kml/ingest/quicklist HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "inventory": [
    {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "file_id": 1,
      "ingest_config": {},
      "ingest_mode": "CONTINUOUS",
      "ingest_type": "BYOC"
    }
  ],
  "n_records_returned": 1,
  "total_records_available": 1
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/ingest/status

list of all ingest activities and their high level status

list of all ingest activities and their high level status

Example request:

GET /kml/ingest/status HTTP/1.1
Host: example.com

Status Codes

200 OK
Show all active containerized ingests on the system and their respective execution status

Example response:
```
HTTP/1.1 200 OK
Content-Type: application/json
```
```
{}
```

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/ingest/{ingest_id}/archive

Archive ingest entity details

Archive ingest entity details. This will show descriptive metadata, status, timestamps, and configurations

Parameters

ingest_id (integer) – The ingest entity id

Example request:

GET /kml/ingest/{ingest_id}/archive HTTP/1.1
Host: example.com

Status Codes

Resulting entity description

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "file_id": 1,
      "ingest_config": {},
      "ingest_mode": "CONTINUOUS",
      "ingest_type": "BYOC"
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/ingest/{ingest_id}/clone

Clone ingest entity details

Clone ingest entity details

Parameters

ingest_id (integer) – The ingest entity id

Example request:

GET /kml/ingest/{ingest_id}/clone HTTP/1.1
Host: example.com

Status Codes

Ingest cloned successfully into separate and distinct new entity

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "file_id": 1,
      "ingest_config": {},
      "ingest_mode": "CONTINUOUS",
      "ingest_type": "BYOC"
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/ingest/{ingest_id}/start

starts ingest

Deploy a containerized ingest onto the Kubernetes cluster.

Parameters

ingest_id (integer) – The ingest entity id

Status Codes

ingest started successfully

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "entity_id": 42,
    "job": "kml-ing-00036-asdfa",
    "target_table": "stock_ticks_inbound"
  },
  "success": "true"
}

item not found, cannot starts

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

error starts

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/ingest/{ingest_id}/terminate

terminates ingest

terminates ingest

Parameters

ingest_id (integer) – The ingest entity id

Status Codes

ingest terminated

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "terminated": "kml-00036-asdf234"
  },
  "success": "true"
}

item not found, cannot terminate

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

409 Conflict

error terminating

Example response:

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/ingest/{ingest_id}/view

View ingest entity details

View ingest entity details

Parameters

ingest_id (integer) – The ingest entity id

Example request:

GET /kml/ingest/{ingest_id}/view HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "file_id": 1,
      "ingest_config": {},
      "ingest_mode": "CONTINUOUS",
      "ingest_type": "BYOC"
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/introspect

Introspect container for importable models and obtain specifications for auto-creation on the system (allows model publishers to do it once and users to use it for free)

Introspect container for importable models.

Example request:

POST /kml/introspect HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "container_ref": "artificalintelligence.azurecr.io/kinetica/kinetica-blackbox-sdk:r7.1.3",
   "credential_id": 42
 }

Status Codes

200 OK
search results matching criteria

Example response:
```
HTTP/1.1 200 OK
Content-Type: application/json
```
```
{}
```

bad input parameter

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/jupyter/start

Start RAPIDSLab Jupyter Environment

Start RAPIDSLab Jupyter Environment

Example request:

POST /kml/jupyter/start HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "override": "true"
 }

Status Codes

RAPIDSLAB environment created

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{}

GET /kml/jupyter/status

RAPIDSLab Jupyter environment summary

RAPIDSLab Jupyter environment summary

Example request:

GET /kml/jupyter/status HTTP/1.1
Host: example.com

Status Codes

RAPIDSLab status

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{}

GET /kml/jupyter/stop

Stop RAPIDSLab Jupyter environment and persist user workspace

Stop RAPIDSLab Jupyter environment and persist user workspace

Example request:

GET /kml/jupyter/stop HTTP/1.1
Host: example.com

Status Codes

200 OK
RAPIDSLab Jupyter environment torn down and user workspace persisted successfully

Example response:
```
HTTP/1.1 200 OK
Content-Type: application/json
```
```
{}
```

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{}

GET /kml/model/deployment/quicklist

System Inventory of Model Deployments

System Inventory of Model Deployments

Parameters

offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination
state (string) – return only entities with specified state
archived (string) – include (archived=true) archived or not (archived=false) entities in response results

Example request:

GET /kml/model/deployment/quicklist HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "inventory": [
    {
      "base_model_inst": {
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        },
        "model_inst_config": {
          "blackbox_function": "string",
          "blackbox_module": "string",
          "container": "string",
          "input_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ],
          "model_type": "BLACKBOX",
          "output_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ]
        }
      },
      "base_model_inst_id": 1,
      "deployment_type": "CONTINUOUS",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "featureset": {
        "config_inline": {
          "dataset_id_fitting": 1,
          "xforms": [
            {
              "feat_type": "onehot",
              "in_col_name": "string",
              "out_col_name": "string"
            }
          ]
        },
        "config_relational": {
          "mv_name": "holdings_realtime_px",
          "mv_timestamp_col": "px_last_tick_time"
        },
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        }
      },
      "featureset_id": 1,
      "model_dep_config": {},
      "resource_config": {
        "replicas": 1
      }
    }
  ],
  "n_records_returned": 1,
  "total_records_available": 1
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/deployment/{model_deployment_id}/archive

Archive Model Deployment entity

Archive Model Deployment entity

Parameters

model_deployment_id (integer) – The model deployment entity id

Example request:

GET /kml/model/deployment/{model_deployment_id}/archive HTTP/1.1
Host: example.com

Status Codes

Resulting entity description

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "base_model_inst": {
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        },
        "model_inst_config": {
          "blackbox_function": "string",
          "blackbox_module": "string",
          "container": "string",
          "input_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ],
          "model_type": "BLACKBOX",
          "output_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ]
        }
      },
      "base_model_inst_id": 1,
      "deployment_type": "CONTINUOUS",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "featureset": {
        "config_inline": {
          "dataset_id_fitting": 1,
          "xforms": [
            {
              "feat_type": "onehot",
              "in_col_name": "string",
              "out_col_name": "string"
            }
          ]
        },
        "config_relational": {
          "mv_name": "holdings_realtime_px",
          "mv_timestamp_col": "px_last_tick_time"
        },
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        }
      },
      "featureset_id": 1,
      "model_dep_config": {},
      "resource_config": {
        "replicas": 1
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/model/deployment/{model_deployment_id}/infer

Perform on-demand inference for provided data

Perform on-demand inference for provided data. The inbound payload must be a list of dictionaries, the output payload will be a list of dictionaries. The inbound dictionary must include all the fields required by the specified model. The output fields will include the inference, metadata, and error details if applicable.

Parameters

model_deployment_id (integer) – The model deployment entity id

Status Codes

Inference success

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/deployment/{model_deployment_id}/start

Start deployment on Kubernetes cluster

Start deployment on Kubernetes cluster. Models can be started (deployed into Kubernetes), stopped (resources recovered), and started again as many times as desired.

Parameters

model_deployment_id (integer) – The model deployment entity id

Example request:

GET /kml/model/deployment/{model_deployment_id}/start HTTP/1.1
Host: example.com

Status Codes

Deployment successfully live on Kubernetes

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

specified model deployment not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/deployment/{model_deployment_id}/stop

Stop deployment on Kubernetes cluster

Stop active deployment on Kubernetes cluster. Models can be started (deployed into Kubernetes), stopped (resources recovered), and started again as many times as desired. For continuous and on-demand deployments, any records received while in STOPPED state will not be inferenced.

Parameters

model_deployment_id (integer) – The model deployment entity id

Example request:

GET /kml/model/deployment/{model_deployment_id}/stop HTTP/1.1
Host: example.com

Status Codes

Deployment successfully terminated and removed from Kubernetes

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "deployment_id": 1,
    "stopped": "string"
  },
  "success": "true"
}

specified model deployment not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

endpoint failed

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/deployment/{model_deployment_id}/view

View Model Deployment entity details

View Model Deployment entity details. This will show descriptive metadata, status, timestamps, and configurations

Parameters

model_deployment_id (integer) – The model deployment entity id

Example request:

GET /kml/model/deployment/{model_deployment_id}/view HTTP/1.1
Host: example.com

Status Codes

Model Deployment entity extract

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "base_model_inst": {
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        },
        "model_inst_config": {
          "blackbox_function": "string",
          "blackbox_module": "string",
          "container": "string",
          "input_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ],
          "model_type": "BLACKBOX",
          "output_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ]
        }
      },
      "base_model_inst_id": 1,
      "deployment_type": "CONTINUOUS",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "featureset": {
        "config_inline": {
          "dataset_id_fitting": 1,
          "xforms": [
            {
              "feat_type": "onehot",
              "in_col_name": "string",
              "out_col_name": "string"
            }
          ]
        },
        "config_relational": {
          "mv_name": "holdings_realtime_px",
          "mv_timestamp_col": "px_last_tick_time"
        },
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        }
      },
      "featureset_id": 1,
      "model_dep_config": {},
      "resource_config": {
        "replicas": 1
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/model/instance/create

Create model instance

Create model instance

Example request:

POST /kml/model/instance/create HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "model_inst_config": {},
   "model_inst_desc": "string",
   "model_inst_name": "string"
 }

Status Codes

Model instance successfully created

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "model_inst_config": {
        "blackbox_function": "string",
        "blackbox_module": "string",
        "container": "string",
        "input_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ],
        "model_type": "BLACKBOX",
        "output_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ]
      }
    }
  },
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/instance/quicklist

System Inventory of Models

System Inventory of Models

Parameters

offset (integer) – number of records to skip, for pagination
limit (integer) – number of records to return, for pagination
state (string) – return only entities with specified state
archived (string) – include (archived=true) archived or not (archived=false) entities in response results

Example request:

GET /kml/model/instance/quicklist HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "inventory": [
    {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "model_inst_config": {
        "blackbox_function": "string",
        "blackbox_module": "string",
        "container": "string",
        "input_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ],
        "model_type": "BLACKBOX",
        "output_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ]
      }
    }
  ],
  "n_records_returned": 1,
  "total_records_available": 1
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/instance/{model_instance_id}/archive

Archive Model Instance entity

Archive Model Instance entity

Parameters

model_instance_id (integer) – The model instance entity id

Example request:

GET /kml/model/instance/{model_instance_id}/archive HTTP/1.1
Host: example.com

Status Codes

Resulting entity description

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "model_inst_config": {
        "blackbox_function": "string",
        "blackbox_module": "string",
        "container": "string",
        "input_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ],
        "model_type": "BLACKBOX",
        "output_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ]
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/instance/{model_instance_id}/clone

Clone Model Instance entity details

Clone Model Instance entity details

Parameters

model_instance_id (integer) – The model instance entity id

Example request:

GET /kml/model/instance/{model_instance_id}/clone HTTP/1.1
Host: example.com

Status Codes

Model Instance cloned successfully into separate and distinct new entity

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "model_inst_config": {
        "blackbox_function": "string",
        "blackbox_module": "string",
        "container": "string",
        "input_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ],
        "model_type": "BLACKBOX",
        "output_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ]
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

POST /kml/model/instance/{model_instance_id}/deploy

deploy a model instance

Prepare and configure a model deployment ready for launch into Kubernetes

Parameters

model_instance_id (integer) – The model instance entity id

Example request:

POST /kml/model/instance/{model_instance_id}/deploy HTTP/1.1
Host: example.com
Content-Type: application/json

{
   "compute_target": "CPU",
   "cpu_compute_limit": 2000,
   "cpu_compute_target_allocation": 500,
   "deployment_desc": "Equity option sensitivity model using closed form Black-Scholes Merton model implemented via QuantLib",
   "deployment_mode": "CONTINUOUS",
   "deployment_name": "Equity option sensitivity model.",
   "gpu_compute_target_allocation": 1,
   "memory_limit": 2048,
   "memory_target_allocation": 256,
   "replicas": 3
 }

Status Codes

500 Internal Server Error

model deployed

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "created": {
      "base_model_inst": {
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        },
        "model_inst_config": {
          "blackbox_function": "string",
          "blackbox_module": "string",
          "container": "string",
          "input_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ],
          "model_type": "BLACKBOX",
          "output_record_type": [
            {
              "col_default_val": "string",
              "col_desc": "string",
              "col_name": "string",
              "col_type": "string"
            }
          ]
        }
      },
      "base_model_inst_id": 1,
      "deployment_type": "CONTINUOUS",
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "featureset": {
        "config_inline": {
          "dataset_id_fitting": 1,
          "xforms": [
            {
              "feat_type": "onehot",
              "in_col_name": "string",
              "out_col_name": "string"
            }
          ]
        },
        "config_relational": {
          "mv_name": "holdings_realtime_px",
          "mv_timestamp_col": "px_last_tick_time"
        },
        "entity": {
          "create_dt": "1979-09-29T22:00:33.001Z",
          "doc_state": "DRAFT",
          "entity_desc": "black scholes merton pricing and risk model for american options",
          "entity_id": 36,
          "entity_name": "black scholes merton pricing model",
          "entity_state": "PENDING",
          "entity_type": "MODEL_INSTANCE",
          "update_dt": "2008-09-17T03:11:33.001Z",
          "visibility": "VISIBLE"
        }
      },
      "featureset_id": 1,
      "model_dep_config": {},
      "resource_config": {
        "replicas": 1
      }
    }
  },
  "success": "true"
}

system error

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/model/instance/{model_instance_id}/view

View Model Instance entity details

View Model Instance entity details. This will show descriptive metadata, status, timestamps, and configurations

Parameters

model_instance_id (integer) – The model instance entity id

Example request:

GET /kml/model/instance/{model_instance_id}/view HTTP/1.1
Host: example.com

Status Codes

Model Instance entity extract

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "found": "true",
    "item": {
      "entity": {
        "create_dt": "1979-09-29T22:00:33.001Z",
        "doc_state": "DRAFT",
        "entity_desc": "black scholes merton pricing and risk model for american options",
        "entity_id": 36,
        "entity_name": "black scholes merton pricing model",
        "entity_state": "PENDING",
        "entity_type": "MODEL_INSTANCE",
        "update_dt": "2008-09-17T03:11:33.001Z",
        "visibility": "VISIBLE"
      },
      "model_inst_config": {
        "blackbox_function": "string",
        "blackbox_module": "string",
        "container": "string",
        "input_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ],
        "model_type": "BLACKBOX",
        "output_record_type": [
          {
            "col_default_val": "string",
            "col_desc": "string",
            "col_name": "string",
            "col_type": "string"
          }
        ]
      }
    }
  },
  "success": "true"
}

LookupError, not found

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

509

system error

Example response:

HTTP/1.1 509 -
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /kml/ping

API aliveness check

Simple endpoint to ping the system and obtain an up-to-date (timestamped) response to ensure interaction is not cached. Also used to obtain system component versions.

Example request:

GET /kml/ping HTTP/1.1
Host: example.com

Status Codes

search results matching criteria

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "timestamp": "string",
    "version": {
      "database": "string",
      "workbench_api": "string",
      "workbench_libs": "string",
      "workbench_ui": "string"
    }
  },
  "success": "true"
}

bad input parameter

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": {
    "code": 1,
    "message": "string"
  },
  "processing_time": 0.00187,
  "response": {},
  "success": "true"
}

GET /latency

database latency test

Probe for database latency checks

Example request:

GET /latency HTTP/1.1
Host: example.com

Status Codes

Latency check succeeded

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "processing_time": 0.00187,
  "response": {
    "n_recs": 1,
    "scaled_metrics": {
      "clear_table": 1,
      "create_table": 1,
      "get_recs_changed": 1,
      "get_recs_column": 1,
      "get_stats": 1,
      "ins_recs": 1,
      "update_recs": 1
    },
    "total_db_ops_seconds": 1
  },
  "success": "true"
}