跳转到主要内容
GET
查询 Vidu 模板列表

概述

使用此接口查询 Crun 提供的可用 Vidu 特效模板。 此接口面向希望通过单一 API 连接集成所有 Vidu 模板的开发者。它会分页返回经过 Crun 侧标准化后的模板目录、支持的选项、预览资源、输入说明、Vidu 官方分类信息、热门/新模板标记和积分消耗。
开发者可以将此接口作为模板 ID 和各模板能力的可信来源,然后将选定的模板配置直接传入 vidu/template,从而一键集成所有支持的模板。

使用场景

  1. 构建模板市场或模板选择器 UI
  2. 按计划同步最新模板列表
  3. 通过传入可选的 template 参数查询单个模板
  4. 基于返回的模板元数据驱动动态表单渲染
  5. 使用 pagepage_size 分页获取大量模板

官方参考

相关资源

Vidu 模板视频

使用选定模板和模板专属输入提交 Vidu 模板视频生成任务。

获取任务信息

任务提交后查询生成状态并获取最终结果。

授权

x-api-key
string
header
必填

所有 API 都需要通过 API Key 进行身份验证。

获取 API Key:

  1. 访问 API Key 管理页面 获取你的 API Key

使用方式: 添加到请求头:

x-api-key: YOUR_API_KEY

注意:

  • 请妥善保管你的 API Key,不要与他人共享
  • 如果你怀疑 API Key 已泄露,请立即在管理页面中重置

查询参数

page
integer
默认值:1

分页查询的页码。提供 template 时会忽略该参数。

必填范围: x >= 1
page_size
integer
默认值:20

每页返回的模板数量,最大值为 50。提供 template 时会忽略该参数。

必填范围: x <= 50
template
string
默认值:""

可选的模板 ID。提供该参数时,API 仅返回匹配的模板。

响应

请求成功

code
enum<integer>

响应状态码

  • 200:成功 - 请求已成功处理
  • 401:未授权 - 身份验证凭证缺失或无效
  • 402:积分不足 - 账户没有足够的积分执行该操作
  • 404:未找到 - 请求的资源或接口不存在
  • 422:验证错误 - 请求参数未通过验证检查
  • 429:请求频率受限 - 已超过该资源的请求限制
  • 455:服务不可用 - 系统当前正在维护
  • 500:服务器错误 - 处理请求时发生意外错误
  • 501:生成失败 - 内容生成任务失败
  • 505:功能已禁用 - 请求的功能当前已被禁用
可用选项:
200,
401,
402,
404,
422,
429,
455,
500,
501,
505
message
string

响应消息,失败时为错误描述

示例:

"success"

data
object