Skip to content
Platform / Docs / Grok video API
Sign up Console →

API Reference

Grok video API

POST grok-video-api ID 15

Grok video generation. Submit a job and fetch the file. Parameters follow this page.

POST https://xiaoapis.com/api/video/grok
Get an API key Console / try it Open Markdown

Overview

  • 视频生成任务
  • 异步查询

Use cases

  • 创意视频
  • 快速出片
Conventions
  • Gateway · https://xiaoapis.com
  • Auth · send key (query or JSON body, as this API specifies)
  • Response · JSON. Check the business code and the HTTP status, not only HTTP 200

Authentication

Send the platform API key (query parameter key or JSON field key, as this page specifies). Create one in API key management.

POST https://xiaoapis.com/api/video/grok
Content-Type: application/json

{
  "key": "YOUR_API_KEY"
}

Request example

https://xiaoapis.com/api/video/grok?key=你的密钥

Details

请求HEADER：

名称值
Content-Typeapplication/json

请求参数说明：

名称必填类型示例值说明
key是string35kj5jnlj53453kl5j43nj5接口密钥,在控制台->密钥管理查看
prompt是string一只手从画面中伸进来，递给女孩一杯外带咖啡。女孩走出画面，看起来很疲惫，然后接过咖啡，高兴地说：“谢谢！回去工作了。”说完，她走出画面，径直走向办公室的另一个区域。描述期望视频运动的文本提示。
duration是number6

生成的视频时长（秒）（6-30）。（最小值：6，最大值：30，步长：1）

resolution否string480p

生成视频的分辨率。480p、720p

aspect_ratio否string

16:9


图像比例选择，仅适用于多图生成模式，单图模式下视频宽高参考图片宽高。

2:3 3:2  1:1 16:9 9:16

image_urls否string["https://fx.com/2.png"]提供一个外部图像 URL 作为视频生成的参考。支持最多7个图像，在提示词中引用已上传图片时，请输入 @image(n)，并在其后加一个空格（例如：@image1 海边日落）。


支持 JPEG、PNG、WEBP 格式

每张图像最大文件大小：10MB

使用外部图像时 Spicy 模式不可用

数组最多包含七个 URL


callBackUrl是stringhttp://your-callback-url.com/complete用于接收视频生成任务完成更新的URL地址。可选但推荐在生产环境中使用。

返回参数说明：

名称类型说明
codeint状态码
msgstring状态信息
datastring请求结果数据集
-task_idstring



任务 ID 可与“获取任务详细信息”端点一起使用，以查询任务状态



debugstring/array调试数据
exec_timefloat执行耗时
user_ipstring客户端IP

Response example

<p>{ &nbsp;&quot;code&quot;: 200, &nbsp;&quot;msg&quot;: &quot;success&quot;, &nbsp;&quot;data&quot;: { &nbsp; &nbsp;&quot;taskId&quot;: &quot;veo_task_abcdef123456&quot; &nbsp;}}</p>

Error codes

响应状态码


200: 成功 - 请求已成功处理
401: 未授权 - 缺少身份验证凭据或凭据无效
402: 额度不足 - 账户额度不足，无法执行该操作
404: 未找到 - 请求的资源或接口不存在
422: 校验错误 - 请求参数未通过校验检查
429: 请求受限 - 已超过该资源的请求频率限制
455: 服务不可用 - 系统目前正在维护中
500: 服务器错误 - 处理请求时发生了意外错误
501: 生成失败 - 内容生成任务失败
505: 功能禁用 - 请求的功能目前已禁用

FAQ

如何创建 G 视频任务？

按文档提交提示词等字段与 API Key。

如何取结果？

使用对应查询/回调机制获取视频 URL。

适合什么内容？

短创意、概念片与营销草稿等生成式视频场景。

和 Seedance / 索拉如何选？

不同模型风格与限制不同，建议小流量对比后选型。

合规？

遵守平台内容安全与服务条款。

Full console doc (with the debugger):/doc/15