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 Girl Generator API for Portrait Briefs

AI Girl Generator API for Portrait Briefs

Add adult female character generation to your app using text prompts. Describe appearance and setting, configure the portrait frame, and retrieve the generated image for your character or design workflow.

Get API keyView API docs
Abstract illustration for AI Girl Generator API for Portrait Briefs
PlaygroundAPIPricingGuideFAQs

AI Girl Generator 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 portrait 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/ai-girl-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A confident young woman in a sunlit botanical garden, natural expression, editorial portrait 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/ai-girl-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.

AI Girl Generator

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 ↗

AI Girl Generator

POST /api/v1/ai-girl-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text description of the portrait to generate.

Edit the sample inputs for your own task before submitting.

AI Girl 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/ai-girl-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A confident young woman in a sunlit botanical garden, natural expression, editorial portrait 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 portrait 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/ai-girl-generator/query

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

Task states and recovery ↗
AI Girl Generator query
curl -X POST "https://vidmage.ai/api/v1/ai-girl-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)
AI Girl Generatorimage 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 Girl Generator API

VidMage's AI Girl Generator API is an image generation interface for adult female character portraits. It accepts a written description of the character and setting, along with framing preferences. The generated portraits can be used in story development, character design, and visual concept workflows. To explore a character portrait before integrating the API, open VidMage's AI Girl Generator.

AI Girl Generator API capabilities

Text-based adult portraits
Describe an adult female character, including appearance, pose, clothing, and setting, within the required text prompt.
Portrait framing
Select a supported portrait, square, or landscape aspect ratio to suit the intended character image placement.
Dimension settings
Send optional width and height as strings alongside the prompt when your application supplies explicit image dimensions.

What you can build

Visual novel cast planning

Writers can give an adult female lead a first visual identity through age, clothing, expression, and setting details. The generated portrait belongs on a cast board where story and art teams can discuss her design before final artwork begins.

Fashion editorial concepts

Explore a proposed outfit on an adult character in a studio or street scene. Written pose and wardrobe details shape the portrait, helping designers gather visual ideas for the styling and composition of an editorial shoot.

Role-playing character portraits

Give an adult role-playing heroine a portrait for her character sheet, using the player's written description of her appearance, clothing, profession, and story setting.

How to use AI Girl Generator 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 appearance in the prompt
Pose, wardrobe, expression, and background are written instructions rather than separate API controls. Show the composed prompt so users can review the complete portrait brief.
Choose text or image input
This capability starts from text and has no reference-image field or saved character ID. Repeating a prompt does not guarantee character consistency, so review each portrait. Use image-to-image when an existing portrait must guide the edit.

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/ai-girl-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

Is this a separate portrait model?

The published capability names no fixed portrait model. Its request fields match generic text-to-image.

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 Text to Image API for Prompted Visuals↗
  • Seedream API↗
  • Qwen Image API↗
  • Z-Image API↗
  • AI Image Watermark Remover API for Cleanup↗
  • AI Multi Face Swap API for Photos and Videos↗
  • AI Photo Face Swap API↗