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 Image API

Grok Image API

Add Grok image generation and editing to your app. Generate images from prompts with aspect ratio, resolution, count, and format controls, or edit an existing image with a source URL and instructions.

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

Grok Image 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 image to generate (max 20000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names.

Optional input image URL. When provided, the task runs in image edit mode. In that mode, output ratio is inferred from the input image.(Optional)

Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image.(Optional)

Default: 1:1

Output resolution tier. Ignored when imageUrl selects a mode that does not expose resolution.(Optional)

Default: 1k

Number of image variations to generate.(Optional)

Default: 1

Output image file format.(Optional)

Default: jpeg

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-ai-image-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A retro-futuristic electric motorcycle parked beneath neon signs on a rainy city street",
  "aspectRatio": "1:1",
  "resolution": "1k",
  "numImages": "1",
  "outputFormat": "jpeg"
}')"
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-ai-image-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 // .["imageUrl"] // .data["imageUrl"] // 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
Image·imageUrl
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 AI Image Generator

Modes: text-to-image, image-edit

Additional inputs; requirements vary by mode

prompt imageUrl numImages

Media limits by mode
  • Image EditImage: jpg, jpeg, png, webp
Request controls
  • aspectRatio: "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3"
  • resolution: "1k", "2k"
  • outputFormat: "jpeg", "png", "webp"

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 AI Image Generator

POST /api/v1/grok-ai-image-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the image to generate (max 20000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names.

Edit the sample inputs for your own task before submitting.

Grok AI Image 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-ai-image-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A retro-futuristic electric motorcycle parked beneath neon signs on a rainy city street","aspectRatio":"1:1","resolution":"1k","numImages":"1","outputFormat":"jpeg"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules6 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the image to generate (max 20000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names. Minimum length: 1 · Maximum length: 20000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image edit mode. In that mode, output ratio is inferred from the input image. No additional field constraint listed.
aspectRatiostringNo"1:1"Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image. Values: "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3" · Default: "1:1"
resolutionstringNo"1k"Output resolution tier. Ignored when imageUrl selects a mode that does not expose resolution. Values: "1k", "2k" · Default: "1k"
numImagesstringNo"1"Number of image variations to generate. Values: "1", "2", "3", "4" · Default: "1"
outputFormatstringNo"jpeg"Output image file format. Values: "jpeg", "png", "webp" · Default: "jpeg"
Mode-specific fields & media limits
Text To Image rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 4000 characters
aspectRatioValues: "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3"; mode default: "1:1"
resolutionValues: "1k", "2k"; mode default: "1k"
numImagesValues: "1", "2", "3", "4"; Default: "1"
outputFormatValues: "jpeg", "png", "webp"; Default: "jpeg"
Image Edit rules
ControlMode-specific rule
promptRequired; minimum 5 characters; maximum 20000 characters
imageUrlImage input

Retrieve the result

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

POST /api/v1/grok-ai-image-generator/query

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

Task states and recovery ↗
Grok AI Image Generator query
curl -X POST "https://vidmage.ai/api/v1/grok-ai-image-generator/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "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 AI Image Generatorimage API1 image request: 10 creditsresolution: 1k · numImages: 1
How this is calculated
  • 1k: 10 credits / generation
  • 2k: 15 credits / generation

Base charge is per generation at the selected resolution.

numImages multiplies the base charge by the selected output count.

Estimate your own request ↗
10–15 credits / generationBase rate varies by settings or workflow
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 Image API

VidMage's Grok Image API is an interface for generating images from text and editing existing images. Text mode provides framing, resolution, output count, and file format controls. Editing uses a source image URL and change instructions, without the separate output settings available in text generation. To explore this model's browser workflow, open VidMage's Grok AI Image Generator.

Grok Image API capabilities

Generate a new composition
Describe a scene and select a supported aspect ratio plus 1k or 2k resolution for text generation.
Edit an existing image
Provide one source in imageUrl and describe what should change or remain. This edit request does not list an image-array input.
Configure generated image delivery
For text generation, request one to four images and select JPEG, PNG, or WebP output.

What you can build

Illustrations for blog articles

An article about working from home might need a scene of a freelancer organizing a small desk. Editors can turn that specific brief into image candidates, choosing framing and output format to suit the article layout.

Seasonal product photography

Refresh an existing product photo for a new season with a written edit: a winter gift table, a summer patio, or an autumn display. The source image anchors the item, whose details can be checked against the original.

Social campaign drafts

Request several images from one campaign brief and give the marketing team a visual shortlist. The chosen composition becomes the base for headlines and branding in your design tool.

How to use Grok Image 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 imageUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Keep generation settings out of edits
The reviewed edit mode does not list separate ratio, resolution, count, or format controls. Build its payload from the source image and requested change.
Use the output count correctly
numImages uses string values from "1" through "4" in text mode. It describes the requested count; inspect the returned result before choosing your application's result layout.

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-ai-image-generator/query
Completed result
imageUrl
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

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 Video API↗
  • Z-Image API↗
  • Wan Image API↗
  • Seedream API↗
  • Midjourney Image API↗
  • GPT Image API↗
  • Nano Banana API↗
  • Qwen Image API↗