Create a new model

post

https://api.instill-ai.com/v1alpha/namespaces/{namespaceId}/models

Creates a new model under the parenthood of a namespace. This is an
asynchronous endpoint, i.e., the server will not wait for the model to be
created in order to respond. Instead, it will return a response with the
necessary information to access the result and status of the creation
operation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

namespaceId

string

required

Namespace ID

Body Params

The properties of the model to be created.

string

required

Model resource ID (used in name as the last segment). This conforms to
RFC-1034, which restricts to letters, numbers, and hyphen, with the first
character a letter, the last a letter or a number, and a 63 character
maximum.

description

string

Model description.

modelDefinition

string

required

The model definition that has been used to import the model.

configuration

object

required

Model configuration. This field is validated against the model
specification in the model definition (i.e. the model_spec field in the
model definition).

task

string

enum

required

Model task.

visibility

string

enum

required

Model visibility.

Allowed:

region

string

required

Region of choice for the particular provider to host the model.

hardware

string

required

Hardware of choice to serve the model.

readme

string

README holds the model documentation.

sourceUrl

string

A link to the source code of the model (e.g. to a GitHub repository).

documentationUrl

string

A link to any extra information.

license

string

License under which the model is distributed.

profileImage

string

Model profile image in base64 format.

Responses

200A successful response.

401Returned when the client credentials are not valid.

defaultAn unexpected error response.