Skip to main content
POST
/
v3
/
models
Add a new model under a project
curl --request POST \
  --url https://{host}/v3/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schema": {
    "schema_version": 1,
    "columns": [
      {
        "name": "<string>",
        "min": 123,
        "max": 123,
        "categories": [
          "<string>"
        ],
        "bins": [
          123
        ],
        "replace_with_nulls": [
          "<string>"
        ],
        "n_dimensions": 123,
        "id": "<string>"
      }
    ]
  },
  "spec": {
    "schema_version": 1,
    "inputs": [
      "<string>"
    ],
    "outputs": [
      "<string>"
    ],
    "targets": [
      "<string>"
    ],
    "decisions": [
      "<string>"
    ],
    "metadata": [
      "<string>"
    ],
    "custom_features": [
      {
        "name": "<string>",
        "columns": [
          "<string>"
        ],
        "centroids": [
          123
        ],
        "tf_idf": [
          {}
        ],
        "n_clusters": 123,
        "monitor_components": true
      }
    ]
  },
  "version": "v1",
  "status": "LIVE",
  "task_params": {
    "binary_classification_threshold": 123,
    "target_class_order": [
      "<string>"
    ],
    "group_by": "<string>",
    "top_k": 123,
    "class_weights": [
      123
    ],
    "weighted_ref_histograms": true
  },
  "xai_params": {
    "custom_explain_methods": [
      "<string>"
    ],
    "default_explain_method": "<string>"
  },
  "description": "<string>",
  "owner_id": "<string>",
  "deployment_date": "2023-11-07T05:31:56Z",
  "algorithm": "<string>",
  "framework": "<string>",
  "event_id_col": "<string>",
  "event_ts_col": "<string>",
  "event_ts_format": "<string>"
}
'
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "version": "v1",
    "organization": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "project": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "deleted_at": "2023-11-07T05:31:56Z",
    "algorithm": "<string>",
    "framework": "<string>",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "owner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "deployment_date": "2023-11-07T05:31:56Z",
    "updated_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "full_name": "<string>"
    },
    "task_params": {
      "binary_classification_threshold": 123,
      "target_class_order": [
        "<string>"
      ],
      "group_by": "<string>",
      "top_k": 123,
      "class_weights": [
        123
      ],
      "weighted_ref_histograms": true
    },
    "schema": {
      "schema_version": 1,
      "columns": [
        {
          "name": "<string>",
          "id": "<string>",
          "min": 123,
          "max": 123,
          "categories": [
            "<string>"
          ],
          "bins": [
            123
          ],
          "replace_with_nulls": [
            "<string>"
          ],
          "n_dimensions": 123
        }
      ]
    },
    "spec": {
      "schema_version": 1,
      "inputs": [
        "<string>"
      ],
      "outputs": [
        "<string>"
      ],
      "targets": [
        "<string>"
      ],
      "decisions": [
        "<string>"
      ],
      "metadata": [
        "<string>"
      ],
      "custom_features": [
        {
          "name": "<string>",
          "columns": [
            "<string>"
          ],
          "centroids": [
            123
          ],
          "tf_idf": [
            {}
          ],
          "n_clusters": 123,
          "monitor_components": true
        }
      ]
    },
    "event_id_col": "<string>",
    "event_ts_col": "<string>",
    "event_ts_format": "<string>",
    "xai_params": {
      "custom_explain_methods": [
        "<string>"
      ],
      "default_explain_method": "<string>"
    },
    "artifact_files": [
      {
        "name": "<string>",
        "size": 123,
        "modified": "2023-11-07T05:31:56Z"
      }
    ],
    "is_binary_ranking_model": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the model

​
project_id
string<uuid>
required

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

​
input_type
enum<string>
required

Enumeration of different model input types.

Available options:
text,
structured
​
task
enum<string>
required

Enumeration of different types of model tasks.

Available options:
binary_classification,
multiclass_classification,
regression,
ranking,
not_set,
llm
​
schema
object
required

Model schema with the details of each column

​
spec
object
required
​
version
string
default:v1

Version of the model

Required string length: 1 - 64
​
status
enum<string>
default:LIVE
Available options:
LIVE,
DRAFT
​
task_params
object
​
xai_params
object

XAI parameters set for a model

​
description
string | null

Description of the model

​
owner_id
string | null

User ID for the owner of the model

​
deployment_date
string<date-time> | null

Date the model was deployed on

​
algorithm
string | null

Model algorithm

​
framework
string | null

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

​
event_id_col
string | null

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

​
event_ts_col
string | null

Timestamp column to be found in published data for the model

​
event_ts_format
string | null

Format of the timestamp like datetime, epoch time etc.

Response

Created model JSON response

Response object for standard API responses.

​
api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
​
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
​
data
object

Model fields JSON