GALAXY EYE
  • 开放文档
  • 形象复刻
Galaxyeye
2024-07-10
目录

形象复刻API

# 1.创建形象训练任务

# 接口描述

# 输入参数

参数名称 必选 字段类型 描述
imageUrl 是 string 1.单个文件，支持png、jpg格式，人物正脸照片，图片不大于10M；
2.图片宽高不大于1180*1280，不小于200*200;
详看形象复刻指导
taskType 是 int 训练模板类型（0：其他尺寸；1：1比1尺寸；2：1比2尺寸；3：3比4尺寸
taskName 是 String 训练任务名称，20字以内（只支持中文，英文，数字）
callBackUrl 否 String 训练任务状态回调地址经历训练回调接口

# 输出参数

参数名称 必选 字段类型 说明
code 是 int 状态码
msg 是 String 状态描述信息
success 是 boolean true： 成功；false：失败
data 是 object 业务数据
data.taskId 是 String 训练任务ID

# 示例

  • 输入示例:

https://open.galaxyeye-api.com/intellect-saas-v4/v1/open/imageTask/createImageTaskTrain

{
    "taskName": "训练名称1",
    "callBackUrl": "https://XXXXX/taskCallback",
    "imageUrl":"https://xxx/xxx.png",
    "taskType":0
}
  • 输出示例：
{
    "msg": "OK",
    "code": 0,
    "success": true,
    "data":{
        "taskId":"30a6f256-0526-11ef-a395-XXXXXXXX"
    }
}

# 快速测试

  • curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v1/open/imageTask/createImageTaskTrain' \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "taskName": "训练名称1",
    "callBackUrl": "https://XXXXX/taskCallback",
    "imageUrl":"https://xxx/xxx.png",
    "taskType":0
}'

# 2.训练状态查询

# 接口描述

# 输入参数

参数名称 必选 类型 说明
taskIds 是 array 训练任务ID，一次性最多可查询50个

# 输出参数

参数名称 必选 类型 说明
code 是 int 状态码
msg 是 string 状态描述信息
success 是 bool true： 成功；false：失败
data 是 object 业务数据
data.taskId 是 string 任务号
data.failReason 否 string 失败原因
data.mouthImage 否 string 说话视频
data.unMouthImage 否 string 静音视频
data.taskStatus 是 int 任务状态; 1-训练中 2-训练成功 3-训练失败

# 示例

  • 输入示例:

https://open.galaxyeye-api.com/intellect-saas-v4/v1/open/imageTask/queryImageTask

{
    "taskIds": [
        "30a6f256-0526-11ef-a395-XXXXXXXX"
    ]
}
  • 输出示例：
{
    "msg": "ok",
    "code": 0,
    "success":true,
    "data": [{
        "taskNo": "30a6f256-0526-11ef-a395-XXXXXXXX",
        "mouthImage": "https://xxx/xxx.mouth.mp4",
        "unMouthImage": "https://xxx/xxx.unmouth.mp4",
        "taskStatus": 2
    }]
}

# 快速测试

  • curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v1/open/imageTask/queryImageTask \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json' \
--data-raw '{
    "taskIds": [
        "30a6f256-0526-11ef-a395-XXXXXXXX"
    ]
}'

# 3.训练结果回调

# 接口描述

  • 接口地址：/xxx/taskStatusCallBack(接口名称仅作示例，开发者可自定义)

  • 请求方式： HTTP POST

  • 请求类型：application/json; charset=utf-8

  • 特别说明： 回调地址端口仅支持默认80或443端口

# 输入参数

参数名称 必选 类型 说明
taskId 是 string 任务id
taskStatus 是 int 任务状态（ 2:训练成功 3:训练失败）
failReason 否 string 失败原因
mouthImage 否 string 说话视频
unMouthImage 否 string 静音视频

# 输出参数

北冥复刻人系统在回调该接口时不解析参数内容，http状态码为200即代表回调成功。因此，输出参数可由开发者自行定义，此处定义仅做参考。

参数名称 必选 类型 说明
code 是 int 状态码
msg 是 String 状态描述信息
success 是 boolean true： 成功；false：失败

# 示例

  • 输入示例:
{
    "taskNo": "30a6f256-0526-11ef-a395-XXXXXXXX",
    "mouthImage": "https://xxx/xxx.mouth.mp4",
    "unMouthImage": "https://xxx/xxx.unmouth.mp4",
    "taskStatus": 2
}
  • 输出示例：
{
    "code":0,
    "msg":"ok",
    "success":true
}

# 4.形象销毁

# 接口描述

# 输入参数

参数名称 必选 类型 说明
taskId 是 string 形象对应的训练任务ID

# 输出参数

参数名称 必选 类型 说明
code 是 int 状态码
msg 是 String 状态描述信息
success 是 boolean true： 成功；false：失败

# 示例

  • 输入示例: https://open.galaxyeye-api.com/intellect-saas-v4/v1/open/imageTask/deleteImageTask
{
    "taskId": "30a6f256-0526-11ef-a395-XXXXXXXX"
}
  • 输出示例：
{
    "msg": "ok",
    "code": 0,
    "success":true
}

# 快速测试

  • curl
curl --location --request POST 'https://open.galaxyeye-api.com/intellect-saas-v4/v1/open/imageTask/deleteImageTask \
--header 'X-Bm-Access-Token: ****yMjc3LCJhY2Nlc3NLZXkiOiJlZTg4OGYyMjY1MGI0YzdkYjExODA0ZWFkNTQyMmEwMyIsImp3dF90b2tlbl9pZCI6ImU4NjljYTc3LTJiMjctNDBjZC04Yzg4LWE1ODY5NWJlN2Q2NiIsInRlbmFudElkIjoiODUyNTM1NTE0MTIwMDYwOTI4Iiwiand0X3Rva2VuX3R5cGUiOjN9.U5QYuSI-ymzTm6QcAHs2ow1MV3BTXwsACWDGaSeW84Y' \
--header 'Content-Type: application/json' \
--data-raw '{
    "taskId": "30a6f256-0526-11ef-a395-XXXXXXXX"
}'

# 5.状态码

返回码 返回码说明 备注
54011 未开通接口权限
11305 taskName不符合要求！
53001 只允许上传png或jpg文件
58000 上传的图片大小超过1180*1280限制
58011 上传的图片大小不能小于200*200限制
56000 该类型任务，图片宽高分辨率不能大于
56001 图片比例不对
54007 上传图片失败，请重试!
54008 形象任务服务器异常，请重试!
54009 请上传人物正脸图片
58001 上传失败，最大只允许10M的文件
58002 上传图片违规
58003 验证过的图片不存在
58004 当前验证过的图片不属于该租户
11400 形象训练失败，请稍后重试！
58012 图片校验失败，请稍后重试
56009 形象训练taskId个数超出上限
58005 形象训练任务不存在
58006 形象训练任务不属于当前租户
58014 形象训练任务正在训练中
上次更新: 2024/08/05, 16:48:48
形象复刻指导
公共状态码

← 公共状态码→

Theme by Vdoing