👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

Model REST API Guide

PreviousProjects REST API Guide NextFile Upload REST API Guide

Last updated 3 months ago

Was this helpful?

List models

Get list of model for provided query and filters

get

/v3/models

Authorizations

Query parameters

latest_onlyboolean

Whether to send only latest version of each model or all version. False by default

project_idstring uuid

project id query parameter

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models' \
  --header 'Authorization: Bearer <token>'

200

400

500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "version": "v1",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "input_type": "text",
        "task": "binary_classification",
        "description": "text",
        "owner": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "deployment_date": "2025-02-06T09:52:03.706Z",
        "artifact_status": "no_model",
        "deleted_at": "2025-02-06T09:52:03.706Z",
        "algorithm": "text",
        "framework": "text",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "hello@example.com"
        },
        "created_at": "2025-02-06T09:52:03.706Z",
        "updated_at": "2025-02-06T09:52:03.706Z"
      }
    ]
  }
}

List of models for provided query and filters

Add a new model under a project

post

/v3/models

Authorizations

Body

namestringrequired

Name of the model

versionstring

Version of the model

project_idstring uuidrequired

UUID format unique identifier for the project the model is added in

input_typeenumrequired

Enumeration of different model input types.

Options: text, structured

taskenumrequired

Enumeration of different types of model tasks.

Options: binary_classification, multiclass_classification, regression, ranking, not_set, llm

schemaobjectrequired

Model schema with the details of each column

specobjectrequired

task_paramsobject

xai_paramsobject

XAI parameters set for a model

descriptionnullable string

Description of the model

owner_by_idnullable string

User ID for the owner of the model

deployment_datenullable string date-time

Date the model was deployed on

algorithmnullable string

Model algorithm

frameworknullable string

A string providing information about the software library and version used to train and run this model

event_id_colnullable string

Event id column to be found in published data for the model

event_ts_colnullable string

Timestamp column to be found in published data for the model

event_ts_formatnullable string

Format of the timestamp like datetime, epoch time etc.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/models' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","version":"v1","project_id":"123e4567-e89b-12d3-a456-426614174000","input_type":"text","task":"binary_classification","schema":{"schema_version":1,"columns":[{"name":"text","data_type":"int","categories":[],"bins":[null],"replace_with_nulls":[]}]},"spec":{"schema_version":1,"inputs":[null],"outputs":[null],"targets":[null],"decisions":[null],"metadata":[null],"custom_features":[{"type":"FROM_COLUMNS","name":"text","columns":[null],"centroids":[null],"tf_idf":[{}]}]},"task_params":{"target_class_order":[],"class_weights":[null]},"xai_params":{"custom_explain_methods":[null]}}'

200

400

401

403

409

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "deployment_date": "2025-02-06T09:52:03.706Z",
    "artifact_status": "no_model",
    "deleted_at": "2025-02-06T09:52:03.706Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "created_at": "2025-02-06T09:52:03.706Z",
    "updated_at": "2025-02-06T09:52:03.706Z",
    "task_params": {
      "binary_classification_threshold": 1,
      "target_class_order": [],
      "group_by": "text",
      "top_k": 1,
      "class_weights": [
        1
      ],
      "weighted_ref_histograms": true
    },
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "text",
          "data_type": "int",
          "min": 1,
          "max": 1,
          "categories": [],
          "bins": [
            1
          ],
          "replace_with_nulls": [],
          "n_dimensions": 1,
          "id": "text"
        }
      ]
    },
    "spec": {
      "schema_version": 1,
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            null
          ],
          "centroids": [
            null
          ],
          "tf_idf": [
            {}
          ]
        }
      ]
    },
    "event_id_col": "text",
    "event_ts_col": "text",
    "event_ts_format": "text",
    "xai_params": {
      "custom_explain_methods": [
        "text"
      ],
      "default_explain_method": "text"
    },
    "artifact_files": [
      {
        "name": "text",
        "size": 1,
        "modified": "2025-02-06T09:52:03.706Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Created model JSON response

Get details of a model

Details of a model for given model id

get

/v3/models/{model_id}

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models/{model_id}' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "deployment_date": "2025-02-06T09:52:03.706Z",
    "artifact_status": "no_model",
    "deleted_at": "2025-02-06T09:52:03.706Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "created_at": "2025-02-06T09:52:03.706Z",
    "updated_at": "2025-02-06T09:52:03.706Z",
    "task_params": {
      "binary_classification_threshold": 1,
      "target_class_order": [],
      "group_by": "text",
      "top_k": 1,
      "class_weights": [
        1
      ],
      "weighted_ref_histograms": true
    },
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "text",
          "data_type": "int",
          "min": 1,
          "max": 1,
          "categories": [],
          "bins": [
            1
          ],
          "replace_with_nulls": [],
          "n_dimensions": 1,
          "id": "text"
        }
      ]
    },
    "spec": {
      "schema_version": 1,
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            null
          ],
          "centroids": [
            null
          ],
          "tf_idf": [
            {}
          ]
        }
      ]
    },
    "event_id_col": "text",
    "event_ts_col": "text",
    "event_ts_format": "text",
    "xai_params": {
      "custom_explain_methods": [
        "text"
      ],
      "default_explain_method": "text"
    },
    "artifact_files": [
      {
        "name": "text",
        "size": 1,
        "modified": "2025-02-06T09:52:03.706Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Model JSON response for provided model id

Delete a model

delete

/v3/models/{model_id}

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v3/models/{model_id}' \
  --header 'Authorization: Bearer <token>'

202

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Details of a model delete job

Update the fields of a model

patch

/v3/models/{model_id}

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Body

schemaobject

Model schema with the details of each column

specobject

xai_paramsobject

XAI parameters set for a model

descriptionnullable string

display_namenullable string

Display name for the model

event_id_colnullable string

Event id column to be found in published data for the model

event_ts_colnullable string

Timestamp column to be found in published data for the model

event_ts_formatnullable string

Format of the timestamp like datetime, epoch time etc.

owner_by_idnullable string

User ID for the updated owner

deployment_datenullable string date-time

Date the model was deployed on

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v3/models/{model_id}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"schema":{"schema_version":1,"columns":[{"name":"text","data_type":"int","categories":[],"bins":[null],"replace_with_nulls":[]}]},"spec":{"schema_version":1,"inputs":[null],"outputs":[null],"targets":[null],"decisions":[null],"metadata":[null],"custom_features":[{"type":"FROM_COLUMNS","name":"text","columns":[null],"centroids":[null],"tf_idf":[{}]}]},"xai_params":{"custom_explain_methods":[null]}}'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "deployment_date": "2025-02-06T09:52:03.706Z",
    "artifact_status": "no_model",
    "deleted_at": "2025-02-06T09:52:03.706Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "created_at": "2025-02-06T09:52:03.706Z",
    "updated_at": "2025-02-06T09:52:03.706Z",
    "task_params": {
      "binary_classification_threshold": 1,
      "target_class_order": [],
      "group_by": "text",
      "top_k": 1,
      "class_weights": [
        1
      ],
      "weighted_ref_histograms": true
    },
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "text",
          "data_type": "int",
          "min": 1,
          "max": 1,
          "categories": [],
          "bins": [
            1
          ],
          "replace_with_nulls": [],
          "n_dimensions": 1,
          "id": "text"
        }
      ]
    },
    "spec": {
      "schema_version": 1,
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            null
          ],
          "centroids": [
            null
          ],
          "tf_idf": [
            {}
          ]
        }
      ]
    },
    "event_id_col": "text",
    "event_ts_col": "text",
    "event_ts_format": "text",
    "xai_params": {
      "custom_explain_methods": [
        "text"
      ],
      "default_explain_method": "text"
    },
    "artifact_files": [
      {
        "name": "text",
        "size": 1,
        "modified": "2025-02-06T09:52:03.706Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Updated model JSON response

Generate model from the given data sample

post

/v3/model-factory

Authorizations

Body

file_idstring uuidrequired

specobject

max_cardinalityinteger

sample_sizeinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/model-factory' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"file_id":"123e4567-e89b-12d3-a456-426614174000","spec":{"schema_version":1,"inputs":[null],"outputs":[null],"targets":[null],"decisions":[null],"metadata":[null],"custom_features":[{"type":"FROM_COLUMNS","name":"text","columns":[null],"centroids":[null],"tf_idf":[{}]}]},"max_cardinality":1000,"sample_size":10000}'

200

400

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "text",
          "data_type": "int",
          "min": 1,
          "max": 1,
          "categories": [],
          "bins": [
            1
          ],
          "replace_with_nulls": [],
          "n_dimensions": 1,
          "id": "text"
        }
      ]
    },
    "spec": {
      "schema_version": 1,
      "inputs": [
        "text"
      ],
      "outputs": [
        "text"
      ],
      "targets": [
        "text"
      ],
      "decisions": [
        "text"
      ],
      "metadata": [
        "text"
      ],
      "custom_features": [
        {
          "type": "FROM_COLUMNS",
          "name": "text",
          "columns": [
            null
          ],
          "centroids": [
            null
          ],
          "tf_idf": [
            {}
          ]
        }
      ]
    }
  }
}

Generated model

Update artifacts associated with the model

put

/v3/models/{model_id}/deploy-artifact

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Query parameters

deployment_paramsstring

JSON encoded Deployment Params

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v3/models/{model_id}/deploy-artifact' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Updated Model Artifacts

Upload artifacts associated with the model

post

/v3/models/{model_id}/deploy-artifact

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Query parameters

deployment_paramsstring

JSON encoded Deployment Params

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/models/{model_id}/deploy-artifact' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Deployed Model Artifacts

Update a surrogate model

put

/v3/models/{model_id}/deploy-surrogate

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Body

env_idstring uuidrequired

Unique identifier of the environment associated to the model

deployment_paramsall ofrequired

Additoinal paramteres specified to deploy surrogate model

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v3/models/{model_id}/deploy-surrogate' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"env_id":"123e4567-e89b-12d3-a456-426614174000","deployment_params":{"artifact_type":"SURROGATE","deployment_type":"BASE_CONTAINER","replicas":2,"cpu":500,"memory":512}}'

202

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Surrogate model updating task with job id

Deploy a surrogate model

post

/v3/models/{model_id}/deploy-surrogate

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Body

env_idstring uuidrequired

Unique identifier of the environment associated to the model

deployment_paramsall ofrequired

Additoinal paramteres specified to deploy surrogate model

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/models/{model_id}/deploy-surrogate' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"env_id":"123e4567-e89b-12d3-a456-426614174000","deployment_params":{"artifact_type":"SURROGATE","deployment_type":"BASE_CONTAINER","replicas":2,"cpu":500,"memory":512}}'

202

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Surrogate model generation task with job id

Details of all columns

Details of all columns for a model

get

/v3/models/{model_id}/columns

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models/{model_id}/columns' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "name": "text",
        "data_type": "int",
        "min": 1,
        "max": 1,
        "categories": [],
        "bins": [
          1
        ],
        "replace_with_nulls": [],
        "n_dimensions": 1,
        "id": "text"
      }
    ]
  }
}

Details of all columns for a model

Details of a specific column for a model

get

/v3/models/{model_id}/columns/{column_id}

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

column_idstringrequired

column_id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models/{model_id}/columns/{column_id}' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "name": "text",
    "data_type": "int",
    "min": 1,
    "max": 1,
    "categories": [],
    "bins": [
      1
    ],
    "replace_with_nulls": [],
    "n_dimensions": 1
  }
}

Details of a specific column for a model