Skip to main content
POST
Create a model

Authorizations

Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required

Project identifier.

Body

application/json

Request for registering a custom model or adapter in a project.

name
string
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.

type
string
required

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

baseModelId
string
required

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

description
string

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

Response

OK

Custom or derived model registered in a project and backed by versioned weight files.

id
string
required

Unique model identifier.

projectId
string
required

ID of the project that owns the model.

organizationId
string
required

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

name
string
required

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

weights
object
required

Architecture, size, precision, and speculative-decoding metadata derived from the model files.

visibility
enum<string>
default:VISIBILITY_PRIVATE
required

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

Available options:
VISIBILITY_PRIVATE,
VISIBILITY_INTERNAL
description
string

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

baseModelId
string

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

baseModel
string
read-only

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