创建标签¶
创建一个工作区用户标签。创建后可将该标签关联到工作区用户。
POST https://api.moi.matrixorigin.cn/v5/user/tag/create
调用前准备¶
请求参数¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/user/tag/create" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"name": "example",
"description": "示例标签"
}'
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
name |
string |
是 |
标签名称。 |
description |
string |
否 |
标签说明,最长 500 个字符。 |
标签名称不能为空,最长 200 个字符;不能包含空格、制表符、反引号或引号,不能以 { 开头或以 } 结尾。
成功响应¶
成功时返回新标签的 ID。
{
"code": "OK",
"msg": "OK",
"data": {
"id": 12
}
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
成功时为 OK。 |
msg |
string |
成功时为 OK。 |
data.id |
integer |
新标签 ID。 |
错误响应¶
{
"code": "INVALID_ARGUMENT",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
错误代码。 |
msg |
string |
错误信息。 |
data |
null |
— |
最后更新于