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/AI Text to Image API for Prompted Visuals

AI Text to Image API for Prompted Visuals

Add text-to-image generation to your application. Submit a prompt, choose an aspect ratio or image dimensions, and retrieve the generated image URL for your editor, asset library, or content workflow.

Get API keyView API docs
Abstract illustration for AI Text to Image API for Prompted Visuals
PlaygroundAPIPricingGuideFAQs

AI Text to 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

4 parameters

Text description of the image to generate.

Preferred output aspect ratio. Exact pixel dimensions are chosen by the provider.(Optional)

Default: 9:16

Legacy width hint used with height to infer aspect ratio when aspectRatio is omitted. It does not guarantee exact output pixels.(Optional)

Default: 1080

Legacy height hint used with width to infer aspect ratio when aspectRatio is omitted. It does not guarantee exact output pixels.(Optional)

Default: 1920

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/text-to-image/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A cozy reading nook beside a rain-streaked window, warm lamplight, realistic interior photography",
  "aspectRatio": "9:16",
  "width": "1080",
  "height": "1920"
}')"
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/text-to-image/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.

Text to Image

Requiredprompt
Request controls
  • aspectRatio: 11 accepted values; see parameter rules
  • width: default "1080"
  • height: default "1920"

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

Text to Image

POST /api/v1/text-to-image/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text description of the image to generate.

Edit the sample inputs for your own task before submitting.

Text to Image 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/text-to-image/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A cozy reading nook beside a rain-streaked window, warm lamplight, realistic interior photography","aspectRatio":"9:16","width":"1080","height":"1920"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules4 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText description of the image to generate. No additional field constraint listed.
aspectRatiostringNo"9:16"Preferred output aspect ratio. Exact pixel dimensions are chosen by the provider. Values: "auto", "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3", "5:4", "4:5", "21:9" · Default: "9:16"
widthstringNo"1080"Legacy width hint used with height to infer aspect ratio when aspectRatio is omitted. It does not guarantee exact output pixels. Default: "1080"
heightstringNo"1920"Legacy height hint used with width to infer aspect ratio when aspectRatio is omitted. It does not guarantee exact output pixels. Default: "1920"

Retrieve the result

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

POST /api/v1/text-to-image/query

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

Task states and recovery ↗
Text to Image query
curl -X POST "https://vidmage.ai/api/v1/text-to-image/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)
Text to Imageimage API1 image request: 5 credits
How this is calculated
  • Per request: 5 credits / image

A fixed credit charge applies to this API request.

Estimate your own request ↗
5 credits / imageSee 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 AI Text to Image API

VidMage's AI Text to Image API is an image generation interface that creates images from written descriptions. It accepts a prompt describing a subject, scene, or visual style, with optional framing settings. The output is a generated image for concept development, image editing, or content creation. To create an image from a prompt in your browser, use VidMage's Text to Image.

AI Text to Image API capabilities

Prompt-based generation
Describe the subject, setting, and visual treatment in one prompt to request a new image.
Flexible image framing
Choose a supported aspect ratio, including square, portrait, landscape, wide frames, or the automatic option.
Dimension inputs
Include optional width and height strings when your application needs to submit image dimensions with the prompt.

What you can build

Blog hero illustrations

A chef preparing vegetables in a small kitchen gives a food article a more specific visual than a generic cooking image. Turn that scene brief into a landscape illustration your publishing tool can place alongside the draft.

Game prop concepts

Describe a prop before an artist starts detailed work: its shape, material, wear, and surroundings. A brass compass on a wooden desk, for example, can become a concept image for the game's asset board.

Social post backgrounds

Give campaign copy a setting that matches the season or occasion. Generate a square or portrait scene with space for text, keeping the exact promotion, logo, and CTA in your post editor where they remain editable.

How to use AI Text to 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
Choose a clear framing rule
Begin with one aspect ratio or a consistent set of dimensions. The public contract does not define precedence when those optional settings conflict.
Use the generic contract deliberately
This endpoint accepts a prompt without a model selector. Choose a named model API when your integration needs a specific model version or model-specific controls.

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/text-to-image/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

Should I use text-to-image or the AI Girl Generator API?

Use this endpoint for general scenes, objects, or illustrations. AI Girl Generator is the focused entry for adult female character portraits.

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

  • AI Image to Image API for Prompted Edits↗
  • AI Girl Generator API for Portrait Briefs↗
  • Seedream API↗
  • Z-Image API↗
  • AI Image Upscaler API for 2x and 4x Requests↗
  • AI Multi Face Swap API for Photos and Videos↗
  • AI Clothes Changer API for Outfit Previews↗
  • Wan Image API↗