Skip to main content
POST
/
api
/
registeredmodels
/
v2
Register a model from various sources
curl --request POST \
  --url https://api.example.com/api/registeredmodels/v2 \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "create": true,
  "modelName": "churn-prediction-model",
  "modelSource": {
    "sourceType": "huggingface"
  },
  "description": "Customer churn prediction model trained on historical data",
  "discoverable": false,
  "modelCategory": "genai",
  "modelType": "llm",
  "projectId": "<string>"
}
'
{
  "modelVersion": {
    "createdAt": "2022-03-12T02:13:44.467Z",
    "modelName": "churn-prediction",
    "modelVersion": 4,
    "modelVersionDescription": "Customer churn model V1",
    "ownerUsername": "martin_hito",
    "project": {
      "id": "62313ce67a0af0281c01a6a5",
      "isGitBasedProject": true,
      "name": "TO-DO",
      "ownerUsername": "TO-DO"
    },
    "tags": {},
    "updatedAt": "2022-03-12T02:13:44.467Z",
    "versionUiDetails": {
      "modelVersionDataSources": [
        {
          "dataSourceType": "<string>",
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "modelVersionDatasets": [
        {
          "id": "<string>",
          "name": "<string>",
          "snapshotId": "<string>"
        }
      ],
      "experimentRunInfo": {
        "metrics": [
          {
            "key": "<string>",
            "timestamp": "2022-03-12T02:13:44.467Z",
            "value": 123
          }
        ],
        "params": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "runUrl": "<string>"
      }
    },
    "buildStatus": "Succeeded",
    "experimentRunId": "db79712b47084c27a463a188bf901943"
  },
  "registeredModel": {
    "createdAt": "2022-03-12T02:13:44.467Z",
    "description": "Customer churn model",
    "name": "churn-prediction",
    "ownerUsername": "martin_hito",
    "project": {
      "id": "62313ce67a0af0281c01a6a5",
      "isGitBasedProject": true,
      "name": "TO-DO",
      "ownerUsername": "TO-DO"
    },
    "requestingUserAccess": {
      "canEditCustomFieldValues": true,
      "canEditModel": true,
      "canEditProjectAssets": true,
      "canEditTaxonomyTags": true,
      "canViewExperimentRuns": true,
      "canViewModelApis": true,
      "canViewProject": true,
      "canViewProjectFiles": true
    },
    "tags": {},
    "updatedAt": "2022-03-12T02:13:44.467Z",
    "discoverable": false,
    "latestVersion": 1
  }
}

Authorizations

​
X-Domino-Api-Key
string
header
required

Body

application/json

Details of the model to register

​
create
boolean
required

Indicates whether to create or update the registered model.

​
modelName
string
required

The name of the registered model

Example:

"churn-prediction-model"

​
modelSource
object
required
​
description
string

Optional description of the registered model

Example:

"Customer churn prediction model trained on historical data"

​
discoverable
boolean
default:false

Indicates whether this model is publicly discoverable. If true, users who are not project members will see this model in search results and can view basic model details.

​
modelCategory
string

Category of the model (e.g., "genai", "ml").

Example:

"genai"

​
modelType
string

Type of the model (e.g., "llm", "embedding", "other-genai", "ml").

Example:

"llm"

​
projectId
string

Project ID of the registered model. Required for Hugging Face models only. For MLflow models, this is ignored as the project is determined from the experiment run id.

Response

Success

​
modelVersion
object
required
​
registeredModel
object
required