Appearance
换发API
次文档为换发API文档，开发者可以通过调用换发API，实现换发功能。
发起图片任务
发起任务请求。
请求URL
%domain%/saas/api/call
请求方式
POST
是否需要鉴权
是，API-KEY 鉴权，将开发者 API-KEY 放到请求的 Header 中： --header 'X-Api-Key: xxxx'
请求参数
| 参数字段 | 是否必选 | 字段类型 | 说明 |
|---|---|---|---|
| func | 是 | string | 调用的功能类型，参考功能列表 |
| source_img | 是 | string | 输入图片的URL |
| params | 是 | string | 与功能相关的其他参数，参考功能列表中的说明 |
| callback | 否 | string | 需要回调结果时，填入回调的URL，回调的参数格式与结果查询的格式相同，参考结果查询的说明 |
支持的功能列表
| 功能标签 | 说明 |
|---|---|
| hair_change | 换发型，需要的参数见参数说明 |
换发(hair_change)参数说明
| 功能标签 | 是否必选 | 字段类型 | 说明 |
|---|---|---|---|
| style_id | 是 | string | 目标发型/发色的编号，由训练生成。 |
- 当前支持的模型 ID 列表 （请联系对接人咨询。）
返回结果
错误返回请详见通用错误返回 正常返回字段如下：
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| task_id | string | 任务ID |
| task_type | string | 对应输入的参数 func |
| status | init | 提交任务时，一般为 0，其他值的含义： 0-未完成；1-已完成；2-已失败 |
json
{
"code": 0,
"data": {
"id": 17,
"created_at": "2024-09-05T17:10:41.114289106+08:00",
"updated_at": "2024-09-05T17:10:41.114289106+08:00",
"user_id": "1829431876063244288",
"task_id": "1831620958831886336",
"task_type": "hair_change",
"status": 0,
"callback_url": "",
"result": null
},
"msg": "Success"
}注意事项
其他
查询任务状态
使用发起任务时返回的 task_id 查询结果
请求 URL
%domain%/saas/api/query
HTTP 请求方式
POST
请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| task_id | string | 是 | 任务ID |
返回结果
错误返回请详见通用错误返回 正常返回字段如下：
| 参数名 | 类型 | 说明 |
|---|---|---|
| task_id | string | 查询的 task_id |
| status | init | 提交任务时，一般为 0，其他值的含义： 0-未完成；1-已完成；2-已失败 |
| result | object | 执行结果,status =1 时有值 |
范例： 以下是换发的结果：
json
{
"code": 0,
"data": {
"id": 17,
"created_at": "2024-09-05T17:10:41+08:00",
"updated_at": "2024-09-05T17:10:50+08:00",
"user_id": "1829431876063244288",
"task_id": "1831620958831886336",
"task_type": "hair_change",
"status": 1,
"callback_url": "",
"result": {
"hair_change": [
"https://cdn.aistyle.me/nana/app/user/1829431876063244288/finish/1831620958831886336/saas_hair_change_01/xxx.jpg"
]
}
},
"msg": "Success"
}