Skip to navigation
DocumentationReferenceAPI ReferenceModel Deployment Configs

Create ModelDeploymentConfig

View as Markdown

Create a new ModelDeploymentConfig (version 1).

Path parameters

workspacestringRequired

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"<=63 characters

Name of the deployment configuration. Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).

engineenumRequired

Inference engine selecting the compiler path (nim/vllm/generic)

Allowed values:
model_specobjectRequired

What model to serve and how — independent of the executor it runs on

executor_configobjectRequired

Compute + container settings for the executor the deployment runs on

projectstringOptionalformat: "^[\w\-./]+$"<=255 characters
The URN of the project associated with this deployment configuration
descriptionstringOptional<=1000 characters
Optional description of the deployment configuration
model_entity_idstringOptional<=255 characters
Optional reference to the base model entity ID for this deployment

Response

Create a new model deployment configuration
namestringformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"<=63 characters

Name of the entity. Name/workspace combo must be unique across all entities. Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).

workspacestringformat: "^[\w\-.]+$"<=255 characters

The workspace of the entity. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

created_atdatetime
The timestamp of model entity creation
updated_atdatetime
The timestamp of the last model entity update
entity_versioninteger
Version of this deployment config. Automatically managed.
engineenum

Inference engine selecting the compiler path (nim/vllm/generic)

Allowed values:
model_specobject

What model to serve and how — independent of the executor it runs on

executor_configobject

Compute + container settings for the executor the deployment runs on

idstringOptional
Unique identifier for the deployment config
projectstringOptionalformat: "^[\w\-./]+$"<=255 characters
The URN of the project associated with this entity.
descriptionstringOptional<=1000 characters
Optional description of the deployment configuration
model_entity_idstringOptional<=255 characters
Optional reference to the base model entity ID for this deployment

Errors

422
Unprocessable Entity Error