创建证件照制作任务

POST

/api/tasks/visual/idphoto

创建证件照制作任务

图片大小: 不超过 15 MB
图片来源：文件上传（二进制）或从 URL 下载

请求参数

Authorization

Header 参数

X-API-KEY

string

必需

Body 参数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字符串形式返回图片。

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

status

integer

必需

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

message

string

必需

data

object

必需

task_id

string

必需

示例

{
  "status": 200,
  "message": "ok",
  "data": {
    "task_id": "94806a3f-1173-4afb-9bcc-3ff19c0981f4"
  }
}

修改于 2024-12-24 14:11:30

获取背景生成结果

获取证件照制作结果