CreateModel - Platform For AI - Alibaba Cloud Documentation Center

Creates a model, which is a collection of model versions. You must specify information such as the model name and description.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paimodel:CreateModel

create

*All Resource

*

None

Request syntax

POST /api/v1/models HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
ModelName	string	Yes	The name of the model. The name must be 1 to 127 characters in length.	新闻分类
Labels	array	No	A list of labels. This parameter is deprecated and is replaced by the Tag parameter.
	Label	No	A label.
Tag	array	No	A list of tags.
	Label	No	A tag. This is the same as a label.
ModelDescription	string	No	The description of the model. Use this to distinguish different models.	新闻分类。
WorkspaceId	string	No	The ID of the workspace. For more information about how to obtain a workspace ID, see ListWorkspaces.	796**
Accessibility	string	No	The visibility of the model in the workspace. Valid values: PRIVATE (default): The model is visible only to you and administrators in the workspace. PUBLIC: The model is visible to everyone in the workspace. Valid values: PUBLIC : PUBLIC PRIVATE : PRIVATE	PRIVATE
Origin	string	No	The source of the model. This specifies the community or organization that the source model belongs to, such as ModelScope and HuggingFace.	ModelScope
Domain	string	No	The domain. This describes the field that the model is designed for, such as nlp (Natural Language Processing) or cv (computer vision).	nlp
Task	string	No	The task. This describes the specific problem that the model solves, such as text-classification (text classification).	text-classification
ModelDoc	string	No	The model documentation.	https://*.md
OrderNumber	integer	No	The ordinal number of the model. You can use this for custom sorting.	0
ModelType	string	No	The model type, such as Checkpoint or LoRA.	Checkpoint
ExtraInfo	object	No	Other information about the model.	{ "RatingCount": 2866, "Rating": 4.94, "FavoriteCount": 34992, "CommentCount": 754, "CoverUris": ["https://e*u.oss-cn-hangzhou.aliyuncs.com/drea*w.png"], "TippedAmountCount": 32, "DownloadCount": 606056 }
ParameterSize	integer	No	The number of parameters, in millions.	3000

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	9DAD3112-AE22-5563-9A02-5C7E8****E35
ModelId	string	The model ID.	model-rbvg5wzljz****ks92

Examples

Success response

JSON format

{
  "RequestId": "9DAD3112-AE22-5563-9A02-5C7E8****E35",
  "ModelId": "model-rbvg5wzljz****ks92"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.