Model REST API Guide
Get list of model for provided query and filters
Whether to send only latest version of each model or all version. False by default
project id query parameter
Allows you to filter by any field.
Allows you to search by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Limit for the pagination
Offset for the pagination
GET /v3/models HTTP/1.1
Host:
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"
},
"input_type": "text",
"task": "binary_classification",
"description": "text",
"owner": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"deployment_date": "2025-07-01T22:57:45.242Z",
"artifact_status": "no_model",
"deleted_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z",
"updated_at": "2025-07-01T22:57:45.242Z"
}
]
}
}
Add a new model under a project
Name of the model
Version of the model
v1
UUID format unique identifier for the project the model is added in
LIVE
Possible values: Enumeration of different model input types.
Enumeration of different types of model tasks.
Description of the model
User ID for the owner of the model
Date the model was deployed on
Model algorithm
A string providing information about the software library and version used to train and run this model
Event id column to be found in published data for the model
Timestamp column to be found in published data for the model
Format of the timestamp like datetime, epoch time etc.
POST /v3/models HTTP/1.1
Host:
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": "2025-07-01T22:57:45.242Z",
"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"
},
"input_type": "text",
"task": "binary_classification",
"description": "text",
"owner": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"deployment_date": "2025-07-01T22:57:45.242Z",
"artifact_status": "no_model",
"deleted_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z",
"updated_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z"
}
],
"is_binary_ranking_model": true
}
}
Details of a model for given model id
model id path parameter
GET /v3/models/{model_id} HTTP/1.1
Host:
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"
},
"input_type": "text",
"task": "binary_classification",
"description": "text",
"owner": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"deployment_date": "2025-07-01T22:57:45.242Z",
"artifact_status": "no_model",
"deleted_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z",
"updated_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z"
}
],
"is_binary_ranking_model": true
}
}
Delete a model
model id path parameter
DELETE /v3/models/{model_id} HTTP/1.1
Host:
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
model id path parameter
LIVE
Possible values: Version of the model
v1
Enumeration of different model input types.
Enumeration of different types of model tasks.
Description of the model
User ID for the owner of the model
Date the model was deployed on
Model algorithm
A string providing information about the software library and version used to train and run this model
Event id column to be found in published data for the model
Timestamp column to be found in published data for the model
Format of the timestamp like datetime, epoch time etc.
PATCH /v3/models/{model_id} HTTP/1.1
Host:
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": "2025-07-01T22:57:45.242Z",
"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"
},
"input_type": "text",
"task": "binary_classification",
"description": "text",
"owner": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "text",
"email": "[email protected]"
},
"deployment_date": "2025-07-01T22:57:45.242Z",
"artifact_status": "no_model",
"deleted_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z",
"updated_at": "2025-07-01T22:57:45.242Z",
"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": "2025-07-01T22:57:45.242Z"
}
],
"is_binary_ranking_model": true
}
}
Generate model from the given data sample
1000
10000
POST /v3/model-factory HTTP/1.1
Host:
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
model id path parameter
PUT /v3/models/{model_id}/deploy-artifact HTTP/1.1
Host:
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
model id path parameter
POST /v3/models/{model_id}/deploy-artifact HTTP/1.1
Host:
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
model id path parameter
PUT /v3/models/{model_id}/deploy-surrogate HTTP/1.1
Host:
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
model id path parameter
POST /v3/models/{model_id}/deploy-surrogate HTTP/1.1
Host:
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 for a model
model id path parameter
GET /v3/models/{model_id}/columns HTTP/1.1
Host:
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"
}
]
}
}
Details of a specific column for a model
model id path parameter
column_id path parameter
GET /v3/models/{model_id}/columns/{column_id} HTTP/1.1
Host:
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
}
}
Last updated
Was this helpful?