1. 接口描述

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

智能文生图接口将根据输入的描述文本,智能生成与之相关的结果图。输入:256个字符以内的描述性文本,推荐使用中文。输出:对应风格及分辨率的 AI 生成图。可支持的风格详见 智能文生图风格列表,请将列表中的“风格编号”传入 Styles 数组,建议选择一种风格。

请求频率限制为1次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述 Action 是 String 公共参数,本接口取值:TextToImage。 Version 是 String 公共参数,本接口取值:2022-12-29。 Region 是 String 公共参数,详见产品支持的 地域列表。 Prompt 是 String 文本描述。算法将根据输入的文本智能生成与之相关的图像。建议详细描述画面主体、细节、场景等,文本描述越丰富,生成效果越精美。不能为空,推荐使用中文。最多可传256个 utf-8 字符。示例值:雨中, 竹林, 小路 NegativePrompt 否 String 反向文本描述。用于一定程度上从反面引导模型生成的走向,减少生成结果中出现描述内容的可能,但不能完全杜绝。推荐使用中文。最多可传256个 utf-8 字符。 Styles.N 否 Array of String 绘画风格。请在 智能文生图风格列表 中选择期望的风格,传入风格编号。推荐使用且只使用一种风格。不传默认使用201(日系动漫风格)。 ResultConfig 否 ResultConfig 生成图结果的配置,包括输出图片分辨率和尺寸等。支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3)、1080:1920(9:16)、1920:1080(16:9),不传默认使用768:768。 LogoAdd 否 Integer 为生成结果图添加标识的开关,默认为1。1:添加标识。0:不添加标识。其他数值:默认按1处理。建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。 LogoParam 否 LogoParam 标识内容设置。默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 RspImgType 否 String 返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。示例值:base64

3. 输出参数

参数名称 类型 描述 ResultImage String 根据入参 RspImgType 填入不同,返回不同的内容。如果传入 base64 则返回生成图 Base64 编码。如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。 RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用示例

正常调用场景

输入示例

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

{
    "Prompt": "女孩",
    "Styles": [
        "101"
    ]
}

输出示例

{
    "Response": {
        "ResultImage": "/ashadaisojdad",
        "RequestId": "b429894a-d0e5-4d5c-8dcf-6be8d05ef484"
    }
}

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. 错误码

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

错误码 描述 AuthFailure.UnauthorizedOperation 无权执行该操作,请检查您的CAM策略,确保您拥有对应的CAM权限。 FailedOperation.ConsoleServerError 控制台服务异常。 FailedOperation.GenerateImageFailed 生成图片审核不通过,请重试。 FailedOperation.ImageDecodeFailed 图片解码失败。 FailedOperation.ImageDownloadError 图片下载错误。 FailedOperation.InnerError 服务内部错误,请稍后重试。 FailedOperation.RequestEntityTooLarge 整个请求体太大(通常主要是图片)。 FailedOperation.RequestTimeout 后端服务超时。 FailedOperation.RpcFail RPC请求失败,一般为算法微服务故障。 FailedOperation.ServerError 服务内部错误。 FailedOperation.Unknown 未知错误。 InvalidParameter.InvalidParameter 参数不合法。 InvalidParameterValue.ImageEmpty 图片为空。 InvalidParameterValue.ParameterValueError 参数字段或者值有误 InvalidParameterValue.TextLengthExceed 输入文本过长,请更换短一点的文本后重试。 InvalidParameterValue.UrlIllegal URL格式不合法。 OperationDenied.ImageIllegalDetected 图片包含违法违规信息,审核不通过。 OperationDenied.TextIllegalDetected 文本包含违法违规信息,审核不通过。 RequestLimitExceeded 请求的次数超过了频率限制。 RequestLimitExceeded.JobNumExceed 同时处理的任务数过多,请稍后重试。 ResourceUnavailable.InArrears 账号已欠费。 ResourceUnavailable.LowBalance 余额不足。 ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。 ResourceUnavailable.StopUsing 账号已停服。 ResourcesSoldOut.ChargeStatusException 计费状态异常。