LogoLogo
👨‍💻 API Reference📣 Release Notes📺 Request a Demo
  • Introduction to Fiddler
    • Monitor, Analyze, and Protect your ML Models and Gen AI Applications
  • Fiddler Doc Chatbot
  • First Steps
    • Getting Started With Fiddler Guardrails
    • Getting Started with LLM Monitoring
    • Getting Started with ML Model Observability
  • Tutorials & Quick Starts
    • LLM and GenAI
      • LLM Evaluation - Compare Outputs
      • LLM Monitoring - Simple
    • Fiddler Free Guardrails
      • Guardrails - Quick Start Guide
      • Guardrails - Faithfulness
      • Guardrails - Safety
      • Guardrails FAQ
    • ML Observability
      • ML Monitoring - Simple
      • ML Monitoring - NLP Inputs
      • ML Monitoring - Class Imbalance
      • ML Monitoring - Model Versions
      • ML Monitoring - Ranking
      • ML Monitoring - Regression
      • ML Monitoring - Feature Impact
      • ML Monitoring - CV Inputs
  • Glossary
    • Product Concepts
      • Baseline
      • Custom Metric
      • Data Drift
      • Embedding Visualization
      • Fiddler Guardrails
      • Fiddler Trust Service
      • LLM and GenAI Observability
      • Metric
      • Model Drift
      • Model Performance
      • ML Observability
      • Trust Score
  • Product Guide
    • LLM Application Monitoring & Protection
      • LLM-Based Metrics
      • Embedding Visualizations for LLM Monitoring and Analysis
      • Selecting Enrichments
      • Enrichments (Private Preview)
      • Guardrails for Proactive Application Protection
    • Optimize Your ML Models and LLMs with Fiddler's Comprehensive Monitoring
      • Alerts
      • Package-Based Alerts (Private Preview)
      • Class Imbalanced Data
      • Enhance ML and LLM Insights with Custom Metrics
      • Data Drift: Monitor Model Performance Changes with Fiddler's Insights
      • Ensuring Data Integrity in ML Models And LLMs
      • Embedding Visualization With UMAP
      • Fiddler Query Language
      • Model Versions
      • How to Effectively Use the Monitoring Chart UI
      • Performance Tracking
      • Model Segments: Analyze Cohorts for Performance Insights and Bias Detection
      • Statistics
      • Monitoring ML Model and LLM Traffic
      • Vector Monitoring
    • Enhance Model Insights with Fiddler's Slice and Explain
      • Events Table in RCA
      • Feature Analytics Creation
      • Metric Card Creation
      • Performance Charts Creation
      • Performance Charts Visualization
    • Master AI Monitoring: Create, Customize, and Compare Dashboards
      • Creating Dashboards
      • Dashboard Interactions
      • Dashboard Utilities
    • Adding and Editing Models in the UI
      • Model Editor UI
      • Model Schema Editing Guide
    • Fairness
    • Explainability
      • Model: Artifacts, Package, Surrogate
      • Global Explainability: Visualize Feature Impact and Importance in Fiddler
      • Point Explainability
      • Flexible Model Deployment
        • On Prem Manual Flexible Model Deployment XAI
  • Technical Reference
    • Python Client API Reference
    • Python Client Guides
      • Installation and Setup
      • Model Onboarding
        • Create a Project and Onboard a Model for Observation
        • Model Task Types
        • Customizing your Model Schema
        • Specifying Custom Missing Value Representations
      • Publishing Inference Data
        • Creating a Baseline Dataset
        • Publishing Batches Of Events
        • Publishing Ranking Events
        • Streaming Live Events
        • Updating Already Published Events
        • Deleting Events From Fiddler
      • Creating and Managing Alerts
      • Explainability Examples
        • Adding a Surrogate Model
        • Uploading Model Artifacts
        • Updating Model Artifacts
        • ML Framework Examples
          • Scikit Learn
          • Tensorflow HDF5
          • Tensorflow Savedmodel
          • Xgboost
        • Model Task Examples
          • Binary Classification
          • Multiclass Classification
          • Regression
          • Uploading A Ranking Model Artifact
    • Integrations
      • Data Pipeline Integrations
        • Airflow Integration
        • BigQuery Integration
        • Integration With S3
        • Kafka Integration
        • Sagemaker Integration
        • Snowflake Integration
      • ML Platform Integrations
        • Integrate Fiddler with Databricks for Model Monitoring and Explainability
        • Datadog Integration
        • ML Flow Integration
      • Alerting Integrations
        • PagerDuty Integration
    • Comprehensive REST API Reference
      • Projects REST API Guide
      • Model REST API Guide
      • File Upload REST API Guide
      • Custom Metrics REST API Guide
      • Segments REST API Guide
      • Baselines REST API Guide
      • Jobs REST API Guide
      • Alert Rules REST API Guide
      • Environments REST API Guide
      • Explainability REST API Guide
      • Server Info REST API Guide
      • Events REST API Guide
      • Fiddler Trust Service REST API Guide
    • Fiddler Free Guardrails Documentation
  • Configuration Guide
    • Authentication & Authorization
      • Adding Users
      • Overview of Role-Based Access Control
      • Email Authentication
      • Okta Integration
      • SSO with Azure AD
      • Ping Identity SAML SSO Integration
      • Mapping LDAP Groups & Users to Fiddler Teams
    • Application Settings
    • Supported Browsers
  • History
    • Release Notes
    • Python Client History
    • Compatibility Matrix
    • Product Maturity Definitions
Powered by GitBook

© 2024 Fiddler Labs, Inc.

On this page

Was this helpful?

  1. Technical Reference
  2. Comprehensive REST API Reference

Model REST API Guide

PreviousProjects REST API GuideNextFile Upload REST API Guide

Last updated 1 month ago

Was this helpful?

Get details of a model

get

Details of a model for given model id

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Responses
200
Model JSON response for provided model id
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
get
GET /v3/models/{model_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "text",
    "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": "name@gmail.com"
    },
    "deployment_date": "2025-05-09T04:43:38.055Z",
    "artifact_status": "no_model",
    "deleted_at": "2025-05-09T04:43:38.055Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "created_at": "2025-05-09T04:43:38.055Z",
    "updated_at": "2025-05-09T04:43:38.055Z",
    "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-05-09T04:43:38.055Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Delete a model

delete

Delete a model

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Responses
202
Details of a model delete job
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
delete
DELETE /v3/models/{model_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Update artifacts associated with the model

put

Update artifacts associated with the model

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Query parameters
Responses
200
Updated Model Artifacts
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
put
PUT /v3/models/{model_id}/deploy-artifact HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.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
Path parameters
model_idstring · uuidRequired

model id path parameter

Query parameters
Responses
200
Deployed Model Artifacts
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
post
POST /v3/models/{model_id}/deploy-artifact HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.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
Path parameters
model_idstring · uuidRequired

model id path parameter

Responses
200
Details of all columns for a model
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
get
GET /v3/models/{model_id}/columns HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.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
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
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
get
GET /v3/models/{model_id}/columns/{column_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "name": "text",
    "data_type": "int",
    "min": 1,
    "max": 1,
    "categories": [
      "text"
    ],
    "bins": [
      1
    ],
    "replace_with_nulls": [
      "text"
    ],
    "n_dimensions": 1
  }
}
  • GETList models
  • POSTAdd a new model under a project
  • GETGet details of a model
  • DELETEDelete a model
  • PATCHUpdate the fields of a model
  • POSTGenerate model from the given data sample
  • PUTUpdate artifacts associated with the model
  • POSTUpload artifacts associated with the model
  • PUTUpdate a surrogate model
  • POSTDeploy a surrogate model
  • GETDetails of all columns
  • GET/v3/models/{model_id}/columns/{column_id}

List models

get

Get list of model for provided query and filters

Authorizations
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
Responseall of
400
Bad Request
application/json
500
Internal Server Error
application/json
get
GET /v3/models HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "2.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "version": "text",
        "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": "name@gmail.com"
        },
        "deployment_date": "2025-05-09T04:43:38.055Z",
        "artifact_status": "no_model",
        "deleted_at": "2025-05-09T04:43:38.055Z",
        "algorithm": "text",
        "framework": "text",
        "created_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "name@gmail.com"
        },
        "updated_by": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "full_name": "text",
          "email": "name@gmail.com"
        },
        "created_at": "2025-05-09T04:43:38.055Z",
        "updated_at": "2025-05-09T04:43:38.055Z"
      }
    ]
  }
}

Add a new model under a project

post

Add a new model under a project

Authorizations
Body
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
Responseall of
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
409
Conflict
application/json
500
Internal Server Error
application/json
post
POST /v3/models HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1041

{
  "name": "text",
  "version": "text",
  "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-05-09T04:43:38.055Z",
  "algorithm": "text",
  "framework": "text",
  "event_id_col": "text",
  "event_ts_col": "text",
  "event_ts_format": "text"
}
{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "text",
    "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": "name@gmail.com"
    },
    "deployment_date": "2025-05-09T04:43:38.055Z",
    "artifact_status": "no_model",
    "deleted_at": "2025-05-09T04:43:38.055Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "created_at": "2025-05-09T04:43:38.055Z",
    "updated_at": "2025-05-09T04:43:38.055Z",
    "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-05-09T04:43:38.055Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Update the fields of a model

patch

Update the fields of a model

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Body
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
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
patch
PATCH /v3/models/{model_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 975

{
  "status": "LIVE",
  "version": "text",
  "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-05-09T04:43:38.055Z",
  "algorithm": "text",
  "framework": "text",
  "event_id_col": "text",
  "event_ts_col": "text",
  "event_ts_format": "text"
}
{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "version": "text",
    "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": "name@gmail.com"
    },
    "deployment_date": "2025-05-09T04:43:38.055Z",
    "artifact_status": "no_model",
    "deleted_at": "2025-05-09T04:43:38.055Z",
    "algorithm": "text",
    "framework": "text",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "name@gmail.com"
    },
    "created_at": "2025-05-09T04:43:38.055Z",
    "updated_at": "2025-05-09T04:43:38.055Z",
    "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-05-09T04:43:38.055Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Generate model from the given data sample

post

Generate model from the given data sample

Authorizations
Body
file_idstring · uuidRequired
max_cardinalityinteger · min: 1 · max: 100000OptionalDefault: 1000
sample_sizeinteger · min: 10000 · max: 100000OptionalDefault: 10000
Responses
200
Generated model
application/json
Responseall of
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /v3/model-factory HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "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": 1,
  "sample_size": 1
}
{
  "api_version": "2.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 a surrogate model

put

Update a surrogate model

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Body
all ofOptional
Responses
202
Surrogate model updating task with job id
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
put
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": "2.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}

Deploy a surrogate model

post

Deploy a surrogate model

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Body
all ofOptional
Responses
202
Surrogate model generation task with job id
application/json
Responseall of
400
Bad Request
application/json
404
Resource not found
application/json
500
Internal Server Error
application/json
post
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": "2.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  }
}