Skip to main content
POST
/
api
/
modelServing
/
v1
/
modelApis
cURL
curl --request POST \
  --url https://api.example.com/api/modelServing/v1/modelApis \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "environmentId": "<string>",
  "environmentVariables": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "isAsync": true,
  "name": "<string>",
  "strictNodeAntiAffinity": true,
  "version": {
    "logHttpRequestResponse": true,
    "monitoringEnabled": true,
    "projectId": "<string>",
    "source": {
      "excludeFiles": [
        "<string>"
      ],
      "file": "<string>",
      "function": "<string>",
      "registeredModelName": "<string>",
      "registeredModelVersion": 123
    },
    "commitId": "<string>",
    "description": "<string>",
    "environmentId": "<string>",
    "predictionDatasetResourceId": "<string>",
    "provenanceCheckpointId": "<string>",
    "recordInvocation": true,
    "shouldDeploy": true
  },
  "bundleId": "<string>",
  "hardwareTierId": "<string>",
  "replicas": 123,
  "resourceQuotaId": "<string>"
}
'
{
  "access": {
    "accessTokens": [
      {
        "created": 123,
        "createdBy": "<string>",
        "id": "<string>",
        "lastGenerated": 123,
        "lastGeneratedBy": "<string>",
        "name": "<string>"
      }
    ],
    "isPublic": true
  },
  "collaborators": [
    {
      "collaborator": "<string>",
      "role": "<string>"
    }
  ],
  "description": "<string>",
  "environmentId": "<string>",
  "healthCheck": {
    "failureThreshold": 123,
    "initialDelaySeconds": 123,
    "periodSeconds": 123,
    "timeoutSeconds": 123
  },
  "id": "<string>",
  "isArchived": true,
  "isAsync": true,
  "metadata": {
    "created": 123,
    "createdBy": "<string>",
    "lastModified": 123
  },
  "name": "<string>",
  "replicas": 123,
  "routingMode": "<string>",
  "strictNodeAntiAffinity": true,
  "volumes": [
    {
      "mountPath": "<string>",
      "name": "<string>",
      "readOnly": true,
      "volumeType": "<string>"
    }
  ],
  "activeVersion": {
    "dataPlaneId": "<string>",
    "id": "<string>",
    "deployment": {
      "isPending": true,
      "status": "<string>"
    },
    "number": 123
  },
  "bundleId": "<string>",
  "hardwareTierId": "<string>",
  "overrideRequestTimeoutSecs": 123,
  "resourceQuotaId": "<string>"
}

Authorizations

X-Domino-Api-Key
string
header
required

Body

application/json
description
string
required

The description of the Model API to create.

environmentId
string
required

The id of the environment the Model API to create should be deployed to.

environmentVariables
object[]
required

The environment variables of the Model API to create.

isAsync
boolean
required

Whether the Model API to create should be async.

name
string
required

The name of the Model API to create.

strictNodeAntiAffinity
boolean
required

Whether the Model API to create should have strict node anti affinity.

version
object
required
bundleId
string | null

The ID of the bundle governing the model API to create.

Pattern: ^[0-9a-f]{24}$
hardwareTierId
string | null

The id of the hardware tier the Model API to create should be deployed with.

replicas
integer

The number of replicas of the Model API should be created with.

resourceQuotaId
string | null

The id of the resource quota the Model API to create should be deployed with.

Response

201 - application/json

The created Model API.

access
object
required
collaborators
object[]
required

The collaborators of the Model API.

description
string
required

The description of the Model API.

environmentId
string
required

The id of the environment the Model API is deployed to.

healthCheck
object
required
id
string
required

The id of the Model API.

isArchived
boolean
required

Whether the Model API is archived.

isAsync
boolean
required

Whether the Model API is async.

metadata
object
required
name
string
required

The name of the Model API.

replicas
integer
required

The number of replicas of the Model API.

routingMode
string
required

The routing mode of the Model API.

strictNodeAntiAffinity
boolean
required

Whether the Model API has strict node anti affinity.

volumes
object[]
required

The volumes of the Model API.

activeVersion
object
bundleId
string | null

The ID of the bundle governing the model API to create.

Pattern: ^[0-9a-f]{24}$
hardwareTierId
string | null

The id of the hardware tier the Model API is deployed with.

overrideRequestTimeoutSecs
integer | null

The request timeout configuration of the Model API.

resourceQuotaId
string | null

The id of the resource quota the Model API is deployed with.