AI作画-iRAG版
更新时间：2025-02-17
接口描述
AI 作画-iRAG版，即检索增强的文生图技术，是百度将亿级图片资源与强大基础模型能力相结合的创新成果，根据用户输入的文本，自动创作图片。AI 作画-iRAG版涉及2个接口，分别为：提交请求、查询结果。
- 提交请求：支持传入文本、分辨率、参考图等参数，创建 AI 作画任务，获得任务ID。
- 查询结果：用于在任务创建后，查看图片生成状态。待图片生成完毕，通过查询接口即可查看生成图片的地址链接。
- 并发概念：并发数指 AI 作画-iRAG服务同时能处理的图片数量。上一个任务执行完，该任务占用的并发数才会释放。
- 并发数：付费使用后AI作画-iRAG版图片生成处理过程并发提升为2。
- 邀测阶段：当前接口处于邀测阶段，如有测试需求，请联系您的商务经理或提交工单申请。
提交请求-接口说明
在线调试
您可以在 示例代码中心 中调试该接口，可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求示例
HTTP方法: POST
请求URL: https://aip.baidubce.com/rpc/2.0/wenxin/v1/irag/textToImage
URL参数：
| 参数 | 值 |
|---|---|
| access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
请求参数
POST 方式调用
注意：要求使用 JSON 格式的结构体来描述一个请求的具体内容。
| 参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
| prompt | 是 | string | 生图的文本描述。支持中文、英文、日常标点符号（~！@#$%&()-+[];:'',./）。不支持特殊符号，限制 200 字。支持在prompt中输入画面比例信息，宽高比的范围在0.5-2之间，例如1：1、1：2、2：1、3：4、4：3、9：16、16：9等常见比例都可以支持，您也可以根据您的需求生成相应比例的图片，最终生成的图片比例以prompt中的描述为准，如prompt中没有比例描述，则默认生成1024*1024尺寸的图片 |
| image | 否，和url 二选一 | string | 参考图，需 base64 编码，大小不超过 10M，最短边至少 15px，最长边最大 8192px，支持jpg/jpeg/png/bmp 格式。优先级：image > url，当image 字段存在时，url 字段失效 |
| url | 否，和image 二选一 | string | 参考图完整 url，url 长度不超过 1024 字节，url 对应的图片需 base64 编码，大小不超过 10M，最短边至少 15px，最长边最大8192px，支持 jpg/jpeg/png/bmp 格式。优先级：image > url，当image 字段存在时，url 字段失效请注意关闭 URL 防盗链 |
| text_content | 否 | string | 1~50个字符，支持英文、数字及常用特殊字符。若不传该参数则默认为Text-to-Image-内容ID-AI，示例：Text-to-Image-131870381_0_finaI.png-Al；若传该参数，则相应水印内容自动添加至Text-to-Image后方，示例：Text-to-Image-ABCD-131870381_0_finaI.png-Al |
| task_time_out | 否 | integer | 仅支持数字，自定义超时时间（单位：s）：10, 30, 60, 90, 120, 300, 600, 900 |
请求示例
{
"prompt": "睡莲，9：16",
"image": ""（base64 编码）
}返回说明
JSON 格式
注意：若输入为 UTF-8 编码（通过指定 charset 参数），则返回内容为 UTF-8 编码
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| log_id | long | 请求唯一标识码 |
| data | object | 返回数据 |
| primary_task_id | long | 生成图片任务long类型 id，与“task_id”参数输出相同，该 id 可用于查询任务状态 |
| task_id | string | 生成图片任务string类型 id，与“primary_task_id”参数输出相同，该 id 可用于查询任务状态 |
| error_msg | string | 错误提示信息，失败才返回，成功不返回 |
| error_detail | object[] | 提示词和参考图审核不通过原因明细，审核失败才返回，审核成功不返回 |
| ├─msg | string | 不合规项描述信息 |
| ├─words | object[] | 送检文本命中词库的关键词 |
| error_code | number | 错误提示码，失败才返回，成功不返回 |
返回示例
{
"data": {
"primary_task_id": 1890339261514736232,
"task_id": "1890339261514736232"
},
"log_id": 1856529633358417546
}查询结果-接口说明
在线调试
您可以在 示例代码中心 中调试该接口，可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求示例
HTTP方法: POST
请求URL: https://aip.baidubce.com/rpc/2.0/wenxin/v1/irag/getImg
URL参数：
| 参数 | 值 |
|---|---|
| access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
并发数：付费后默认并发数为 2
请求格式
POST 方式调用
注意：要求使用 JSON 格式的结构体来描述一个请求的具体内容。
请求参数
| 参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
| task_id | 是 | long或string | 从提交请求的提交接口的返回值中获取，可使用task_id 查询总任务 |
请求示例1
{
"task_id": 1890339261514736232
}请求示例2
{
"task_id": “1890339261514736232”
}返回格式
JSON 格式
返回参数
| 参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
| log_id | 是 | long | 请求唯一标识码 |
| data | 是 | object | 返回数据 |
| ├─task_id | 是 | long | 任务 Id |
| ├─task_status | 是 | string | 计算总状态。有 INIT（初始化），WAIT（排队中）, RUNNING（生成中）, FAILED（失败）, SUCCESS（成功）四种状态，只有 SUCCESS 为成功状态 |
| ├─task_progress_detail | 是 | number | 图片生成总进度，0为未处理完，0-1之间的小数为生成进度， 1为处理完成 |
| ├─task_progress | 是 | number | 图片生成总进度，进度包含2种，0为未处理完，1为处理完成 |
| ├─sub_task_result_list | 是 | object[] | 子任务生成结果列表 |
| ├─sub_task_status | 是 | string | 单风格图片状态。有 INIT（初始化），WAIT（排队中）, RUNNING（生成中）, FAILED（失败）, SUCCESS（成功）四种状态，只有 SUCCESS 为成功状态 |
| ├─sub_task_progress_detail | 是 | number | 单任务图片生成进度，0为未处理完，0-1之间的小数为生成中， 1为处理完成 |
| ├─sub_task_progress | 是 | number | 单任务图片生成进度，进度包含2种，0为未处理完，1为处理完成 |
| ├─sub_task_error_code | 是 | string | 单风格任务错误码。0:正常；501:文本黄反拦截；201:模型生图失败 |
| ├─final_image_list | 是 | object [] | 单风格任务产出的最终图列表 |
| ├─img_url | 是 | string | 图片所在BOShttp地址，默认30天失效，在使用图片链接时需附带上authorization的鉴权信息，例如“http://bj.bcebos.com/v1/ai-picture-creation/watermark/294089418_0_final.png?authorization=bce-auth-v1/ALTAKBvI5HDpIAzJaklvFTUfAz/2024-11-13T02:49:08Z/2592000//4cd04290d81d23cd3a1f374181bcd9d33aa89d3875114df265e77eac44a75c26 ”，请使用完整的图片的链接 |
| ├─height | 是 | integer | 图片像素信息-高度 |
| ├─width | 是 | integer | 图片像素信息-宽度 |
| ├─img_approve_conclusion | 是 | string | 图片机审结果，"block"：输出图片违规；"review": 输出图片疑似违规；"pass": 输出图片未发现问题； |
计费规则：返回图片链接计费，因审核拦截等情况导致未返回图片链接不进行计费
返回示例
生成进度示例
{
"data": {
"task_progress_detail":0.975,
"task_status": "RUNNING",
"task_progress": 0,
"sub_task_result_list": [
{
"sub_task_progress_detail": 0.975,
"sub_task_error_code": 0,
"sub_task_status": "RUNNING",
"sub_task_progress": 0
}
],
"task_id": 1890339261514736232
},
"log_id": 1824362776382441905
}图片结果示例
{
"data": {
"task_progress_detail": 1,
"task_progress": 1,
"task_status": "SUCCESS",
"sub_task_result_list": [
{
"final_image_list": [
{
"width": 768,
"img_url": "http://bj.bcebos.com/v1/ai-picture-creation/watermark/9_2090299064_0_final.png?authorization=bce-auth-v1%2FALTAKBvI5HDpIAzJaklvFTUfAz%2F2025-02-14T09%3A57%3A02Z%2F2592000%2F%2F3a15ffe17ab7e7b0960c38ab0d4913f41f1428f664c09edf3ced5ffa504ade1d",
"img_approve_conclusion": "pass",
"height": 1360
}
],
"sub_task_progress_detail": 1,
"sub_task_progress": 1,
"sub_task_error_code": 0,
"sub_task_status": "SUCCESS"
}
],
"task_id": 1890339261514736232
},
"log_id": 1890341890063102156
}暗水印
- 水印包含内容：服务提供者名称（Text-to-Image）、内容ID（生成图片的唯一编号）、生成方式（AI）
- 水印面积：覆盖整张图，水印嵌入在频域。
- 水印提取：水印提取：当前提取水印需要百度侧使用技术手段提取，暂时没有对外开放。具体提取水印需要您把生成图片的bos链接或原图给到百度进行提取。
- 水印示例：
错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
| 282000 | internal error | 输入特殊表情字符或服务器内部错误，请调整输入文本再次请求， 如果持续出现此类错误，请在控制台提交工单联系技术支持团队 |
| 216303 | 任务超时，请重新尝试 | 当等待时间超过默认配置时间或者自定义超时时间，查询任务结果时报超时错误，默认超时时间为5分钟。若您按照默认并发2调用遇到了超时报错问题，可以增加多次重试逻辑以重新提交超时任务，或通过自定义超时时间进行灵活调整；若仍对您的业务造成较大影响，请通过客户经理或提交工单联系我们 |
| 282004 | 文本敏感信息拦截/图片敏感信息拦截 | 请求中包含敏感词、非法参数、字数超限，或上传违规参考图，请检查后重新尝试 |
| 282003 | miss required request parameter | 缺少必要参数 |
| 17 | online flow control | 日配额流量超限 |
| 18 | Open api qps request limit reached | QPS 超限额 |
| 501 | sub_task_error_code 参数返回 | 文本黄反拦截 |
| 201 | sub_task_error_code 参数返回 | 模型生图失败 |
| 216100 | invalid parameter 无效参数 | 参数不满足格式要求 |
| 216201 | image format error | 参考图不满足格式要求 |
| 216205 | input oversize | 参考图尺寸不满足要求 |
| 4 | 请求超限 | 错误信息为中文的“请求超限”指所有用户提交的 AI 作画总数超限制 |
| 13 | QPS 超限 | 错误信息为中文的“QPS 超限”指单个用户使用提交请求接口的 QPS 超限 |
| 15 | 并发超限 | 错误信息为中文的“并发超限”指单个用户使用 AI 作画的并发超限 |
| 17 | 用量超限 | 错误信息为中文的“用量超限”指单个用户使用 AI 作画的用量超限 |