tencent cloud

Tencent Cloud Observability Platform

DocumentationTencent Cloud Observability PlatformAPI DocumentationAI Workbench APIsListAIWorkbenchArtifacts

ListAIWorkbenchArtifacts

Download
Focus Mode
Font Size
Last updated: 2026-09-02 14:51:55

1. API Description

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

Query the product 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: ListAIWorkbenchArtifacts.
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.
PerPage No Integer

Number of items per page
PageNo No Integer

Page number.
SessionIds.N No Array of String

Session ID.
MimeTypes.N No Array of String

Message content type
OrderDirection No String

Sorting order

Enumeration values:

  • ASC: ascending order
  • DESC: descending order

3. Output Parameters

Parameter Name Type Description
Artifacts Array of ArtifactInfo

Product list
PageResult PageByNumResult

Pagination result.
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 Modifying Alarm Notification Settings

Input Example

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

{
    "PerPage": 10,
    "PageNo": 1,
    "SessionIds": [
        "ses-************"
    ]
}

Output Example

{
    "Response": {
        "Artifacts": [
            {
                "AgentId": "agt-fl41a45q",
                "ArtifactId": "a3ad713a514a00056779f487fb1b51b2",
                "CreatedAt": 0,
                "IsGlobal": false,
                "MimeType": "application/json",
                "Name": "custom_rules.json",
                "SizeBytes": 646,
                "SkillId": "skl-183na51w",
                "StoragePath": "sandbox_file://ses-gqohe600bjp2/custom_rules.json",
                "UpdatedAt": 0
            }
        ],
        "PageResult": {
            "CurrentPageNo": 1,
            "TotalCount": 3,
            "TotalPage": 1
        },
        "RequestId": "b3bd2b5f-c268-46ea-8644-a37add135bba"
    }
}

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.
Previous Topic: ListAIWorkbenchAgentsNext Topic: ListAIWorkbenchExecutions

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback