高性能应用服务 HAI 获取Prompt任务列表-模型统一服务套件相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： hai.tencentcloudapi.com 。

获取prompt任务列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMuskPrompts。
Version	是	String	公共参数，本接口取值：2023-08-12。
Region	否	String	公共参数，本接口不需要传递此参数。
WorkgroupId	是	String	workgroup id 示例值：4a3f3be9-f35b-40bf-b6bb-2af812dd63cb
WorkflowId	是	String	workflow id 示例值：wf-b9dbb48a-f4cd-40f3-9a68-2af4c78d31a7
Offset	是	Integer	offset 示例值：0
Limit	是	Integer	limit 示例值：20
Filters.N	否	Array of Filter	过滤参数支持过滤的键值： PromptId，Status 示例值：[{"Name":"PromptId", Values:["dhfhds-dhdhd-xxdfdf-iejmrhf"]}]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	total count 示例值：1
MuskPromptInfos	Array of MuskPromptInfo	prompt列表详情
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取prompt任务详情

获取prompt任务详情

输入示例

POST / HTTP/1.1
Host: hai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMuskPrompts
<公共请求参数>

{
    "WorkgroupId": "4a3f3be9-f35b-40bf-b6bb-2af812dd63cb",
    "WorkflowId": "wf-b9dbb48a-f4cd-40f3-9a68-2af4c78d31a7",
    "Offset": 0,
    "Limit": 20
}

输出示例

{
    "Response": {
        "MuskPromptInfos": [
            {
                "CreateTime": "2024-12-24 12:07:22",
                "OutputResource": [],
                "PromptId": "edc6e6ec-072c-41dd-8672-c956b739fd31",
                "Status": 2,
                "UpdateTime": "2024-12-24 12:09:22",
                "WorkflowId": "wf-b9dbb48a-f4cd-40f3-9a68-2af4c78d31a7",
                "WorkgroupId": "4a3f3be9-f35b-40bf-b6bb-2af812dd63cb"
            }
        ],
        "RequestId": "a8a7930a-b642-4a3e-a3df-2d4a6bd389cc",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。

获取Prompt任务列表

本页目录：