创建抠图任务

开发中

POST

/api/tasks/visual/segmentation

创建抠图任务
图片大小: 不超过 15 MB
图片来源：文件上传（二进制）或从 URL 下载
图片内容: 任何带有前景的照片（例如人物、产品、动物、汽车等）

请求参数

Header 参数

X-API-KEY

string

必需

示例值:

YOUR_API_KEY

Body 参数multipart/form-data

image_file

string

可选

源图像文件（二进制）。（如果此参数存在，则其他图像源参数必须为空）

image_url

string

可选

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

sync

integer

可选

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

type

string

可选

前景类型：
空 = 自动检测前景类型。
"person" = 使用人作为前景。
"object" = 使用物品作为前景。
"stamp" = 使用图章作为前景。

return_type

integer

可选

1 = 返回图片的下载URL。
2 = 以base64字符串形式返回图片。
3 = 以二进制流的形式返回图片（当前只支持同步接口）。

output_type

integer

可选

图片返回选项：
1 = 同时返回图片和蒙版。
2 = 只返回图片。（默认选项）
3 = 只返回蒙版。
图片是前景提取处理的结果，通常是彩色图片，而蒙版代表用于提取的黑白区域。

crop

integer

可选

是否裁剪至目标边缘:
0 = 返回原始图像大小。（默认选项）
1 = 裁剪至目标边缘。

format

string

可选

图片格式：
png = 透明图片（默认选项）。
jpg = 默认白色背景的非透明图片。您可以使用bg_color参数设置背景颜色。

bg_color

string

可选

添加纯色背景。此参数仅在格式设置为jpg时生效。可以为十六进制颜色代码（例如：81d4fa，ffffff）。如果未提供，JPG的默认背景颜色为白色。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://goapi.gptnb.ai/api/tasks/visual/segmentation' \
--header 'X-API-KEY: YOUR_API_KEY'

返回响应

🟢200成功

application/json

Body

status

string

必需

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"
  }
}

Describe（描述）

获取图片压缩结果