Model REST API Guide

List models

get

Get list of model for provided query and filters

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

latest_onlybooleanOptional

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

project_idstring · uuidOptional

project id query parameter

filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

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

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses

200

List of models for provided query and filters

application/json

Response object for paginated API responses.

api_versionstring · enumOptional

API version of the response.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a paginated response.

Default: PAGINATEDPossible values:

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/v3/models

HTTPcURLJavaScriptPython

GET /v3/models HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "version": "v1",
        "status": "LIVE",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "asset_type": "ML_MODEL"
        },
        "input_type": "text",
        "task": "binary_classification",
        "description": "text",
        "owner": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        },
        "deployment_date": "2026-05-10T10:12:19.166Z",
        "artifact_status": "no_model",
        "deleted_at": "2026-05-10T10:12:19.166Z",
        "algorithm": "text",
        "framework": "text",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "[email protected]"
        },
        "created_at": "2026-05-10T10:12:19.166Z",
        "updated_at": "2026-05-10T10:12:19.166Z"
      }
    ]
  }
}

Add a new model under a project

post

Add a new model under a project

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Name of the model

versionstring · min: 1 · max: 64Optional

Version of the model

Default: v1

project_idstring · uuidRequired

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

statusstring · enumOptionalDefault: LIVEPossible values:

input_typestring · enumRequired

Enumeration of different model input types.

Possible values:

taskstring · enumRequired

Enumeration of different types of model tasks.

Possible values:

descriptionstring · nullableOptional

Description of the model

owner_idstring · nullableOptional

User ID for the owner of the model

deployment_datestring · date-time · nullableOptional

Date the model was deployed on

algorithmstring · nullableOptional

Model algorithm

frameworkstring · nullableOptional

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

event_id_colstring · nullableOptional

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

event_ts_colstring · nullableOptional

Timestamp column to be found in published data for the model

event_ts_formatstring · nullableOptional

Format of the timestamp like datetime, epoch time etc.

Responses

200

Created model JSON response

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post

/v3/models

HTTPcURLJavaScriptPython

POST /v3/models HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1039

{
  "name": "text",
  "version": "v1",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "LIVE",
  "input_type": "text",
  "task": "binary_classification",
  "schema": {
    "schema_version": 1,
    "columns": [
      {
        "name": "text",
        "data_type": "int",
        "min": 1,
        "max": 1,
        "categories": [
          "text"
        ],
        "bins": [
          1
        ],
        "replace_with_nulls": [
          "text"
        ],
        "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": [
          "text"
        ],
        "centroids": [
          1
        ],
        "tf_idf": [
          {}
        ],
        "n_clusters": 1,
        "monitor_components": true
      }
    ]
  },
  "task_params": {
    "binary_classification_threshold": 1,
    "target_class_order": [
      "text"
    ],
    "group_by": "text",
    "top_k": 1,
    "class_weights": [
      1
    ],
    "weighted_ref_histograms": true
  },
  "xai_params": {
    "custom_explain_methods": [
      "text"
    ],
    "default_explain_method": "text"
  },
  "description": "text",
  "owner_id": "text",
  "deployment_date": "2026-05-10T10:12:19.166Z",
  "algorithm": "text",
  "framework": "text",
  "event_id_col": "text",
  "event_ts_col": "text",
  "event_ts_format": "text"
}

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "status": "LIVE",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "asset_type": "ML_MODEL"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "deployment_date": "2026-05-10T10:12:19.166Z",
    "artifact_status": "no_model",
    "deleted_at": "2026-05-10T10:12:19.166Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "created_at": "2026-05-10T10:12:19.166Z",
    "updated_at": "2026-05-10T10:12:19.166Z",
    "task_params": {
      "binary_classification_threshold": 1,
      "target_class_order": [
        "text"
      ],
      "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": [
            "text"
          ],
          "bins": [
            1
          ],
          "replace_with_nulls": [
            "text"
          ],
          "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": [
            "text"
          ],
          "centroids": [
            1
          ],
          "tf_idf": [
            {}
          ],
          "n_clusters": 1,
          "monitor_components": true
        }
      ]
    },
    "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": "2026-05-10T10:12:19.166Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Get details of a model

get

Details of a model for given model id

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Responses

200

Model JSON response for provided model id

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

/v3/models/{model_id}

HTTPcURLJavaScriptPython

GET /v3/models/{model_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "status": "LIVE",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "asset_type": "ML_MODEL"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "deployment_date": "2026-05-10T10:12:19.166Z",
    "artifact_status": "no_model",
    "deleted_at": "2026-05-10T10:12:19.166Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "created_at": "2026-05-10T10:12:19.166Z",
    "updated_at": "2026-05-10T10:12:19.166Z",
    "task_params": {
      "binary_classification_threshold": 1,
      "target_class_order": [
        "text"
      ],
      "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": [
            "text"
          ],
          "bins": [
            1
          ],
          "replace_with_nulls": [
            "text"
          ],
          "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": [
            "text"
          ],
          "centroids": [
            1
          ],
          "tf_idf": [
            {}
          ],
          "n_clusters": 1,
          "monitor_components": true
        }
      ]
    },
    "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": "2026-05-10T10:12:19.166Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Delete a model

delete

Delete a model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Responses

202

Details of a model delete job

application/json

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

delete

/v3/models/{model_id}

HTTPcURLJavaScriptPython

DELETE /v3/models/{model_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update the fields of a model

patch

Update the fields of a model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Body

application/json

statusstring · enumOptionalDefault: LIVEPossible values:

versionstring · min: 1 · max: 64Optional

Version of the model

Default: v1

input_typestring · enumOptional

Enumeration of different model input types.

Possible values:

taskstring · enumOptional

Enumeration of different types of model tasks.

Possible values:

descriptionstring · nullableOptional

Description of the model

owner_idstring · nullableOptional

User ID for the owner of the model

deployment_datestring · date-time · nullableOptional

Date the model was deployed on

algorithmstring · nullableOptional

Model algorithm

frameworkstring · nullableOptional

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

event_id_colstring · nullableOptional

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

event_ts_colstring · nullableOptional

Timestamp column to be found in published data for the model

event_ts_formatstring · nullableOptional

Format of the timestamp like datetime, epoch time etc.

Responses

200

Updated model JSON response

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

patch

/v3/models/{model_id}

HTTPcURLJavaScriptPython

PATCH /v3/models/{model_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 973

{
  "status": "LIVE",
  "version": "v1",
  "input_type": "text",
  "task": "binary_classification",
  "schema": {
    "schema_version": 1,
    "columns": [
      {
        "name": "text",
        "data_type": "int",
        "min": 1,
        "max": 1,
        "categories": [
          "text"
        ],
        "bins": [
          1
        ],
        "replace_with_nulls": [
          "text"
        ],
        "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": [
          "text"
        ],
        "centroids": [
          1
        ],
        "tf_idf": [
          {}
        ],
        "n_clusters": 1,
        "monitor_components": true
      }
    ]
  },
  "task_params": {
    "binary_classification_threshold": 1,
    "target_class_order": [
      "text"
    ],
    "group_by": "text",
    "top_k": 1,
    "class_weights": [
      1
    ],
    "weighted_ref_histograms": true
  },
  "xai_params": {
    "custom_explain_methods": [
      "text"
    ],
    "default_explain_method": "text"
  },
  "description": "text",
  "owner_id": "text",
  "deployment_date": "2026-05-10T10:12:19.166Z",
  "algorithm": "text",
  "framework": "text",
  "event_id_col": "text",
  "event_ts_col": "text",
  "event_ts_format": "text"
}

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "v1",
    "status": "LIVE",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "asset_type": "ML_MODEL"
    },
    "input_type": "text",
    "task": "binary_classification",
    "description": "text",
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "deployment_date": "2026-05-10T10:12:19.166Z",
    "artifact_status": "no_model",
    "deleted_at": "2026-05-10T10:12:19.166Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[email protected]"
    },
    "created_at": "2026-05-10T10:12:19.166Z",
    "updated_at": "2026-05-10T10:12:19.166Z",
    "task_params": {
      "binary_classification_threshold": 1,
      "target_class_order": [
        "text"
      ],
      "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": [
            "text"
          ],
          "bins": [
            1
          ],
          "replace_with_nulls": [
            "text"
          ],
          "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": [
            "text"
          ],
          "centroids": [
            1
          ],
          "tf_idf": [
            {}
          ],
          "n_clusters": 1,
          "monitor_components": true
        }
      ]
    },
    "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": "2026-05-10T10:12:19.166Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Generate model from the given data sample

post

Generate model from the given data sample

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

file_idstring · uuidRequired

max_cardinalityinteger · min: 1 · max: 100000OptionalDefault: 1000

sample_sizeinteger · min: 10000 · max: 100000OptionalDefault: 10000

Responses

200

Generated model

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/v3/model-factory

HTTPcURLJavaScriptPython

POST /v3/model-factory HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "file_id": "123e4567-e89b-12d3-a456-426614174000",
  "spec": {
    "schema_version": 1,
    "inputs": [
      "text"
    ],
    "outputs": [
      "text"
    ],
    "targets": [
      "text"
    ],
    "decisions": [
      "text"
    ],
    "metadata": [
      "text"
    ],
    "custom_features": [
      {
        "type": "FROM_COLUMNS",
        "name": "text",
        "columns": [
          "text"
        ],
        "centroids": [
          1
        ],
        "tf_idf": [
          {}
        ],
        "n_clusters": 1,
        "monitor_components": true
      }
    ]
  },
  "max_cardinality": 1000,
  "sample_size": 10000
}

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "text",
          "data_type": "int",
          "min": 1,
          "max": 1,
          "categories": [
            "text"
          ],
          "bins": [
            1
          ],
          "replace_with_nulls": [
            "text"
          ],
          "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": [
            "text"
          ],
          "centroids": [
            1
          ],
          "tf_idf": [
            {}
          ],
          "n_clusters": 1,
          "monitor_components": true
        }
      ]
    }
  }
}

Update artifacts associated with the model

put

Update artifacts associated with the model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Query parameters

Responses

200

Updated Model Artifacts

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

put

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

HTTPcURLJavaScriptPython

PUT /v3/models/{model_id}/deploy-artifact HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Upload artifacts associated with the model

post

Upload artifacts associated with the model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Query parameters

Responses

200

Deployed Model Artifacts

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

post

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

HTTPcURLJavaScriptPython

POST /v3/models/{model_id}/deploy-artifact HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update a surrogate model

put

Update a surrogate model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Body

application/json

Request payload for to deploy a surrogate model

env_idstring · uuidRequired

Unique identifier of the environment associated to the model

Responses

202

Surrogate model updating task with job id

application/json

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

put

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

HTTPcURLJavaScriptPython

PUT /v3/models/{model_id}/deploy-surrogate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "env_id": "123e4567-e89b-12d3-a456-426614174000",
  "deployment_params": {
    "artifact_type": "SURROGATE",
    "deployment_type": "BASE_CONTAINER",
    "image_uri": "text",
    "replicas": 2,
    "cpu": 500,
    "memory": 512
  }
}

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

Deploy a surrogate model

post

Deploy a surrogate model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Body

application/json

Request payload for to deploy a surrogate model

env_idstring · uuidRequired

Unique identifier of the environment associated to the model

Responses

202

Surrogate model generation task with job id

application/json

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

post

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

HTTPcURLJavaScriptPython

POST /v3/models/{model_id}/deploy-surrogate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "env_id": "123e4567-e89b-12d3-a456-426614174000",
  "deployment_params": {
    "artifact_type": "SURROGATE",
    "deployment_type": "BASE_CONTAINER",
    "image_uri": "text",
    "replicas": 2,
    "cpu": 500,
    "memory": 512
  }
}

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

Details of all columns

get

Details of all columns for a model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

Responses

200

Details of all columns for a model

application/json

Response object for paginated API responses.

api_versionstring · enumOptional

API version of the response.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a paginated response.

Default: PAGINATEDPossible values:

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

/v3/models/{model_id}/columns

HTTPcURLJavaScriptPython

GET /v3/models/{model_id}/columns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

Details of a specific column for a model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

model_idstring · uuidRequired

model id path parameter

column_idstringRequired

column_id path parameter

Responses

200

Details of a specific column for a model

application/json

Response object for standard API responses.

api_versionstring · enumOptional

API version.

Default: 3.0Possible values:

kindstring · enumOptional

Type of response, indicating a normal response.

Default: NORMALPossible values:

400

Bad Request

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /v3/models/{model_id}/columns/{column_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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