Skip to main content
POST
创建证件照制作任务

请求头

X-API-KEY
string
必填

请求体

multipart/form-data
image_file
string

源图像文件(二进制)。(如果此参数存在,则其他图像源参数必须为空)

示例:

""

image_url
string

源图像URL。(如果存在此参数,则其他图像源参数必须为空)

示例:

""

sync
integer

是否等待结果就绪并立即返回(默认值:0)。如果设为1,API将会等待结果准备好后立即返回。如果设为0,API将返回 task_id,稍后可通过 /{task_id} 端点获取结果。请注意,请求提交后,结果最多只会保留1个小时。

示例:

""

size
string

证件照尺寸。默认为原图尺寸。 格式:{width}x{height},例如:300x400。(中间分隔符为小写字母x) 像素区间值需在100~2000之间

示例:

""

format
string

处理后的输出格式。默认值:png。 png = 以透明背景的png格式返回图片。 jpg = 以白色背景的jpg格式返回图片。

示例:

""

bg_color
string

添加纯色背景。此参数仅在格式设置为jpg时生效。如果未提供,JPG的默认背景颜色为白色。

格式:RRGGBB,例如:FFFFFF。

示例:

""

return_type
integer

1 = 返回图片的下载URL。 2 =以base64字符串形式返回图片。

示例:

""

响应

200 - application/json

请求成功

status
integer
必填

200 任务创建成功。 400 客户端参数传递错误。 请检查参数是否缺失或值是否正确 401 认证失败。 请检查X-API-KEY是否正确或者服务是否开通 429 请求频率超出QPS限制(默认QPS为2)。请放缓请求速率,或者联系商务提升QPS限制

message
string
必填
data
object
必填