查询普通会话一页中的置顶项¶
按当前用户、来源和筛选条件读取会话记录。
POST https://api.moi.matrixorigin.cn/v5/sessions/pinned/list
调用前准备¶
BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。
配置同环境的身份、工作区和数值记录 ID。该入口采用普通产品身份认证,附加的任务运行期授权头会被拒绝。
请求¶
curl --request POST \
"$BASE_URL/sessions/pinned/list" \
--header "X-API-Key: $MOI_KEY" \
--header "X-Workspace-ID: $WORKSPACE_ID" \
--header "Content-Type: application/json" \
--data-raw '{"page":1,"page_size":20,"source":"moi"}'
根据普通列表的总数确认还存在下一普通页时,再读取对应页:
curl --request POST \
"$BASE_URL/sessions/pinned/list" \
--header "X-API-Key: $MOI_KEY" \
--header "X-Workspace-ID: $WORKSPACE_ID" \
--header "Content-Type: application/json" \
--data-raw '{"page":2,"page_size":20,"source":"moi"}'
参数 |
位置 |
类型 |
必填 |
说明 |
|---|---|---|---|---|
|
请求头 |
string |
是 |
目标工作区 ID。 |
|
请求体 |
integer |
否 |
读取的普通会话页码;省略或非正值实际按 1。 |
|
请求体 |
integer |
否 |
实际页大小默认 20;普通和置顶底页超过 100 时按 20。 |
|
请求体 |
string |
否 |
应用来源精确筛选;空值按 moi,不去掉非空值的前后空白。 |
|
请求体 |
string |
否 |
标题关键词筛选;按提交的字符串匹配。 |
|
请求体 |
string |
否 |
一个标签名称筛选,不是数组,也不同时按标签 source 筛选。 |
先读取普通会话的指定页,再从这一页筛选 system/pinned,保留普通页顺序。这不是对全部置顶会话直接分页。响应没有 total/page/page_size;空页不能作为结束依据。需要完整清单时遍历普通会话页,按对应普通列表的总数确定页范围,再检查每页置顶项。标签关系读取失败也可能返回空 sessions,不能据此证明没有置顶会话。
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"sessions": [
{
"id": 41,
"title": "临时会话",
"source": "moi",
"user_id": "user-example",
"config": "{}",
"tags": [],
"created_at": 1794445200,
"updated_at": 1794445200
}
]
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功为 OK;HTTP 状态码为 200。 |
|
string |
成功为 OK。 |
|
array(对象数组) |
普通指定页中的置顶会话;没有 total/page/page_size。 |
错误响应¶
错误格式和结果确认区分会话详情的 not-found 与其他入口的通用服务错误。