获取特效模板列表
GET
/openapi/v2/video/effects/templates/list
获取特效模板列表
template_id、模板支持的清晰度、输入素材要求和预估点数消耗。查询后可在「视频模板」或支持 template_id 的生成接口中使用。接口地址
Query 参数
| 参数 | 类型 | 是否必填 | 示例 | 说明 |
|---|---|---|---|---|
type | string | 否 | 1 | 模板类型：1 为视频模板，2 为图片模板；不传返回全部 |
page | string | 否 | 1 | 页码，不传默认 1 |
pageSize | string | 否 | 20 | 每页数量，不传默认 50；传入时仅支持 10、20、50、100，其他值返回参数错误 |
字段填写备注
| 字段类型 | 填写建议 |
|---|---|
API-KEY | 使用正式 API Key，不要放在 URL Query 中。 |
Ai-trace-id | 每次请求使用新的 UUID；同一个值重复请求可能被识别为重复请求。 |
type | 只看视频模板时传 1；如需全部模板可不传。 |
pageSize | 建议使用 20 或 50；如需批量同步模板，可分页拉取。 |
template_id | 从响应中的 Resp.effect_items[].template_id 获取，用于后续生成接口。 |
请求 Query 参数
| 字段 | 类型 | 必传 | 说明 |
|---|---|---|---|
type | string | 否 | 模板类型，1为视频模板，2为图片模板；不传返回全部 |
page | string | 否 | 页码 ，不传默认 1 |
pageSize | string | 否 | 每页数量，不传默认 50；传入时仅支持 10、20、50、100，其他值返回参数错误 |
响应字段
顶层字段
| 字段 | 类型 | 说明 |
|---|---|---|
ErrCode | integer | 业务错误码，0 表示成功 |
ErrMsg | string | 错误信息或状态说明 |
Resp | object | 响应业务数据 |
Resp.effect_items | array | 模板 / 特效列表 |
effect_items 字段
| 字段 | 类型 | 说明 |
|---|---|---|
template_id | integer | 模板 ID，后续调用「视频模板」或支持 template_id 的生成接口时使用 |
display_name | string | 模板展示名称 |
display_prompt | string | 模板展示提示词 |
thumbnail_video_url | string | 模板预览视频地址 |
qualities | array | 模板支持的分辨率，例如 360p、540p、720p、1080p |
effect_type | string | 模板类型或素材要求标识，具体含义以接口返回和模板配置为准 |
effect_length | array | 模板支持的视频时长，单位为秒 |
topic_requirements | string | 模板输入素材要求，例如主体类型、主体数量等 |
type | integer | 模板分类，1 通常表示视频模板，2 通常表示图片模板 |
create_at | string | 模板创建时间 |
credit_consume | array | 点数消耗配置数组，用于描述不同规格对应的点数消耗[{"consume_desc_key":"360p","credit":"55"}] |
credit_consume 字段
| 字段 | 类型 | 说明 |
|---|---|---|
consume_desc_key | string | 消耗配置标识，常见为分辨率，例如 360p、540p、720p、1080p |
credit | string | 对应规格下的点数消耗，展示或计算时建议按数字处理 |
响应示例
{
"ErrCode": 0,
"ErrMsg": "Success",
"Resp": {
"effect_items": [
{
"template_id": 402331965264704,
"display_name": "观众席抓拍",
"display_prompt": "生成电影感观众席反应镜头。",
"thumbnail_video_url": "https://media.pixverse.ai/asset%2Ftemplate%2Fstands_cam_capture.mp4",
"qualities": [
"360p",
"540p",
"720p",
"1080p"
],
"effect_type": "1",
"effect_length": [
8
],
"topic_requirements": "主体类型：人物\n建议主体数量：1-2",
"type": 1,
"create_at": "2026-06-11 14:43:28",
"credit_consume": [
{
"consume_desc_key": "360p",
"credit": "55"
},
{
"consume_desc_key": "540p",
"credit": "78"
},
{
"consume_desc_key": "720p",
"credit": "100"
},
{
"consume_desc_key": "1080p",
"credit": "190"
}
]
},
{
"template_id": 402331965264705,
"display_name": "老照片复活",
"display_prompt": "让老照片中的人物自然动起来，并呈现温暖的电影光感。",
"thumbnail_video_url": "https://media.pixverse.ai/asset%2Ftemplate%2Fvintage_photo_revival.mp4",
"qualities": [
"360p",
"540p",
"720p",
"1080p"
],
"effect_type": "1",
"effect_length": [
5
],
"topic_requirements": "主体类型：人物\n建议主体数量：1",
"type": 1,
"create_at": "2026-06-10 11:20:00",
"credit_consume": [
{
"consume_desc_key": "360p",
"credit": "50"
},
{
"consume_desc_key": "540p",
"credit": "75"
},
{
"consume_desc_key": "720p",
"credit": "100"
},
{
"consume_desc_key": "1080p",
"credit": "180"
}
]
}
]
}
}错误响应
| 场景 | 错误说明 |
|---|---|
| Header 缺失或 API Key 无效 | 返回鉴权失败错误 |
| 账号请求超过限流阈值 | 返回 ErrCode=712008，提示请求过快 |
| 参数格式错误，或 pageSize 传入非 10、20、50、100 的值 | 返回参数错误 |
{
"ErrCode": 10005,
"ErrMsg": "apiKey is not registered"
}{
"ErrCode": 712008,
"ErrMsg": "Request too fast. Please try again later."
}{
"ErrCode": 400017,
"ErrMsg": "Invalid field: pageSize"
}请求参数
Query 参数
Header 参数
返回响应
请求示例请求示例
Shell
curl --location 'https://app-api.pixverseai.cn/openapi/v2/video/effects/templates/list?type=1&page=1&pageSize=20' \
--header 'API-KEY: your-api-key' \
--header 'Ai-trace-id: 550e8400-e29b-41d4-a716-446655440000'响应示例响应示例
{
"ErrCode": 0,
"ErrMsg": "Success",
"Resp": {
"property1": "string",
"property2": "string"
}
}修改于 2026-09-04 06:46:31