VidMage

VidMage is an AI video and image creation platform for creators. Turn your ideas and images into videos and fresh visuals.

Open the creator tools
Explore APIs
AI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
Build with VidMage
QuickstartAPI keysVidMage MCPError reference
Your account
Developer consoleAbout VidMagePlans and creditsAPI billingContact support
© 2026 VidMage. All rights reserved.
Privacy PolicyTerms of ServiceReport Abuse
Skip to content
VidMage/Developers
Overview
APIs
All APIsAI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
DocumentationVidMage MCPOpen console
Developers/Grok Video API

Grok Video API

Integrate Grok video generation with text prompts or image inputs. Request six- or ten-second clips from text, or use the image mode for clips up to thirty seconds with configurable framing and resolution.

Get API keyView API docs
Abstract illustration for Grok Video API
PlaygroundAPIPricingGuideFAQs

Grok Video API Playground

Use your existing API key and subscription. Submitting a generation uses credits; uploading and preparing a request does not start a generation.

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

6 parameters

Text prompt describing the video to generate (max 20000 chars).

Optional input image URL. When provided, the task runs in image-to-video mode.(Optional)

Ordered input image URLs for reference-to-video mode. The prompt can reference them by their one-based order.(Optional)

minItems 1maxItems 7

Video duration in seconds.(Optional)

Default: 6

Output aspect ratio.(Optional)

Default: 16:9

Output resolution tier.(Optional)

Default: 720p

Request code

#!/usr/bin/env bash
set -euo pipefail
# Set this once per intended task; preserve it and the body for transport retries.
: "${VIDMAGE_IDEMPOTENCY_KEY:?Set a unique key for this task}"

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/grok-video-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A handheld documentary shot of street musicians performing in a busy evening plaza",
  "duration": "6",
  "aspectRatio": "16:9",
  "resolution": "720p"
}')"
TASK_ID="$(printf '%s' "$SUBMIT_RESPONSE" | jq -er '.["taskId"]')"

while true; do
  QUERY_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/grok-video-generator/query" \
    -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
    -H "Content-Type: application/json" \
    --data-raw "{\"taskId\":\"${TASK_ID}\"}")"
  STATUS="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.status // .data.status // "") | ascii_downcase')"
  case "$STATUS" in
    success|succeeded|completed)
      RESULT="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["videoUrl"] // .data["videoUrl"] // empty)')"
      if [ -z "$RESULT" ]; then
        printf '%s' "Result missing; preserve task $TASK_ID and query the same task again. Do not resubmit." >&2
        exit 2
      fi
      printf '%s\n' "$RESULT"
      break
      ;;
    needs_input)
      printf '%s' "Face selection required; preserve task $TASK_ID" >&2
      exit 2
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

Response data

Submit the task to see the API response here.
PlaygroundCapabilities

API documentation

Submit a request, track the task, and retrieve your result.

Required inputs
prompt
Output
Video·videoUrl
Request setup & limitsHeaders, input options and media limits

Request headers

Authorization
Bearer YOUR_API_KEY

Keep your API key on your server.

Content-Type
application/json
Idempotency-Key
YOUR_UNIQUE_KEY

Use a new key per task. Reuse it only when retrying the same submission.

Input options & limits

Request controls follow each task's parameter rules; they do not guarantee output properties.

Grok Video Generator

Modes: text-to-video, image-to-video

Additional inputs; requirements vary by mode

prompt imageUrl imageUrls

Media limits by mode
  • Image To VideoImage: jpg, png; up to 7 files
Request controls
  • duration: 25 accepted values; see parameter rules
  • aspectRatio: "16:9", "9:16", "1:1", "2:3", "3:2"
  • resolution: "480p", "720p"

Input retention and output-link lifetime depend on the API contract. Confirm API-specific retention terms before making promises to your users. Upload guide ↗

Grok Video Generator

POST /api/v1/grok-video-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the video to generate (max 20000 chars).

Edit the sample inputs for your own task before submitting.

Grok Video Generator request
# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/grok-video-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A handheld documentary shot of street musicians performing in a busy evening plaza","duration":"6","aspectRatio":"16:9","resolution":"720p"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules6 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the video to generate (max 20000 chars). Minimum length: 1 · Maximum length: 20000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. No additional field constraint listed.
imageUrlsstring[]NoNot specifiedOrdered input image URLs for reference-to-video mode. The prompt can reference them by their one-based order. Minimum items: 1 · Maximum items: 7
durationstringNo"6"Video duration in seconds. Values: "6", "10", "7", "8", "9", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30" · Default: "6"
aspectRatiostringNo"16:9"Output aspect ratio. Values: "16:9", "9:16", "1:1", "2:3", "3:2" · Default: "16:9"
resolutionstringNo"720p"Output resolution tier. Values: "480p", "720p" · Default: "720p"
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 5 characters; maximum 800 characters
durationValues: "6", "10"; mode default: "6"
aspectRatioValues: "16:9", "9:16", "1:1"; mode default: "16:9"
resolutionValues: "480p", "720p"; mode default: "720p"
Image To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 20000 characters
durationValues: "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30"; mode default: "6"
aspectRatioValues: "2:3", "3:2", "1:1", "16:9", "9:16"; mode default: "16:9"
resolutionValues: "480p", "720p"; mode default: "480p"
imageUrlsImage input; up to 7 items

Retrieve the result

Save taskId from the accepted submission and send it to this endpoint:

POST /api/v1/grok-video-generator/query

Use the same Bearer API key. On completion, read the videoUrl result field.

Task states and recovery ↗
Grok Video Generator query
curl -X POST "https://vidmage.ai/api/v1/grok-video-generator/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "https://..." } }

Pricing

See what one image, video, or generation costs in credits. Your API and website activity share the same credit balance.

API credit rates and calculated example request costs
API / workflowExample requestPrice (credits)
Grok Video Generatorvideo API6-second video: 60 creditsresolution: 720p
How this is calculated
  • 480p: 10 credits / second
  • 720p: 10 credits / second

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
10 credits / secondSee calculation details
Billed in credits. Shared with the website.Active subscription required. Unit rates and examples follow current API credit rules.Billing details⌄

Examples show the charge for the inputs listed above. Resolution, duration, audio, output count and reference media can change the total. Minimum charges and rounding follow the selected API.

Use the Playground to estimate your request before submitting it. Estimates do not start a generation. Subscription and credit-pack prices are listed on the plans page.

Your task’s recorded usage is the source of truth for the final charge.

View plans ↗Billing guide ↗

About Grok Video API

VidMage's Grok Video API is a video generation interface that creates clips from text or image references. Text mode supports six- or ten-second clips, while image mode accepts up to seven images and durations from six to thirty seconds. Available framing choices depend on the input mode, with 480p and 720p resolution options. To explore this model's browser workflow, open VidMage's Grok Video Generator.

Grok Video API capabilities

Create prompt-led clips
Generate a new scene from text with a six- or ten-second duration and a supported frame shape.
Guide longer image-led scenes
Supply up to seven images for the image workflow, which lists durations from six to thirty seconds.
Choose framing and resolution
Select a mode-supported aspect ratio and explicitly set 480p or 720p for the requested video.

What you can build

Vertical story teasers

Open a teaser with a mystery: an unmarked parcel at the door, or a figure waiting under a streetlight. A text prompt and portrait framing turn the idea into a scene your teaser editor can pair with episode titles.

Destination mood reels

Location reference images can anchor an illustrated travel pitch. Describe the atmosphere and camera movement you want, from a calm coastal morning to a crowded evening market, and use selected clips to convey the trip's visual mood.

Product campaign scene previews

Explore how a product reveal feels at different speeds. With product and setting references held steady, the image workflow's duration choices give your team alternate takes to compare against the pacing of a campaign.

How to use Grok Video API

  1. Get an API key

    Create a key in the Developer Console and store it on your server. Use it in the Authorization: Bearer header.

  2. Prepare and submit your inputs

    Set up your inputs in the Playground, then copy the matching API request. Send it from your server with a unique Idempotency-Key.

  3. Track the task

    Save the returned taskId and query the same operation until it completes. Keep that identifier if your app stops waiting.

  4. Retrieve the result

    Read videoUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Match duration to the mode
Text mode accepts "6" or "10"; image mode accepts "6" through "30". Keep duration as a string and validate it after the user chooses an input path.
Validate image requests separately
The image workflow uses the imageUrls array, not the singular imageUrl shown in the combined form. It has its own prompt limits and ratio choices. Set resolution explicitly because displayed defaults differ between modes.

Input requirementsUpload local files

Task fields and results

Keep the task identifier with its original request and Idempotency-Key. Query the same capability until it completes, then read the documented result field.

Task identifier
taskId
Query route
POST /api/v1/grok-video-generator/query
Completed result
videoUrl
Task states and response structure ↗
Errors, retries and limits

Retry transport failures with the same idempotency key only when the original submission may not have reached the server. For a confirmed task, keep querying the original task instead of submitting a duplicate.

Read error recovery guidance ↗

FAQs

Can I edit or extend an existing video on this route?

No source-video input is listed for this route. Use a capability that documents video editing or extension; requests from another Grok API cannot be submitted unchanged.

Are failed or timed-out requests charged?

A client timeout is not a confirmed task failure. Confirmed failures are automatically refunded only when the refund outcome is certain. Unknown charges or refunds remain pending reconciliation.

Failure and refund handling ↗
How long should my app wait for a result?

The checked contract does not establish a fixed completion time. Choose a local wait budget for your app; it is not an API completion deadline.

Polling and wait budgets ↗
What are the rate and concurrency limits?

Request-rate limits control how often you can call the API; concurrency limits control simultaneous work. The documentation ties both to the stable API key but does not publish numeric limits for this operation. Confirm account limits before planning parallel jobs.

Rate-limit recovery ↗
Can I receive results through a webhook?

The checked request contract documents status queries and does not list a webhook or callback field for these routes. Check the current authenticated OpenAPI contract before making a callback part of your integration.

Query task results ↗Check the current contract ↗

Explore more APIs on VidMage

  • Grok Image API↗
  • Sora 2 API↗
  • MiniMax H3 API↗
  • Wan Video API↗
  • Seedance API↗
  • HappyHorse API↗
  • SkyReels API↗
  • Veo 3.1 API↗