# 智能剪辑-模板列表 API Documentation

> 获取智能剪辑模板列表，按场景分页查询

## Overview

This document describes how to call the **智能剪辑-模板列表** API.

- **Model / path slug**: `smartclip/template`
- **Task type**: `sync` (`sync` = synchronous, `async` = create task then poll / callback)
- **HTML docs**: `/doc/23`

## Authentication

All API requests require your platform API key as the query parameter `key`:

```
?key=YOUR_API_KEY
```

Get API Key:
1. Sign in to the console
2. Open [API Key Management](/user/key) and create or copy your key
3. Append `key=YOUR_API_KEY` to the request URL (or pass it in form/JSON when the endpoint accepts it)

---

## API Information

- **URL**: `POST https://apis.xiaobao.ink/api/smartclip/template`
- **Content-Type**: `application/json` (request body commonly `application/json` or `application/x-www-form-urlencoded` for POST)
- **HTTP Method**: `POST`

### Request Parameters

| Parameter | Required | Description |
|-----------|----------|-------------|
| `key` | Yes | 平台密钥 |
| `scene` | Yes | realMan（必填）virtualman/realMan/oralMixCutting/newsMixCutting |
| `pageSize` | Yes | 每页大小，默认10 |
| `sid` | Yes | 分页游标 |
| `searchKey` | Yes | name/id |
| `searchValue` | Yes | 搜索值 |
| `sortBy` | Yes | desc/asc |

> **Note**: `key` (API key) is required for authenticated calls even if omitted from the parameter list above.

### Request Example

```
https://apis.xiaobao.ink/api/smartclip/template?key=你的密钥
```

## Details

##

## *

## 演示地址：https://xiaobao.ink/digital_human/agent

## 请求HEADER：

| 名称 | 值 |
| --- | --- |
| Content-Type | application/json |

**鉴权说明：**请在 URL 参数或 JSON Body 中携带 `key`（平台 API 密钥）。使用 POST + JSON 时，`key` 必须写在 JSON Body 内。

## 请求参数说明：

| 名称 | 必填 | 类型 | 示例值 | 说明 |
| --- | --- | --- | --- | --- |
| key | 是 | string | 你的密钥 | 平台 API 密钥 |
| scene | 是 | string | realMan | 模板场景：virtualman 数字人口播；realMan 真人口播；oralMixCutting 素材混剪；newsMixCutting 新闻混剪 |
| pageSize | 否 | int | 10 | 每页大小，默认 10 |
| sid | 否 | string |  | 分页游标，有值时表示还有下一页 |
| searchKey | 否 | string | name | 搜索字段：name 按名称；id 按模板 ID |
| searchValue | 否 | string |  | 搜索值 |
| sortBy | 否 | string | desc | 排序：desc 上架时间倒序；asc 正序 |

## 返回参数说明：

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| code | int | 200 成功 |
| msg | string | 状态信息 |
| data.result.data.results[] | array | 模板列表 |
| data.result.data.results[].id | string | 模板 ID（styleId） |
| data.result.data.results[].name | string | 模板名称 |
| data.result.data.results[].coverUrl | string | 封面 URL |
| data.result.data.results[].scene | string | 场景枚举 |
| data.result.data.results[].demoUrl | string | 样片视频 URL |
| data.result.data.sid | string | 下一页游标（可选） |

## Response Example

```json
{
    "code": 200,
    "msg": "success",
    "data": {
        "result": {
            "code": "Succeed",
            "data": {
                "results": [
                    {
                        "id": "6a2668a137004e003477b6ed",
                        "name": "双语大橙",
                        "coverUrl": "https://example.com/cover.jpg",
                        "scene": "realMan",
                        "demoUrl": "https://example.com/demo.mp4"
                    }
                ],
                "sid": ""
            }
        }
    },
    "exec_time": 0.35,
    "ip": "127.0.0.1"
}
```

## Error Codes

| Status / code | Description |
|---------------|-------------|
| 200 / success | Request successful |
| 400 | Invalid request parameters |
| 401 | Authentication failed, please check API Key |
| 402 | Insufficient account balance / points |
| 429 | Request rate limit exceeded |
| 500 | Internal server error |

## Usage Flow

1. Obtain your API Key from the console
2. Call the endpoint with `key` and required parameters
3. Parse the JSON (or binary) response according to the examples above

---

_Generated for AI / LLM consumption. Source of truth: `api_list` (same as HTML `/doc/{id}`)._