Model REST API Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
Get list of model for provided query and filters
/v3/models
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
Add a new model under a project
/v3/models
Name of the model
Version of the model
UUID format unique identifier for the project the model is added in
LIVE
, DRAFT
Enumeration of different model input types.
text
, structured
Enumeration of different types of model tasks.
binary_classification
, multiclass_classification
, regression
, ranking
, not_set
, llm
Model schema with the details of each column
XAI parameters set for a model
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.
Update the fields of a model
/v3/models/{model_id}
model id path parameter
LIVE
, DRAFT
Version of the model
Enumeration of different model input types.
text
, structured
Enumeration of different types of model tasks.
binary_classification
, multiclass_classification
, regression
, ranking
, not_set
, llm
Model schema with the details of each column
XAI parameters set for a model
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.
Generate model from the given data sample
/v3/model-factory
Update artifacts associated with the model
/v3/models/{model_id}/deploy-artifact
model id path parameter
JSON encoded Deployment Params
Upload artifacts associated with the model
/v3/models/{model_id}/deploy-artifact
model id path parameter
JSON encoded Deployment Params
Update a surrogate model
/v3/models/{model_id}/deploy-surrogate
model id path parameter
Request payload for to deploy a surrogate model
Deploy a surrogate model
/v3/models/{model_id}/deploy-surrogate
model id path parameter
Request payload for to deploy a surrogate model
Details of a specific column for a model
/v3/models/{model_id}/columns/{column_id}
model id path parameter
column_id path parameter