查询生成写真图片任务

最近更新时间:2025-04-29 01:07:47

我的收藏

1. 接口描述

接口请求域名: aiart.tencentcloudapi.com 。

AI 写真分为上传训练图片、训练写真模型(可选跳过)、生成写真图片3个环节,需要依次调用对应接口。
生成图片分为提交任务和查询任务2个接口:

  • 提交生成写真图片任务:选择风格模板,提交一个生成写真图片异步任务,根据写真模型 ID 生成写真图片,获得任务 ID。
  • 查询生成写真图片任务:根据任务 ID 查询生成图片任务的处理状态、处理结果。

每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryDrawPortraitJob。
Version String 公共参数,本接口取值:2022-12-29。
Region String 公共参数,详见产品支持的 地域列表
JobId String 查询生成写真图片任务 ID。
示例值:d33c2c966ae1476a5fae5e76

3. 输出参数

参数名称 类型 描述
JobStatusCode String 任务状态码。
INIT: 初始化、WAIT:等待中、RUN:运行中、FAIL:处理失败、DONE:处理完成。
示例值:DONE
JobStatusMsg String 任务状态信息。
示例值:处理完成
JobErrorCode String 任务错误码。
示例值:InternalError.EngineError
JobErrorMsg String 任务错误信息。
示例值:算法服务异常。
ResultUrls Array of String 结果 URL 数组。
URL 有效期1小时,请及时保存。
示例值:["https://aiart-portrait-xxx.cos.ap-guangzhou.myqcloud.com/xxx?q-sign-algorithm=sha1&q-ak=xxx&q-sign-time=1731996860;1732000460&q-key-time=1731996860;1732000460&q-header-list=host&q-url-param-list=&q-signature=2a86d7f0c5482e10d6867ddea14d9e3973201e95"]
ResultDetails Array of String 结果描述数组。
示例值:["SUCCESS"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

成功请求

输入示例

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

{
    "JobId": "d33c2c966ae1476a5fae5e76"
}

输出示例

{
    "Response": {
        "JobErrorCode": "",
        "JobErrorMsg": "",
        "JobStatusCode": "DONE",
        "JobStatusMsg": "处理完成",
        "RequestId": "9202070d-02bd-4848-bf54-568a2597e400",
        "ResultDetails": [
            "SUCCESS"
        ],
        "ResultUrls": [
            "https://aiart-portrait-xxx.cos.ap-guangzhou.myqcloud.com/xxx?q-sign-algorithm=sha1&q-ak=xxx&q-sign-time=1731996860;1732000460&q-key-time=1731996860;1732000460&q-header-list=host&q-url-param-list=&q-signature=2a86d7f0c5482e10d6867ddea14d9e3973201e95"
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.JobNotExist 任务不存在。
FailedOperation.ServerError 服务内部错误。