tencent cloud

APIs

ListAIWorkbenchMessages

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-09-02 14:54:02

1. API Description

Domain name for API request: monitor.intl.tencentcloudapi.com.

This API is used to query message list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ListAIWorkbenchMessages.
Version Yes String Common Params. The value used for this API: 2023-06-16.
Region No String Common Params. This parameter is not required for this API.
SessionId No String

Conversation ID

Cursor No String

Tag for cursor pagination

Limit No Integer

Window size

Direction No String

Pull sequence

3. Output Parameters

Parameter Name Type Description
Messages Array of MessageInfo

Message list.

NextCursor String

Next cursor

HasMore Boolean

Is there a follow-up?

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Retrieve Historical Sessions in Sequence

Input Example

POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAIWorkbenchMessages
<Common request parameters>

{
    "SessionId": "ses-************",
    "Cursor": "ent-************"
}

Output Example

{
    "Response": {
        "HasMore": false,
        "Messages": [
            {
"Content": "According to the query results, there are no alarm history records for CVMs in the last three days (October 18, 2023 to October 20, 2023). This could imply:\n\n1. **The system runs normally**: No alarms were triggered for CVMs during this period.\n2. **Alarm policy not configured**: No relevant alarm policy may be set, resulting in no exceptions captured.\n3. **Data latency or not reported**: Alarm data may be delayed or not reported in time.\n\nIf necessary, check the alarm policy configuration or expand the time range and query again."
                "ContentBlocks": [
                    {
                        "Data": "{\"messageId\":\"ent-v05jrikcax7p\",\"role\":\"assistant\",\"timestamp\":1775800599000,\"type\":\"TEXT_MESSAGE_START\"}",
                        "Type": "TEXT_MESSAGE_START"
                    }
                ],
                "CreatedAt": 1775800599,
                "EntryId": "ent-v05jrikcax7p",
                "Role": "assistant",
                "RunId": "run-rkiun5jss4vq",
                "SessionId": "ses-ddgf8e7ne7ak",
                "Status": "completed"
            }
        ],
        "NextCursor": "ent-************",
        "RequestId": "0c3f9c3a-fac9-40b9-8249-79eb32271c4a"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
UnauthorizedOperation Unauthorized operation.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック