Conversation management/Conversation list
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
aicontent:ModelRouterQueryConversationList |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v1/modelRouter/open/conversations HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| pageSize |
integer |
No |
The number of items to return on each page. |
10 |
| pageIndex |
integer |
No |
The page number. |
1 |
| orderBy |
string |
No |
The sort field. |
resourceId |
| orderDirection |
string |
No |
The sort order. Valid values are |
DESC |
| groupBy |
string |
No |
The grouping field. |
resourceId |
| needTotalCount |
boolean |
No |
Specifies whether to return the total count of items. Set to |
true |
| maxResults |
integer |
No |
The maximum number of results to return. |
10 |
| keyword |
string |
No |
A keyword to filter the results. |
test |
| status |
integer |
No |
Filters the results by status. |
1 |
| nextToken |
string |
No |
The pagination token for the next page of results. To retrieve the first page, do not specify this parameter. |
2 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
A paginated response object that contains a list of conversations. |
{ "success": true, "data": { "total": 1, "page": 1, "pageSize": 10, "list": [{"id": 1, "title": "测试对话"}] }, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" } |
|
| requestId |
string |
The unique ID of the request. |
xxxx-xxxx-xxxx-xxxxxxxx |
| success |
boolean |
Indicates whether the request succeeded. A value of |
true |
| errCode |
string |
The error code returned if the request fails. |
UNKNOWN_ERROR |
| errMessage |
string |
The error message returned if the request fails. |
未知错误 |
| httpStatusCode |
integer |
The HTTP status code. |
200 |
| data |
object |
The response data. |
[] |
| list |
array |
A list of conversation objects. |
|
| ConversationDTO |
A conversation object. |
{ "gmt_create":"2026-03-19T18:13:30.777767+08:00", "id":124, "title":"hi", "gmt_modified":"2026-03-19T18:13:30.777767+08:00", "message_count":2, "model_ids":"[77]" }, |
|
| total |
integer |
The total number of conversations. |
100 |
| page |
integer |
The page number. |
1 |
| maxResult |
string |
The number of entries per page. Default value: 20. |
10 |
| nextToken |
string |
The token to retrieve the next page of results. If this parameter is empty, all results have been returned. |
None |
| pageSize |
integer |
The number of conversations on the current page. |
10 |
Examples
Success response
JSON format
{
"requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
"success": true,
"errCode": "UNKNOWN_ERROR",
"errMessage": "未知错误",
"httpStatusCode": 200,
"data": {
"list": [
{
"id": 1,
"title": "我的对话",
"messageCount": 10,
"modelIds": "[1,2,3]",
"chatData": "{}",
"deleteTag": 0,
"gmtCreate": "2024-01-01T00:00:00Z",
"gmtModified": "2024-01-01T00:00:00Z"
}
],
"total": 100,
"page": 1,
"maxResult": "10",
"nextToken": "None",
"pageSize": 10
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | Server.Internal.UnknownError | The request processing has failed due to some unknown error. | |
| 403 | B.Permission.DeniedException | 鉴权失败或权限不足 |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.