Skip to main content
POST

Authorizations

Authorization
string
header
required

##All APIs require Bearer Token authentication##

Get API Key:

Visit API Key Management Page to get your API Key

Add to request header:

Body

application/json
model
enum<string>
default:grok-imagine-video-1.5-preview
required

Model name

Available options:
grok-imagine-video-1.5-preview
Example:

"grok-imagine-video-1.5-preview"

prompt
string
required

Video description prompt (required, cannot be empty)

Length limit: Up to 4096 characters

Example:

"The person starts dancing"

image_urls
string<uri>[]

Input image URLs (optional). The number of images selects the generation mode.

Mode selection:

  • 0 images (omit the field): text-to-video, no image charge
  • 1 image: image-to-video, used as the first frame
  • 2-7 images: reference-to-video, blended together

Requirements:

  • Up to 7 images; 8 or more are rejected
  • Image size: max 10MB each
  • Supported formats: JPEG, PNG, WebP
Maximum array length: 7
Example:
duration
integer
default:6

Video duration (seconds), any integer between 1 and 15 seconds

Required range: 1 <= x <= 15
Example:

6

quality
enum<string>
default:480p

Video resolution, default is 480p

Description:

  • 480p: Standard definition (default)
  • 720p: High definition
  • 1080p: Full HD
Available options:
480p,
720p,
1080p
Example:

"480p"

callback_url
string<uri>

HTTPS callback URL after task completion

Callback Timing:

  • Triggered when task is completed, failed, or cancelled
  • Sent after billing confirmation

Security Restrictions:

  • Only HTTPS protocol supported
  • Callback to internal IPs prohibited (127.0.0.1, 10.x.x.x, 172.16-31.x.x, 192.168.x.x, etc.)
  • URL length must not exceed 2048 characters

Callback Mechanism:

  • Timeout: 10 seconds
  • Max 3 retries on failure (after 1/2/4 seconds)
  • Response format matches task query API
  • 2xx status code = success, others trigger retry
Example:

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

Response

Video task created successfully

created
integer

Task creation timestamp

Example:

1757169743

id
string

Task ID

Example:

"task-unified-1757169743-7cvnl5zw"

model
string

Actual model name used

Example:

"grok-imagine-video-1.5-preview"

object
enum<string>

Specific task type

Available options:
video.generation.task
progress
integer

Task progress percentage (0-100)

Required range: 0 <= x <= 100
Example:

0

status
enum<string>

Task status

Available options:
pending,
processing,
completed,
failed
Example:

"pending"

task_info
object

Video task detailed information

type
enum<string>

Task output type

Available options:
text,
image,
audio,
video
Example:

"video"

usage
object

Usage and billing information