开始使用

接口概览

MetaMirror 提供视频生成模型的 API。Seedance 系列模型可以按火山方舟的方式调用,MiniMax H3 系列模型可以按 MiniMax 开放平台的方式调用,已经接入官方接口的代码只需要换掉接口地址和 API Key;平台上的所有视频模型也都可以通过兼容 OpenAI 的通用视频接口调用。

三套接口

接口地址

接口接口地址(base_url)对应的官方地址
火山方舟格式https://your-domain/ark/api/v3https://ark.cn-beijing.volces.com/api/v3
MiniMax 格式https://your-domain/minimaxhttps://api.minimaxi.com
OpenAI 格式https://your-domain/v1https://api.openai.com/v1

使用 SDK 时把客户端的 base_url 设成上表的接口地址;直接发 HTTP 请求时,在接口地址后面接上各接口的路径。

鉴权

所有接口都用 API Key 鉴权。在 控制台 → API Keys 创建密钥,请求时放在 Authorization 请求头里:

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

也可以改用 x-api-key: sk-xxxxxxxxxxxxxxxx 请求头。每个 API Key 可以单独限制能用的模型、IP 白名单、额度和有效期。

完整的密钥只在创建时显示一次,请立即保存。不要把密钥写在网页、App 等客户端代码里,泄露后请马上在控制台删除并重新创建。

调用流程

视频生成是异步任务:提交后立即返回任务 ID,生成完成后再取回视频。

  1. 1

    提交任务

    调用创建接口,传入模型、提示词和图片等素材。平台按价格冻结余额,返回任务 ID。

  2. 2

    查询进度

    用任务 ID 定时查询状态,建议间隔 10 秒以上。生成时间与模型、分辨率和时长有关,通常需要几分钟。火山方舟格式和 MiniMax 格式还可以设置 callback_url,状态变化时由平台主动通知。

  3. 3

    取回视频

    任务成功后结果里带有视频地址,同时完成扣费(由模型决定时长的任务按实际时长结算,按 token 计费的任务按视频的实际尺寸和时长结算,多冻结的部分退回)。失败、取消或超时的任务不扣费,冻结的金额全部退回。详见计费规则。

通用约定

  • 请求和响应都是 UTF-8 编码的 JSON。OpenAI 格式的创建接口还支持 multipart/form-data,可以直接上传图片文件。
  • 时间都是 Unix 时间戳(秒),金额单位是人民币元。
  • 任务提交后最长运行 12 小时,超时自动结束并退款。
  • 每个响应都带有 X-Request-ID 响应头,错误响应里的 request_id 也是这个值,反馈问题时请一并提供。请求时也可以自带 X-Request-ID(不超过 64 个字符,只能包含字母、数字和 -_.),平台会沿用它,方便和你自己的日志对应。

频率限制

接口限制
创建任务(三种格式合计)每个账号每分钟 120 次
取消任务每个账号每分钟 120 次
查询任务、任务列表、下载视频不单独限制,轮询间隔建议不小于 10 秒

超出限制时返回 HTTP 429,Retry-After 响应头给出需要等待的秒数。排队的任务较多时,创建接口也可能返回 429,稍后重试即可。