xai/grok-imagine-video 的 API 参考,由 Comfy Router 提供,来自 xAI。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的同一调用。
模型 ID: xai/grok-imagine-video
端点: POST https://api.comfy.org/v2/models/xai/grok-imagine-video
- Wait for the result
- Queue and collect later
Schema
Input
string
默认值:"\"16:9\""
生成视频的宽高比可选值:
1:1、16:9、9:16、4:3、3:4、3:2、2:3integer
默认值:"8"
视频时长,单位为秒。范围 [1, 15]。默认 8。范围:
1 到 15object
用于 xAI 端点的输入图像对象
string
图像输入的类型可选值:
image_urlstring
必填
输入图像的 URL(公开 URL 或 base64 编码的 data URI)
string
要使用的模型。支持:grok-imagine-video(默认)、grok-imagine-video-1.5-preview、grok-imagine-video-1.5。已弃用的 grok-imagine-video-beta ID 会别名到 grok-imagine-video。
object
生成视频的可选输出目标
string
必填
用于视频生成的提示词。最多 4,096 个字符。
object[]
一张或多张参考图像,用于引导视频生成(参考生视频模式)。与 image 互斥。Router 仅转发 application/json,且此对象与 XAIImageObject 均不接受 file_id,因此本路由不支持基于文件的图像输入。
string
必填
参考图像的 URL。支持 HTTPS URL(公开)或 base64 编码的 data URL(例如:data:image/jpeg;base64,…)。
string
输出视频的分辨率
string
输出视频的尺寸
string
代表最终用户的唯一标识符
GET /v2/models/xai/grok-imagine-video/openapi.json 提供的 schema 生成,该 schema 与 Router 在请求到达提供商之前用于校验调用的是同一份文档。
Output
string
如果请求被输入内容审核拦截,则包含拦截原因
string
用于生成视频的模型
string
延迟请求的状态:“pending” 或 “done”可选值:
pending、doneobject
视频生成请求的用量信息
integer
本次请求的成本,以 USD ticks 表示。1 美分等于 100,000,000 ticks,因此 1 美元等于 10,000,000,000 ticks。
object
来自 xAI 的已生成视频
integer
已生成视频的时长,单位为秒
boolean
模型生成的视频是否符合审核规则
string
已生成视频的下载 URL。Router 会将视频重新托管到 Comfy 存储并重写此字段,因此它通常是 Comfy 签名的 URL,有效期最长 24 小时:签发时按 24 小时签名,并从 23 小时的缓存中重放,因此稍后的轮询可能返回有效期仅剩一小时的 URL。当无法执行重新托管时,该字段会保留 xAI 自己的短期 URL。可为空:
url 为空的成功响应并不代表生成已完成。无论哪种情况,链接都会过期,因此请下载视频,而不要存储 URL。示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、校验错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。