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

Z-Image API

Add text-to-image generation to your app with Z-Image. Submit a prompt and aspect ratio, then choose PNG, JPEG, or lossless or lossy WebP to fit your image delivery workflow.

Get API keyView API docs
Abstract illustration for Z-Image API
PlaygroundAPIPricingGuideFAQs

Z-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

3 parameters

Text prompt describing the image to generate (max 2500 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.

Output aspect ratio.(Optional)

Default: 1:1

Output image file format.(Optional)

Default: png

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/z-image-ai-model/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "Architectural visualization of a compact lakeside cabin with timber walls and large windows at twilight",
  "aspectRatio": "1:1",
  "outputFormat": "png"
}')"
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/z-image-ai-model/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.

Z-Image AI Model

Modes: text-to-image

Requiredprompt
Request controls
  • aspectRatio: "1:1", "3:4", "4:3", "9:16", "16:9", "2:3", "3:2"
  • outputFormat: "png", "jpeg", "webp-lossless", "webp-lossy"

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

Z-Image AI Model

POST /api/v1/z-image-ai-model/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the image to generate (max 2500 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.

Z-Image AI Model 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/z-image-ai-model/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"Architectural visualization of a compact lakeside cabin with timber walls and large windows at twilight","aspectRatio":"1:1","outputFormat":"png"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules3 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the image to generate (max 2500 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: 2500
aspectRatiostringNo"1:1"Output aspect ratio. Values: "1:1", "3:4", "4:3", "9:16", "16:9", "2:3", "3:2" · Default: "1:1"
outputFormatstringNo"png"Output image file format. Values: "png", "jpeg", "webp-lossless", "webp-lossy" · Default: "png"
Mode-specific fields & media limits
Text To Image rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2500 characters
aspectRatioValues: "1:1", "3:4", "4:3", "9:16", "16:9", "2:3", "3:2"; mode default: "1:1"
outputFormatValues: "png", "jpeg", "webp-lossless", "webp-lossy"; Default: "png"

Retrieve the result

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

POST /api/v1/z-image-ai-model/query

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

Task states and recovery ↗
Z-Image AI Model query
curl -X POST "https://vidmage.ai/api/v1/z-image-ai-model/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)
Z-Image AI Modelimage API1 image request: 5 credits
How this is calculated
  • Base rate: 5 credits / generation

Base charge is per generation at the selected resolution.

Estimate your own request ↗
5 credits / generationSee 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 Z-Image API

VidMage's Z-Image API is a text-to-image interface that creates compositions from written descriptions. It provides aspect ratio and export format controls, with PNG, JPEG, lossless WebP, and lossy WebP output options. The request is limited to text generation and does not include source-image editing or resolution fields. To explore this model's browser workflow, open VidMage's Z-Image AI Model.

Z-Image API capabilities

Generate from a scene description
Describe the subject, layout, lighting, and environment in a text prompt to request a new image.
Choose the composition shape
Select a supported square, portrait, or landscape aspect ratio to frame the subject for its intended placement.
Select the export format
Request PNG, JPEG, lossless WebP, or lossy WebP using the exact output-format value for your workflow.

What you can build

Article cover illustrations

Create a landscape cover around the subject of an article, using a written scene brief and the required output format. The image returns to the publishing draft, where the editor handles cropping, selection, and alt text.

Game item concept art

A brass compass, a cracked crystal, a weathered shield: written descriptions can give an item catalog its first visual draft. Specify materials and a simple background to produce concepts that guide later illustration or 3D work.

Event poster backgrounds

Set the mood of a poster with a scene and palette described in text. Portrait framing and space for event details make the image useful as a design starting point. Exact titles, dates, and venue information belong in the poster editor.

How to use Z-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
Use exact WebP values
outputFormat accepts png, jpeg, webp-lossless, or webp-lossy. Offer the two WebP variants separately instead of sending the unlisted shorthand value webp in a request.
Build around text and ratio
The public request has no source-image or resolution field. Validate the prompt's 2,500 character limit and review the returned dimensions for your intended placement.

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/z-image-ai-model/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

  • Nano Banana API↗
  • GPT Image API↗
  • Grok Image API↗
  • Midjourney Image API↗
  • Seedream API↗
  • Wan Image API↗
  • Qwen Image API↗
  • AI GIF Face Swap API for Animated Images↗