Skip to main content
PATCH
/
api
/
gen-ai
/
beta
/
endpoints
/
{endpointId}
/
versions
/
{versionNumber}
Patch a Gen AI Endpoint version
curl --request PATCH \
  --url https://api.example.com/api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber} \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "collaborators": [
    {
      "name": "John Doe",
      "organizationId": "62313ce67a0af0281c01a6a5",
      "userId": "62313ce67a0af0281c01a6a5"
    }
  ],
  "configuration": {
    "maxNumberOfSequences": 256,
    "servedModelName": "my-model",
    "tensorParallelism": 1,
    "vllmArguments": "--max-model-length 4095 --gpu-memory-utilization 0.90"
  },
  "description": "My Endpoint Description",
  "hardwareTierId": "62313ce67a0af0281c01a6a5",
  "instructions": "Use the endpoint to generate text",
  "modelSource": {},
  "name": "My Endpoint",
  "vanityUrl": "my-endpoint-url",
  "versionDescription": "My Endpoint Version Description",
  "versionLabel": 1
}
'
{
  "endpoint": {
    "createdAt": "2022-03-12T02:13:44.467Z",
    "creator": {
      "id": "integration test",
      "name": "Full User Name"
    },
    "id": "62313ce67a0af0281c01a6a5",
    "name": "My Endpoint",
    "project": {
      "id": "62313ce67a0af0281c01a6a5",
      "name": "My Project",
      "owner": {
        "id": "integration test",
        "name": "Full User Name"
      }
    },
    "updatedAt": "2022-03-12T02:13:44.467Z",
    "url": "https://cloud-dogfood.domino.tech/endpoint/my-endpoint",
    "vanityUrl": "https://cloud-dogfood.domino.tech/endpoints/my-endpoint",
    "currentVersion": {
      "configuration": {
        "maxNumberOfSequences": 256,
        "servedModelName": "my-model",
        "tensorParallelism": 1,
        "vllmArguments": "--max-model-length 4095 --gpu-memory-utilization 0.90"
      },
      "createdAt": "2022-03-12T02:13:44.467Z",
      "creator": {
        "id": "integration test",
        "name": "Full User Name"
      },
      "endpointId": "62313ce67a0af0281c01a6a5",
      "environment": {
        "id": "62313ce67a0af0281c01a6a5",
        "name": "My Environment",
        "revisionId": "62313ce67a0af0281c01a6a5"
      },
      "hardwareTier": {
        "dataPlaneId": "62313ce67a0af0281c01a6a5",
        "dataPlaneName": "My Data Plane",
        "id": "62313ce67a0af0281c01a6a5"
      },
      "modelSource": {
        "huggingFace": {
          "commit": "62313ce67a0af0281c01a6a5",
          "path": "my-model",
          "apiToken": "62313ce67a0af0281c01a6a5"
        },
        "registeredModel": {
          "modelName": "RandomForestRegression",
          "modelVersion": 1
        }
      },
      "number": 1,
      "description": "My Endpoint Version Description",
      "executionId": "62313ce67a0af0281c01a6a5",
      "label": 1
    },
    "description": "My Endpoint Description",
    "instructions": "Use the endpoint to generate text",
    "requestCount": 100
  },
  "version": {
    "configuration": {
      "maxNumberOfSequences": 256,
      "servedModelName": "my-model",
      "tensorParallelism": 1,
      "vllmArguments": "--max-model-length 4095 --gpu-memory-utilization 0.90"
    },
    "createdAt": "2022-03-12T02:13:44.467Z",
    "creator": {
      "id": "integration test",
      "name": "Full User Name"
    },
    "endpointId": "62313ce67a0af0281c01a6a5",
    "environment": {
      "id": "62313ce67a0af0281c01a6a5",
      "name": "My Environment",
      "revisionId": "62313ce67a0af0281c01a6a5"
    },
    "hardwareTier": {
      "dataPlaneId": "62313ce67a0af0281c01a6a5",
      "dataPlaneName": "My Data Plane",
      "id": "62313ce67a0af0281c01a6a5"
    },
    "modelSource": {
      "huggingFace": {
        "commit": "62313ce67a0af0281c01a6a5",
        "path": "my-model",
        "apiToken": "62313ce67a0af0281c01a6a5"
      },
      "registeredModel": {
        "modelName": "RandomForestRegression",
        "modelVersion": 1
      }
    },
    "number": 1,
    "description": "My Endpoint Version Description",
    "executionId": "62313ce67a0af0281c01a6a5",
    "label": 1
  }
}

Authorizations

X-Domino-Api-Key
string
header
required

Path Parameters

endpointId
string
required

The ID of the Gen AI Endpoint.

versionNumber
integer
required

The Number of the Gen AI Endpoint Version.

Body

application/json

What to patch in the Endpoint Version

collaborators
object[]
configuration
object
description
string

The description of the endpoint

Example:

"My Endpoint Description"

environment
object
generalAccess
enum<string>
Available options:
Restricted,
Viewer,
Consumer
hardwareTierId
string

The hardware tier ID of the endpoint

Example:

"62313ce67a0af0281c01a6a5"

instructions
string

The instructions for using the endpoint

Example:

"Use the endpoint to generate text"

modelSource
object
name
string

The name of the endpoint

Example:

"My Endpoint"

vanityUrl
string

The vanity URL of the endpoint

Example:

"my-endpoint-url"

versionDescription
string

The description of the initial version of the endpoint

Example:

"My Endpoint Version Description"

versionLabel
string

The label of the initial version of the endpoint

Example:

1

Response

Success

The result of patch an endpoint version

endpoint
object
required
version
object
required