一、1. 获取 API Key
1. 进入 API Key 管理 页面,单击创建 API Key。操作详情请参见 创建 API Key。
2. 创建完成后,请你务必复制并妥善保管 API Key,在后续配置到工具的流程中将会使用该信息。
注意:说明:
注意:每个账户的密钥都只能当前账户查询,主账户的密钥信息子账户是看不到,子账户如果需要调用接口,需要使用账户自行创建密钥信息。
注意:如果子账户没有办法创建,可能是没有权限创建密钥,需要主账户授权,主账户登录之后点击用户列表,在对应的子账户后面选择授权,会弹出关联策略的弹窗,输入授权策略名称之后搜索,选择对应的策略点击确认。
注意:授权策略:QcloudTokenhubFullAccess
二、2. 并发额度
默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后,才能开始处理下一个任务。
并发任务数:表示在调用对应服务的时段内最大可运行的任务数,该任务未完成时,无法提交下一个任务,该任务完成后,可提交下一个任务。
三、提交绑骨蒙皮任务
输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| model | 是 | string | 绑骨蒙皮模型名称,默认为 hy-3d-rigging。示例值:hy-3d-rigging |
| file_3d | 是 | object | 人形角色需采用标准姿态(A Pose 或 T Pose),尽量保持无动作状态。模型中不应包含人体以外的组件(如坐骑、翅膀等),避免松散衣物、配饰及复杂发型。非人形角色建议上传二足、四足、鸟类等单一生命体模型,姿态应尽量简洁,无夸张或复杂动作,且不支持动作模板生成。3D 模型文件必选其一,参考值:fbx:3D 模型文件,格式为 fbx,文件大小不超过60mb;glb:3D 模型文件,格式为 glb,文件大小不超过60mb;详情请参见 file_3d 数据结构。 |
| motion_type | 否 | Integer | 预设动作类型,参考值:1. 回旋踢2. 左勾拳3. 蓄力攻击4. 蓄力出拳5. 二连击打6. 二连击打-27. 后撤8. 受击9. 受击-210. 受击-311. 受击倒地-112. 受击倒地-213. 落地14. 沮丧15. 割喉16. 刺拳17. 连续击打18. 踢腿19. 侧踢20. 打太极21. 后空翻22. 蹲姿转体23. 走路-124. 走路-225. 走路-326. 待机-127. 待机-228. 街舞29. 扭扭舞30. 左转弯31. 右转弯32. 慢跑33. 慢跑-234. 奔跑35. 冲刺跑-136. 冲刺跑-237. 冲刺跑-338. 原地跳-139. 滑铲40. 向前大跳41. 向前大跳-242. 跨越43. 恐吓44. 向前跌倒45. 右转46. 原地跳-247. 转身48. 发送冲击波 示例值:1 |
输出参数
| 参数名称 | 类型 | 描述 |
| id | string | 任务 id(有效期24小时)。示例值:1315932989749215232 |
| request_id | string | 唯一请求 id,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 request_id)。定位问题时需要提供该次请求的 request_id。 |
| object | string | 返回对象类型。3d 任务固定返回 3d_job。 |
| created_at | integer | 任务创建时间。 |
| status | string | completed:任务成功,failed:任务失败,in_progress:执行中,queued:等待中。示例值:completed |
四、查询绑骨蒙皮任务
输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| model | 是 | string | 绑骨蒙皮模型名称,默认为 hy-3d-rigging。示例值:hy-3d-rigging |
| id | 是 | string | 任务 id。示例值:1357237233311637504 |
输出参数
| 参数名称 | 类型 | 描述 |
| status | string | completed:任务成功,failed:任务失败,in_progress:执行中,queued:等待中。示例值:completed |
| request_id | string | 唯一请求 id,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 request_id)。定位问题时需要提供该次请求的 request_id。 |
| object | string | 返回对象类型。3d 任务固定返回 3d_job。 |
| created_at | integer | 任务创建时间。 |
| completed_at | integer | 任务完成时间。 |
| data | array of object | 生成结果列表,包含生成的 3d 模型文件及相关资源信息。详情请参见 data 数据结构。 |
五、提交绑骨蒙皮任务
输入示例
curl -X POST 'https://tokenhub.tencentmaas.com/v1/api/3d/submit' \\ -H 'Authorization: Bearer YOUR_API_KEY' \\ -H 'Content-Type: application/json' \\ -d '{ "model": "hy-3d-rigging", "file_3d": { "url": "https://example.com/test.fbx" }, "motion_type": 1}'
输出示例
{ "id": "14721*****320", "request_id": "1f64379-bb*****d75fc12365", "object": "3d_job", "created_at": 1784885898, "status": "queued"}
六、查询绑骨蒙皮任务
输入示例
curl -X POST 'https://tokenhub.tencentmaas.com/v1/api/3d/query' \\ -H 'Authorization: Bearer YOUR_API_KEY' \\ -H 'Content-Type: application/json' \\ -d '{ "model": "hy-3d-rigging", "id": "14721*****320" }'
输出示例
{ "request_id": "1f64379-bb*****d75fc12365", "object": "3d_job", "created_at": 1788492072, "completed_at": 1788492072, "status": "completed", "data": [ { "type": "fbx", "url": "https://vcg-prod-1258344699.cos.ap-guangzhou.tencentcos.cn/auto_rigging/output/1254418*****28-9f58-876386e48d44_0.fbx" } ]}
七、file_3d
输入3D 模型文件对象。
| 参数名称 | 必选 | 类型 | 描述 |
| type | 否 | string | 3D 模型文件类型。示例值:fbx |
| url | 是 | string | 3D 模型文件地址。 |
八、data
生成结果对象。
| 参数名称 | 类型 | 描述 |
| type | string | 生成结果文件类型。示例值:obj |
| url | string | 生成结果文件下载地址。 |