You need to enable JavaScript to run this app.
导航
中国红
最近更新时间:2024.09.04 19:31:21首次发布时间:2024.07.26 16:58:05

接口简介

本文档介绍AIGC图片风格转化的能力接入说明,这项技术能够将输入的人像图片转换成中国红风格的输出作品。

限制条件

名称

内容

图片要求

  1. 图片格式:JPG,JPEG, PNG. 其他暂不支持.
  2. 图片大小:5MB以下,256*256以上的人脸图像高清不模糊图片

Demo展示

中国红
图片

请求说明

名称

内容

接口地址

https://visual.volcengineapi.com

请求方式

POST

Content-Type

application/json

请求参数
(1)header请求参数
公共请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数,完整公共参数列表见 公共参数

名称

类型

是否必填

描述

X-Date

String

使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256:签名方法
-Credential为签名凭证,其中:
-AccessKeyId为访问密钥ID,可在 访问密钥(Access Key) 获取;
-ShortDate为请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
-Region为请求地区,国内一般为为cn-north-1
-Service为请求的服务,一般为cv
-SignedHeaders为参与签名计算的头部信息,content-typehost 为必选头部;
-Signature为签名,可在 签名方法 获取。
注:我们提供了SDK及签名示例供您实现服务快速接入,具体可参考 快速接入
例如:HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-Token

String

指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

(2)Query参数
业务请求参数

参数

可选/必选

类型

说明

Action

必选

String

接口名,取值:CVProcess

Version

必选

String

版本号,取值:2022-08-31

(3)Body参数
业务请求参数

参数

可选/必选

类型

说明

req_key

必选

String

算法名称,取固定值为img2img_chinese_style

binary_data_base64

必选
(与image_urls二选一)

array of String

输入图片的base64数组,仅支持一张图

image_urls

必选
(与binary_data_base64二选一)

array of String

输入图片的url数组,仅支持一张图

return_url

可选

bool

如果为true,则输出参数不再返回binary_data_base64,而是图片的url

logo_info

可选

LogoInfo

水印信息

LogoInfo
水印相关信息。

名称

类型

必选

描述

备注

add_logo

Boolean

是否添加水印。True为添加,False不添加。默认不添加

position

Int

水印的位置,取值如下:
0-右下角
1-左下角
2-左上角
3-右上角
默认0

language

Int

水印的语言,取值如下:
0-中文(AI生成)
1-英文(Generated by AI)
默认0

opacity

Float

水印的不透明度,取值范围0-1,1表示完全不透明,默认0.3

(4)请求示例

{
    "req_key": "img2img_chinese_style",
    "image_urls": [
        "https://xxx
            ],
    // "binary_data_base64":[],
    "return_url": true,
    "logo_info": {
        "add_logo": true,  
        "position": 2, 
        "language": 0, 
        "opacity": 1.0 
    }
}

输出说明

(1)通用输出参数
请参考通用返回字段及错误码
(2)业务输出参数
data 字段说明

字段

类型

说明

binary_data_base64

array of string

返回图片的base64数组。

image_urls

array of string

输出处理过的图片url
数组(单张图)

(3)输出示例

{
    "code": 10000,
    "data": {
        "SaveImage_9": [
            "uri://binary_data?index=0"
        ],
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": [],
        "comfyui_cost": 4,
        "image_urls": [
            "https://xxx
                    ]
    },
    "message": "Success",
    "request_id": "202408231414247DE79CDFD890CDC9AEA8",
    "status": 10000,
    "time_elapsed": "6.449622164s"
}

错误码

(1)通用错误码
请参考通用返回字段及错误码
(2)业务错误码

HttpCode

错误码

错误消息

描述

200

10000

请求成功