Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-04193459793.6 KB
VolumeService

Create a model

Registers a custom model resource in the project. Registration creates the model's metadata; upload or import model files separately before deploying it.

post/projects/{projectId}/models

Path parameters

projectIdstring required

Project identifier.

Request body

namestring required

Name for the custom model. May be bare or qualified as <project_slug>/<model_name>; a supplied project slug must match the project in the request path.

typestring required

Volume type to create. Use model or adapter; plural models and adapters are also accepted.

descriptionstring

Human-readable description of the model and its intended use.

baseModelIdstring required

ID of the supported base model from which this model was derived.

Response

OK

idstring required

Unique model identifier.

projectIdstring required

ID of the project that owns the model.

organizationIdstring required

ID of the organization that owns the model's project.

namestring required

Project-qualified model name in the form <project_slug>/<model_name>. Create and update requests may use the bare or qualified form.

descriptionstring

Human-readable description of the model and its intended use.

baseModelIdstring

ID of the supported or custom base model from which this model was derived.

baseModelstring

Resource name of the base model, using projects/{baseProject}/models/{baseModelId}; empty when the model has no base.

visibility'VISIBILITY_PRIVATE' | 'VISIBILITY_INTERNAL' required

Who can discover the model. VISIBILITY_PRIVATE restricts it to the project; VISIBILITY_INTERNAL shares it with the organization.