Skip to main content
POST
/
api
/
modelServing
/
v1
/
modelDeployments
Create a new Model Deployment
curl --request POST \
  --url https://api.example.com/api/modelServing/v1/modelDeployments \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "configuration": {
    "deploymentType": {
      "modelConfigs": {},
      "sharedConfig": {},
      "type": "SYNC_ENDPOINT"
    },
    "modelConfigs": {},
    "sharedConfig": {}
  },
  "deploymentTargetId": "ABC-123",
  "models": [
    {
      "environmentId": "<string>",
      "name": "XYZ Model",
      "source": {
        "registeredModelName": "Growth Forecasting Model",
        "registeredModelType": "MODELREGISTRY",
        "registeredModelVersion": 3
      }
    }
  ],
  "name": "Income Classifier Deployment",
  "resourceConfigurationId": "DEF-123",
  "collaborators": [
    {
      "id": "66a84107c774610134ae3a28"
    }
  ],
  "description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
  "isGloballyAccessible": true
}
'
{
  "collaborators": [
    {
      "id": "66a84107c774610134ae3a28"
    }
  ],
  "configuration": {
    "deploymentType": {
      "modelConfigs": {},
      "sharedConfig": {},
      "type": "SYNC_ENDPOINT"
    },
    "modelConfigs": {},
    "sharedConfig": {}
  },
  "creationTimestamp": "2023-07-15T14:35:47.89Z",
  "creatorInfo": {
    "id": "ABC-123",
    "username": "Production"
  },
  "deploymentTargetInfo": {
    "id": "ABC-123",
    "name": "Production",
    "typeName": "AWS SageMaker"
  },
  "description": "This endpoint is designed to provide businesses with insights into their customer retention patterns.",
  "id": "614e40a7-0509-4cae-89af-55e2097b817d",
  "isGloballyAccessible": true,
  "models": [
    {
      "environmentId": "<string>",
      "environmentName": "<string>",
      "name": "XYZ Model",
      "projectId": "<string>",
      "source": {
        "registeredModelName": "Growth Forecasting Model",
        "registeredModelType": "MODELREGISTRY",
        "registeredModelVersion": 3
      }
    }
  ],
  "name": "Income Classifier Deployment",
  "resourceConfigurationInfo": {
    "configuration": {},
    "id": "ABC-123",
    "name": "Large"
  },
  "version": 23,
  "remoteUpdateTimestamp": "2023-07-16T19:20:30.45Z",
  "status": {
    "message": "<string>",
    "modelOperations": {},
    "modelStates": {},
    "sharedOperations": [
      {
        "fields": {},
        "metadata": {
          "operations": [
            "<string>"
          ],
          "type": "<string>",
          "service": "<string>"
        },
        "type": "<string>",
        "credentials": {
          "expirationTime": "2023-11-07T05:31:56Z",
          "keys": [
            "<string>"
          ]
        },
        "examplePayload": "<string>",
        "examples": [
          {
            "code": "<string>",
            "format": "<string>",
            "language": "<string>",
            "request": "<string>"
          }
        ]
      }
    ],
    "sharedState": {}
  }
}

Authorizations

X-Domino-Api-Key
string
header
required

Body

application/json

Model Deployment

configuration
object
required

The Model Deployment configuration

deploymentTargetId
string
required
Example:

"ABC-123"

models
object[]
required

A list of models associated with this Model Deployment.

name
string
required

The Model Deployment name.

Example:

"Income Classifier Deployment"

resourceConfigurationId
string
required
Example:

"DEF-123"

collaborators
object[]

List of collaborators, if any. Will default to empty list if not provided

description
string
Example:

"This endpoint is designed to provide businesses with insights into their customer retention patterns."

isGloballyAccessible
boolean

Whether the Model Deployment is viewable by Domino Users who are not collaborators. Will default to false if not provided

Response

The created Model Deployment.

Model Deployment

collaborators
object[]
required

List of collaborators, if any

configuration
object
required

The Model Deployment configuration

creationTimestamp
string<date-time>
required
Example:

"2023-07-15T14:35:47.89Z"

creatorInfo
object
required

Information about the creator of a Model Deployment

deploymentTargetInfo
object
required

Information about a Deployment Target and its corresponding Deployment Target Type

description
string
required
Example:

"This endpoint is designed to provide businesses with insights into their customer retention patterns."

id
string
required

The id of the Model Deployment.

Example:

"614e40a7-0509-4cae-89af-55e2097b817d"

isGloballyAccessible
boolean
required

Whether the Model Deployment is viewable by Domino Users who are not collaborators

models
object[]
required

Models associated with this Model Deployment.

name
string
required
Example:

"Income Classifier Deployment"

resourceConfigurationInfo
object
required

Information about a Resource Configuration

version
integer
required
Example:

23

remoteUpdateTimestamp
string<date-time>
Example:

"2023-07-16T19:20:30.45Z"

status
object

The Model Deployment status