查看标签列表¶
分页查看当前工作区的用户标签,用于为用户选择、更新或移除标签。
POST https://api.moi.matrixorigin.cn/v5/user/tag/list
调用前准备¶
请求参数¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/user/tag/list" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"page": 1,
"page_size": 20
}'
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
page |
integer |
否 |
页码,从 1 开始;省略时为第 1 页。 |
page_size |
integer |
否 |
每页数量,默认 20,最大 100。 |
读取下一页时将 page 加 1,并保持 page_size 不变。累计读取数量达到响应中的 data.total,或当前页 data.tag_list 为空时停止。当前服务不会应用请求结构中兼容保留的排序和筛选字段。
成功响应¶
成功时返回标签总数和当前页的标签。
{
"code": "OK",
"msg": "OK",
"data": {
"total": 1,
"tag_list": [
{
"id": 12,
"name": "finance",
"description": "财务团队"
}
]
}
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
成功时为 OK。 |
msg |
string |
成功时为 OK。 |
data.total |
integer |
当前工作区的标签总数。 |
data.tag_list |
array of object |
当前页的标签。 |
data.tag_list[].id |
integer |
标签 ID。 |
data.tag_list[].name |
string |
标签名称。 |
data.tag_list[].description |
string |
标签说明。 |
错误响应¶
{
"code": "INVALID_ARGUMENT",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
错误代码。 |
msg |
string |
错误信息。 |
data |
null |
— |
后续操作¶
选择用户标签¶
选择要更新、删除或关联给用户的标签。继续读取时,使用上一页返回的游标。
最后更新于