跳转到主要内容
POST
grok-imagine-text-to-video接口

授权

Authorization
string
header
必填

##所有接口均需要使用Bearer Token进行认证##

获取 API Key :

访问 API Key 管理页面 获取您的 API Key

使用时在请求头中添加:

请求体

application/json
model
enum<string>
默认值:grok-imagine-text-to-video-beta
必填

模型名称

向后兼容: 之前接入的模型名 grok-imagine-text-to-video 仍然可用,会自动映射到 grok-imagine-text-to-video-beta

可用选项:
grok-imagine-text-to-video-beta
示例:

"grok-imagine-text-to-video-beta"

prompt
string
必填

视频描述提示词

示例:

"A cat playing piano in a jazz club"

duration
integer
默认值:6

视频时长(秒),范围 6 ~ 30 秒任意整数

必填范围: 6 <= x <= 30
示例:

6

mode
enum<string>
默认值:normal

生成风格

可选值:

  • fun: 有趣风格
  • normal: 普通风格(默认)
  • spicy: 热辣风格
可用选项:
fun,
normal,
spicy
示例:

"normal"

aspect_ratio
enum<string>
默认值:16:9

画面比例

可选值:

  • 16:9: 横屏(默认)
  • 9:16: 竖屏
  • 1:1: 方形
  • 3:2: 横向 3:2
  • 2:3: 纵向 2:3
可用选项:
16:9,
9:16,
1:1,
3:2,
2:3
示例:

"16:9"

quality
enum<string>
默认值:480p

视频清晰度,默认为480p

说明:

  • 480p: 标准清晰度,此为默认值
  • 720p: 高清晰度
可用选项:
480p,
720p
示例:

"480p"

callback_url
string<uri>

任务完成后的HTTPS回调地址

回调时机:

  • 任务完成(completed)、失败(failed)或取消(cancelled)时触发
  • 在计费确认完成后发送

安全限制:

  • 仅支持HTTPS协议
  • 禁止回调到内网IP地址(127.0.0.1、10.x.x.x、172.16-31.x.x、192.168.x.x等)
  • URL长度不超过2048字符

回调机制:

  • 超时时间:10
  • 失败后最多重试3次(会分别在失败的1秒/2秒/4秒后进行重试)
  • 回调响应体格式与任务查询接口返回的格式一致
  • 回调地址若返回2xx状态码视为成功,其他状态码会触发重试
示例:

"https://your-domain.com/webhooks/video-task-completed"

响应

视频任务创建成功

created
integer

任务创建时间戳

示例:

1757169743

id
string

任务ID

示例:

"task-unified-1757169743-7cvnl5zw"

model
string

实际使用的模型名称

示例:

"grok-imagine-text-to-video-beta"

object
enum<string>

任务的具体类型

可用选项:
video.generation.task
progress
integer

任务进度百分比 (0-100)

必填范围: 0 <= x <= 100
示例:

0

status
enum<string>

任务状态

可用选项:
pending,
processing,
completed,
failed
示例:

"pending"

task_info
object

视频任务详细信息

type
enum<string>

任务的输出类型

可用选项:
text,
image,
audio,
video
示例:

"video"

usage
object

使用量和计费信息