Skip to main content

ModelCreate

Payload used to create Model. Required fields are name, type, protocol.

nameName (string)required
alias object
anyOf
string
typeType (string)required

Model placement: internal hosts the model in D.Hub; external registers an existing endpoint.

Possible values: [internal, external]

protocolProtocol (string)required

REST contract identifier. Built-in: 'openai-embeddings'. 'custom' is an opaque escape hatch.

Possible values: [openai-embeddings, custom]

deployment object
anyOf
imageImage (string)required

Fully qualified container image reference. Custom images must be digest-pinned and cannot use the latest tag.

artifact_version object

Artifact version identifier to deploy. Omit it to resolve the latest version when deployment starts.

anyOf
string
command object

Optional container entrypoint override.

anyOf
  • Array [
    • string
  • ]
    • args object

    Optional arguments that override the image command.

    anyOf
  • Array [
    • string
  • ]
    • portPort (integer)
    Default value: 8080
    cpu object

    Requested CPU amount, such as 500m.

    anyOf
    string
    memory object

    Requested memory amount, such as 2Gi.

    anyOf
    string
    gpu object

    GPU count request

    anyOf
    integer
    replicasReplicas (integer)

    Number of model instances to run. Higher values increase resource usage.

    Default value: 1
    health_pathHealth Path (string)

    HTTP path used to check whether the model is ready and healthy.

    Default value: /healthz
    env object

    Non-secret environment variables passed to the model container. Store secrets separately.

    property name*string
    node_selector object

    Node labels that every selected execution node must match.

    property name*string
    tolerations object[]

    Node taints that the model deployment is allowed to tolerate.

  • Array [
    • key object

    Taint key matched by this toleration, or null to match every key when operator is Exists.

    anyOf
    string
    operatorOperator (string)

    'Equal' requires value; 'Exists' ignores it.

    Possible values: [Exists, Equal]

    Default value: Equal
    value object
    anyOf
    string
    effect object

    Taint effect matched by this toleration, or null to match every effect.

    anyOf
    string

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    toleration_seconds object

    For effect='NoExecute', evict after this many seconds.

    anyOf
    integer
  • ]
    • url object
    anyOf
    string
    auth object
    anyOf
    kindKind (string)

    Possible values: [bearer, none]

    Default value: none
    secret_ref object

    Opaque reference to a stored secret. Required when kind is bearer; raw tokens are never returned.

    anyOf
    string
    headerHeader (string)
    Default value: Authorization
    prefixPrefix (string)
    Default value: Bearer
    model object
    anyOf
    string
    collection_id object

    Identifier of the containing collection.

    anyOf
    string

    Possible values: non-empty

    folder_id object
    anyOf
    string
    tags object
    anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    ModelCreate
    {
      "name": "string",
      "alias": "string",
      "type": "internal",
      "protocol": "openai-embeddings",
      "deployment": {
        "image": "string",
        "artifact_version": "string",
        "command": [
          "string"
        ],
        "args": [
          "string"
        ],
        "port": 8080,
        "cpu": "string",
        "memory": "string",
        "gpu": 0,
        "replicas": 1,
        "health_path": "/healthz",
        "env": {},
        "node_selector": {},
        "tolerations": [
          {
            "key": "string",
            "operator": "Equal",
            "value": "string",
            "effect": "NoSchedule",
            "toleration_seconds": 0
          }
        ]
      },
      "url": "string",
      "auth": {
        "kind": "none",
        "secret_ref": "string",
        "header": "Authorization",
        "prefix": "Bearer "
      },
      "model": "string",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string"
    }