List unpinned UI protocol sessions¶
Read session records for the current user, source, and filters.
POST https://api.moi.matrixorigin.cn/v5/sessions/unpinned/list
Before you call this API¶
Set BASE_URL to the product API prefix https://api.moi.matrixorigin.cn/v5. For private deployments, use the corresponding product API URL.
Configure identity, Workspace, and numeric record IDs in the same environment. This entry point uses ordinary product authentication and rejects additional task runtime authorization headers.
Request¶
curl --request POST \
"$BASE_URL/sessions/unpinned/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"}'
When page_size=20 is explicit and another page remains in the corresponding ordinary pagination range:
curl --request POST \
"$BASE_URL/sessions/unpinned/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"}'
Parameter |
Location |
Type |
Required |
Description |
|---|---|---|---|---|
|
Headers |
string |
Yes |
Target Workspace ID. |
|
Body |
integer |
No |
Ordinary session page number to read. Omitted/nonpositive values effectively become 1. |
|
Body |
integer |
No |
Nonpositive values effectively become 20. Unlike the ordinary list, this entry point does not normalize values above 100. |
|
Body |
string |
No |
Exact application source filter. Empty means moi; nonempty values are not trimmed. |
|
Body |
string |
No |
Title keyword filter, matched as submitted. |
|
Body |
string |
No |
One tag-name filter, not an array. Does not simultaneously filter tag source. |
Returned page/page_size are the original request values. They may be 0 or above the effective limit and are not guaranteed to reflect normalized pagination. Explicitly send valid page numbers/sizes, retain filters, and increment page for subsequent requests. Determine completion using ordinary-list total and effective page size. Unpinned lists exclude system/pinned relationships before pagination.
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {
"sessions": [
{
"id": 41,
"title": "临时会话",
"source": "moi",
"user_id": "user-example",
"config": "{}",
"tags": [],
"created_at": 1794445200,
"updated_at": 1794445200
}
],
"total": 1,
"page": 1,
"page_size": 20
}
}
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success; HTTP status is 200. |
|
string |
OK on success. |
|
array (objects) |
Session objects on this page. |
|
integer |
Total sessions matching current filters. |
|
integer |
Original requested page number; not necessarily normalized. |
|
integer |
Original requested page size; not necessarily effective. |
Error responses¶
Error formats and result confirmation distinguishes session-detail not-found from generic service errors at other entry points.