API Reference
智能剪辑-模板详情 API
POST
smartclip-template-detail-api
ID 24
获取指定智能剪辑模板的结构详情,包括画布与图层信息,便于定制包装参数。
POST
https://xiaoapis.com/api/smartclip/template_detail
概述
- 模板结构详情
- 画布尺寸
- 图层信息
适用场景
- 读取模板结构
- 定制标题/字幕图层
调用约定
- 网关 ·
https://xiaoapis.com - 鉴权 · 请求携带
key(Query 或 JSON Body,以本接口为准) - 回包 · JSON;请同时校验业务码与 HTTP 状态,不要只看 200
鉴权
请求需携带平台 API Key(查询参数 key 或 JSON 字段 key,以本接口说明为准)。在控制台 API Key 管理 创建密钥。
POST https://xiaoapis.com/api/smartclip/template_detail
Content-Type: application/json
{
"key": "YOUR_API_KEY"
}
请求示例
https://xiaoapis.com/api/smartclip/template_detail?key=你的密钥
详细说明
请求HEADER:
| 名称 | 值 |
|---|---|
| Content-Type | application/json |
鉴权说明:请在 URL 参数或 JSON Body 中携带 key(平台 API 密钥)。使用 POST + JSON 时,key 必须写在 JSON Body 内。
请求参数说明:
| 名称 | 必填 | 类型 | 示例值 | 说明 |
|---|---|---|---|---|
| key | 是 | string | 你的密钥 | 平台 API 密钥 |
| id | 是 | string | 6a2668a137004e003477b6ed | 模板 ID(也兼容字段名 template_id) |
返回参数说明:
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 200 成功 |
| msg | string | 状态信息 |
| data.result.data.id | string | 模板 ID |
| data.result.data.name | string | 模板名称 |
| data.result.data.coverUrl | string | 封面 URL |
| data.result.data.scene | string | 应用场景 |
| data.result.data.videoStructInfo | object | 模板结构(canvas、headerLayer、subtitleLayer 等图层) |
返回示例
{
"code": 200,
"msg": "success",
"data": {
"result": {
"code": "Succeed",
"data": {
"id": "6a2668a137004e003477b6ed",
"name": "双语大橙",
"coverUrl": "https://example.com/cover.jpg",
"scene": "realMan",
"videoStructInfo": {
"editInfo": {
"canvas": {
"width": 1080,
"height": 1920
}
}
}
}
}
}
}
常见问题
什么时候需要模板详情?
需要了解画布尺寸、图层开关或做 structLayers 定制时,先拉模板详情。
如何查询?
传入模板 id(与列表返回的 id 一致)及 API Key。
和模板列表的区别?
列表给出摘要;详情给出视频结构与图层级信息。
能否修改模板本身?
详情用于读取结构;成片时通过 create 参数控制包装,不直接改平台模板库。
失败常见原因?
模板 id 无效、未携带 key 或权限不足。
相关接口
完整控制台文档(含调试台):/doc/24