AddCategory

Creates a category in a specified workspace to classify and manage files. Each workspace supports a maximum of 500 categories.

Operation description

• You cannot use an API to add data tables. To add data tables, go to the Application Data page in the console.

• A RAM user must obtain the required API permissions for Alibaba Cloud Model Studio and join a workspace before calling this operation. The AliyunBailianDataFullAccess permission, which includes the sfm:AddCategory permission, is required. An Alibaba Cloud account can call this operation directly without requiring authorization. To call this operation, use the latest version of the Alibaba Cloud Model Studio SDK.

• This operation is not idempotent.

Rate limiting: Frequent calls to this operation are subject to rate limiting. Do not exceed a frequency of 5 calls per second. If rate limiting is triggered, try again later.

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
sfm:AddCategory	create	*All Resource*	None	None

Request syntax

HELPCODEESCAPE-plaintext
POST /{WorkspaceId}/datacenter/category/ HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace where you want to create the category. For more information about how to obtain a workspace ID, see Work with workspaces.	llm-3z7uw7fwz0vxxxx

Request parameters

Parameter	Type	Required	Description	Example
CategoryName	string	Yes	The name of the category. The name must be 1 to 20 characters long. It can contain Unicode letters, such as English letters and Chinese characters, along with digits, colons (😃, underscores (_), periods (.), and hyphens (-).	Product list
CategoryType	string	Yes	The type of the category. Valid value: - UNSTRUCTURED: A category.	UNSTRUCTURED
ParentCategoryId	string	No	The ID of the parent category under which the new category is created. If you leave this parameter empty, a top-level category is created.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
ConnectorId	string	No	The ID of the connector instance. You can obtain the ID from the Alibaba Cloud Model Studio console.	conn_xxxx

Response elements

Element	Type	Description	Example
	object	The response object.
Code	string	The error code.	success
Data	object	The data returned.
CategoryId	string	The ID of the category. Save this ID for future API calls that use this category.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CategoryName	string	The name of the category.	Category name
Message	string	The error message.	Requests throttling triggered.
RequestId	string	The ID of the request.	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Status	string	The HTTP status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: - true: The request was successful. - false: The request failed.	true

Examples

Success response

JSON format

HELPCODEESCAPE-json
{
  "Code": "success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CategoryName": "Category name"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.