对图片中的服装和人像区域进行语义分割,并按所选类别返回灰度 mask 结果。支持异步、同步两种调用方式,适合接入生产流程。
接口返回的结果链接有效期为 1 小时,请及时下载并存储。
鉴权
每个 API 请求都必须在请求头中携带你的 API Key。请按当前文档中的请求方式和参数说明,将其作为 X-API-KEY 请求头传入。
X-API-KEY: YOUR_API_KEY 创建服装分割任务
/api/tasks/visual/r-clothing-segmentation 请求参数
image_url string 可选 源图像 URL。与 image_file 二选一;如果传入此参数,其他图像源参数必须为空。
sync string | number 可选 是否等待结果就绪并立即返回。0 表示异步返回 task_id,稍后通过 task_id 获取结果;1 表示同步等待结果并立即返回。结果最多保留 1 小时。
detail_mode number 可选 分割细节模式。1 = 细粒度常规(默认)。2 = 细粒度极高。若不需要衣服全部细分灰度图,建议选择细粒度常规。
output_type number 可选 输出内容。1 = 仅返回同语义灰度图合并结果(默认)。2 = 仅返回同语义全部细分灰度图,指定语义的全部灰度图会打包成 ZIP,目前仅支持衣服。3 = 两者都返回。
quality number 可选 分割质量。1 表示常规分割质量(默认);2 表示高精度质量。
class_type number 可选 返回的语义类别。1 = 仅服装部分:clothes, tops, bottoms, dress, acc(默认)。2 = 服饰部分:clothes, tops, bottoms, dress, bag, shoes, acc。3 = 人像部分:hair, face, head, body。4 = 全部返回:hair, face, head, clothes, tops, bottoms, dress, bag, shoes, acc, body, others。hair 头发,face 脸,head 头,clothes 衣服,shoes 鞋子,bag 包,acc 饰品,tops 上装,bottoms 下装,dress 连衣裙,body 肢体,others 其他。
返回参数
status number HTTP 响应状态码。200 表示请求成功,非 200 表示请求失败,详见 状态码说明。
message string 接口返回消息。成功时通常为 success。
data.task_id string 异步服装分割任务 ID。创建任务成功后返回,用于后续查询服装分割结果。
status number HTTP 响应状态码。200 表示请求成功,非 200 表示请求失败,详见 状态码说明。
message string 接口返回消息。成功时通常为 success。
data.task_id string 服装分割任务 ID。
data.created_at string 任务创建时间,Unix 时间戳字符串。
data.processed_at string 任务开始处理时间,Unix 时间戳字符串。
data.completed_at string 任务完成时间,Unix 时间戳字符串。
data.clothes_masks string 细分服装灰度 mask ZIP 链接(返回时有效期为 1 小时)。
data.class_masks object 按语义类别返回的结果 mask URL 或 base64 数据,例如 acc、body、clothes、face、hair、others、shoes。
data.output_type number 返回结果类型。
data.progress number 任务处理进度。100 表示处理完成。
data.state number 任务状态码。1 表示处理成功,大于 1 表示处理中,小于 0 表示失败,详见 状态码说明。
查询服装分割结果
异步请求建议每 1 秒 轮询一次结果,本接口最大轮询时长为 120 秒;累计轮询超过该时长仍未返回结果,即可视为超时失败。
/api/tasks/visual/r-clothing-segmentation/{task_id} 路径参数
task_id string 必填 服装分割任务 ID。创建异步服装分割任务后返回,用于查询任务处理结果。
返回参数
status number HTTP 响应状态码。200 表示请求成功,非 200 表示请求失败,详见 状态码说明。
message string 接口返回消息。成功时通常为 success。
data.task_id string 服装分割任务 ID。
data.created_at string 任务创建时间,Unix 时间戳字符串。
data.processed_at string 任务开始处理时间,Unix 时间戳字符串。
data.completed_at string 任务完成时间,Unix 时间戳字符串。
data.clothes_masks string 细分服装灰度 mask ZIP 链接(返回时有效期为 1 小时)。
data.class_masks object 按语义类别返回的结果 mask URL 或 base64 数据,例如 acc、body、clothes、face、hair、others、shoes。
data.output_type number 返回结果类型。
data.progress number 任务处理进度。100 表示处理完成。
data.state number 任务状态码。1 表示处理成功,大于 1 表示处理中,小于 0 表示失败,详见 状态码说明。
使用规范与限制
-
接口返回的结果链接有效期为 1 小时,请及时下载并存储。
-
HTTP status 为 200 仅表示 HTTP 请求成功,任务是否成功需结合 status 和 data.state 判断。
-
URL 作为参数传递时请遵守 URL 编码规范,避免参数解析混乱。
-
上传图片需符合以下格式、分辨率和大小限制。
格式 分辨率 大小 jpg, jpeg, bmp, png, webp, tiff, tif, bitmap, raw, rgb, jfif, lzw 最大 4096x4096 最大20MB
# 服装分割 API
对图片中的服装和人像区域进行语义分割,并按所选类别返回灰度 mask 结果。接口支持异步和同步两种调用方式。
> 注意:接口返回的结果链接有效期为 1 小时,请及时下载并存储。
## 接口域名(Base URL)
以下路径都基于接口域名:
```
https://techsz.aoscdn.com
```
## 鉴权
每个请求都必须在请求头中携带你的 API Key:
```http
X-API-KEY: YOUR_API_KEY
```
你可以在 [API Key](https://picwish.cn/my-account?subRoute=api-key) 页面获取或管理 X-API-KEY。
## 调用方式
通过创建请求中的 `sync` 参数选择调用方式:
- 异步(`sync=0`):创建请求返回 `data.task_id`,随后轮询查询接口获取结果。
- 同步(`sync=1`):创建请求等待处理完成,并在同一个响应中直接返回结果。
请求成功后,结果最多保留 1 小时。
## 原图来源
必须且只能提供一种图片来源:
- `image_url`:可公开访问的原图 URL。
- `image_file`:以 multipart 二进制方式上传的原图文件。
不要同时传两者。
## 接口列表
| 用途 | 方法 | 路径 |
| --- | --- | --- |
| 创建服装分割任务 | POST | /api/tasks/visual/r-clothing-segmentation |
| 查询任务结果(异步) | GET | /api/tasks/visual/r-clothing-segmentation/{task_id} |
## 创建服装分割任务
`POST /api/tasks/visual/r-clothing-segmentation`
Content-Type:`multipart/form-data`
每次成功调用消耗 3 算粒。
### 请求参数
| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| image_url | string | image_url / image_file 二选一 | 源图像 URL。如果传入此参数,其他图像源参数必须为空。 |
| image_file | file | image_url / image_file 二选一 | 源图像文件(二进制 multipart)。如果传入此参数,其他图像源参数必须为空。 |
| sync | string \| number | 可选 | 0 = 异步返回 `task_id`;1 = 同步等待结果并直接返回。结果最多保留 1 小时。 |
| detail_mode | number | 可选 | 1 = 细粒度常规(默认);2 = 细粒度极高。若不需要衣服全部细分灰度图,建议选择细粒度常规。 |
| output_type | number | 可选 | 1 = 仅返回同语义灰度图合并结果(默认);2 = 仅返回同语义全部细分灰度图,指定语义的全部灰度图会打包成 ZIP,目前仅支持衣服;3 = 两者都返回。 |
| quality | number | 可选 | 1 = 常规分割质量(默认);2 = 高精度质量。 |
| class_type | number | 可选 | 1 = 仅服装部分:clothes, tops, bottoms, dress, acc(默认)。2 = 服饰部分:clothes, tops, bottoms, dress, bag, shoes, acc。3 = 人像部分:hair, face, head, body。4 = 全部返回:hair, face, head, clothes, tops, bottoms, dress, bag, shoes, acc, body, others。 |
类别含义:`hair` 头发,`face` 脸,`head` 头,`clothes` 衣服,`shoes` 鞋子,`bag` 包,`acc` 饰品,`tops` 上装,`bottoms` 下装,`dress` 连衣裙,`body` 肢体,`others` 其他。
### 返回参数 - 异步(sync=0)
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 风格状态码。200 = 成功,非 200 = 失败。详见 /states。 |
| message | string | 响应信息,成功时通常为 "success"。 |
| data.task_id | string | 任务 ID,用于后续查询结果。 |
### 返回参数 - 同步(sync=1)
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 风格状态码。200 = 成功,非 200 = 失败。详见 /states。 |
| message | string | 响应信息,成功时通常为 "success"。 |
| data.task_id | string | 任务 ID。 |
| data.created_at | string | 任务创建时间,Unix 时间戳字符串。 |
| data.processed_at | string | 任务开始处理时间,Unix 时间戳字符串。 |
| data.completed_at | string | 任务完成时间,Unix 时间戳字符串。 |
| data.clothes_masks | string | 细分服装灰度 mask ZIP 链接(返回时有效期为 1 小时)。 |
| data.class_masks | object | 按语义类别返回的结果 mask URL 或 base64 数据。 |
| data.output_type | number | 返回结果类型。 |
| data.progress | number | 任务进度,100 表示处理完成。 |
| data.state | number | 1 = 成功;> 1 = 处理中;< 0 = 失败。详见 /states。 |
### 示例
异步,使用图片 URL:
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/r-clothing-segmentation' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=0' \
-F 'image_url=YOUR_IMAGE_URL'
```
异步,上传本地图片文件:
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/r-clothing-segmentation' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=0' \
-F 'image_file=@/path/to/image.jpg'
```
同步,直接返回结果:
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/r-clothing-segmentation' \
-H 'X-API-KEY: YOUR_API_KEY' \
-F 'sync=1' \
-F 'image_url=YOUR_IMAGE_URL'
```
## 查询服装分割结果
异步请求建议每 **1 秒** 轮询一次结果,本接口最大轮询时长为 **120 秒**;累计轮询超过该时长仍未返回结果,即可视为超时失败。
`GET /api/tasks/visual/r-clothing-segmentation/{task_id}`
异步模式下用于轮询获取结果。
### 路径参数
| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| task_id | string | 必填 | 创建任务时返回的任务 ID。 |
### 返回参数
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| status | number | HTTP 风格状态码。200 = 成功,非 200 = 失败。详见 /states。 |
| message | string | 响应信息,成功时通常为 "success"。 |
| data.task_id | string | 任务 ID。 |
| data.created_at | string | 任务创建时间,Unix 时间戳字符串。 |
| data.processed_at | string | 任务开始处理时间,Unix 时间戳字符串。 |
| data.completed_at | string | 任务完成时间,Unix 时间戳字符串。 |
| data.clothes_masks | string | 细分服装灰度 mask ZIP 链接(返回时有效期为 1 小时)。 |
| data.class_masks | object | 按语义类别返回的结果 mask URL 或 base64 数据。 |
| data.output_type | number | 返回结果类型。 |
| data.progress | number | 任务进度,100 表示处理完成。 |
| data.state | number | 1 = 成功;> 1 = 处理中;< 0 = 失败。详见 /states。 |
### 示例
```bash
curl -k 'https://techsz.aoscdn.com/api/tasks/visual/r-clothing-segmentation/{task_id}' \
-H 'X-API-KEY: YOUR_API_KEY'
```
## 推荐的异步流程
1. 用 `sync=0` 和一种图片来源 POST 到 /api/tasks/visual/r-clothing-segmentation。
2. 从创建响应中读取 `data.task_id`。
3. 每隔 1 秒 GET /api/tasks/visual/r-clothing-segmentation/{task_id},通常轮询时间不超过 120 秒,除非你的业务自行设置更长超时。
4. 检查 `data.state`:1 = 完成;> 1 = 继续轮询;< 0 = 失败。
5. 在 1 小时内下载返回的 mask 链接。
## 使用规范与限制
- 接口返回的结果链接有效期为 **1 小时**,请及时下载并存储。
- HTTP status 为 200 仅表示 HTTP 请求成功,任务是否成功需结合 `status` 和 `data.state` 判断。
- URL 作为参数传递时请遵守 URL 编码规范,避免参数解析混乱。
- 上传图片需符合以下格式、分辨率和大小限制。
| 格式 | 分辨率 | 大小 |
| --- | --- | --- |
| jpg, jpeg, bmp, png, webp, tiff, tif, bitmap, raw, rgb, jfif, lzw | 最大 4096x4096 | 最大20MB |
## 状态码
任务是否成功,需要结合 HTTP 响应状态码(`status`)和任务状态码(`data.state`)共同判断。
### HTTP 响应状态码
| 状态码 | 说明 |
| --- | --- |
| 200 | 请求成功。 |
| 400 | 客户端参数传递错误。请检查参数是否缺失或值是否正确。 |
| 401 | 认证失败。请检查 X-API-KEY 是否正确或服务是否开通。 |
| 404 | 请求的 URL 或资源不存在。请检查 URL 或 task_id 是否正确。 |
| 413 | 上传的文件超出大小限制。请参见各服务的最大文件限制。 |
| 429 | 请求频率超出 QPS 限制(默认 QPS 为 2)。请放缓请求速率,或联系商务提升 QPS。 |
| 500 | 服务端异常。请反馈给商务或技术对接人员。 |
### 任务状态码(data.state)
1 = 成功;大于 1 = 处理中;小于 0 = 失败。
| 状态码 | 说明 |
| --- | --- |
| -17 | 处理失败,非法提示词。 |
| -16 | 处理失败,使用第三方检测发现违规。 |
| -15 | 处理失败,资源不足。 |
| -14 | 处理失败,输入图片内容不符合要求。 |
| -13 | 处理失败,任务异常被取消。 |
| -11 | 处理失败,结果为空。 |
| -10 | 处理失败,内部检测非法。 |
| -9 | 处理失败,内部程序循环处理失败。 |
| -8 | 处理超时,最长处理时间 180 秒。 |
| -7 | 无效图片文件(如图片损坏、格式不对等)。 |
| -5 | image_url 图片超出大小限制(30MB)。 |
| -3 | 服务器下载图片文件失败,请检查图片 URL 是否可用。 |
| -2 | 处理完成,但上传 OSS 失败。 |
| -1 | 处理失败。 |
| 0 | 排队中,任务正在队列中等待。 |
| 1 | 完成,处理成功。 |
| 2 | 准备中。 |
| 3 | 等待中。 |
| 4 | 处理中,正在进行。 |
| 5 | 内部发布处理中。 |
| 6 | 处理中,内部循环处理中。 |