Create Category

Prerequisites

You have an Alibaba Cloud Model Studio API key (see the API Key page in the console) and authentication configured. For details, see RAG API overview and Authentication. Data import endpoints use the same base URL and authentication as other RAG APIs, with the path prefix /api/v1/connector/dash/.

Endpoint

POST /api/v1/connector/dash/addCategory Create a category in the current Workspace to organize data files.

Request body

Field	Required	Type	Description
`categoryName`	Yes	string	Category name, 1 to 20 characters.
`categoryType`	Yes	string	Category type. Only `UNSTRUCTURED` is supported.
`parentCategoryId`	No	string	Parent category ID. Set this to create a child category.
`connectorId`	No	string	Connector ID. Associates the category with a specific connector.

Request example

curl -X POST "$BASE_URL/api/v1/connector/dash/addCategory" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryName": "产品文档",
    "categoryType": "UNSTRUCTURED"
  }'

BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com ({workspace_id} is the Workspace ID), and BAILIAN_API_KEY is your Alibaba Cloud Model Studio API key.

Response example

Returns 200 on success.

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "categoryId": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
    "categoryName": "_tmp_example"
  },
  "status": 200
}

Response fields

Field	Type	Description
`code`	string	Response code. `Success` on success.
`message`	string	Error or informational message; an empty string on success.
`requestId`	string	Unique request identifier. Include this ID when reporting an issue.
`data`	object	Creation result. Sub-fields: `categoryId` (string, ID of the new category), `categoryName` (string, category name).
`status`	integer	Business status code. `200` on success, `400` for failures such as invalid parameters. Note that the HTTP status code remains 200 even on failure, so rely on this field and `code` to determine the result.

Error codes

HTTP status code	Error code `code`	Description
400	`InvalidParameter`	Invalid request parameters. Example `message`: `Required parameter missing or invalid.`
401	`InvalidApiKey`	Authentication failed; the API key is invalid or missing. Example `message`: `Invalid API-key provided.`

On business failures the HTTP status code remains 200. Check status and code in the response body to determine the result.

​Prerequisites

​Endpoint

​Request body

​Request example

​Response example

​Response fields

​Error codes