ModelRouterQueryConversationList

更新时间:
复制 MD 格式

Conversation management/Conversation list

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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 ASC (ascending) and DESC (descending).

DESC

groupBy

string

No

The grouping field.

resourceId

needTotalCount

boolean

No

Specifies whether to return the total count of items. Set to true to return the total count.

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 indicates success.

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.