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/Nano Banana API

Nano Banana API

Integrate Nano Banana image generation and editing into your app. Generate from text or submit up to five source images with edit instructions, using automatic or fixed aspect ratios for your output.

Get API keyView API docs
Abstract illustration for Nano Banana API
PlaygroundAPIPricingGuideFAQs

Nano Banana 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 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.(Optional)

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

minItems 1maxItems 5

Output aspect ratio.(Optional)

Default: 3:4

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/nano-banana-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 playful corgi working as a barista in a bright modern cafe, detailed commercial illustration",
  "aspectRatio": "3:4"
}')"
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/nano-banana-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.

Nano Banana AI Image Generator

Modes: text-to-image, image-edit

Additional inputs; requirements vary by mode

prompt imageUrl imageUrls

Media limits by mode
  • Image EditImage: jpg, png; up to 5 files
Request controls
  • aspectRatio: 11 accepted values; see parameter rules

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

Nano Banana AI Image Generator

POST /api/v1/nano-banana-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.

Nano Banana 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/nano-banana-ai-image-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A playful corgi working as a barista in a bright modern cafe, detailed commercial illustration","aspectRatio":"3:4"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules4 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. No additional field constraint listed.
imageUrlsstring[]NoNot specifiedOrdered input image URLs for image editing mode. The prompt can reference them by their one-based order. Minimum items: 1 · Maximum items: 5
aspectRatiostringNo"3:4"Output aspect ratio. Values: "auto", "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3", "5:4", "4:5", "21:9" · Default: "3:4"
Mode-specific fields & media limits
Text To Image rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 20000 characters
aspectRatioValues: "auto", "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3", "5:4", "4:5", "21:9"; mode default: "3:4"
Image Edit rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 20000 characters
aspectRatioValues: "auto", "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3", "5:4", "4:5", "21:9"; mode default: "auto"
imageUrlsImage input; up to 5 items

Retrieve the result

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

POST /api/v1/nano-banana-ai-image-generator/query

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

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

VidMage's Nano Banana API is an interface for generating images from written descriptions and editing compositions with source images. Editing requests can include up to five images and instructions describing their roles. Both modes support automatic or fixed framing, without a separate resolution selector. To explore this model's browser workflow, open VidMage's Nano Banana AI Image Generator.

Nano Banana API capabilities

Generate from a written brief
Describe a subject, setting, and composition in prompt to request a new image without source material.
Edit with multiple sources
Supply up to five images and describe the role each source should play in the edit.
Choose automatic or fixed framing
Set aspectRatio to auto or a supported square, portrait, landscape, or ultrawide value for your request.

What you can build

Product lifestyle images

Move beyond a plain product shot by pairing it with a room reference. Describe where the item belongs and how the setting should look. A seller can inspect the resulting composition as a possible addition to the listing.

Story character scene boards

A traveler arriving at an inn needs both a character design and a sense of place. Supply those as separate image references and explain the scene in the prompt, giving the storyboard artist a composition to develop further.

Event campaign illustrations

Festival posters, ticket pages, and social announcements need visuals that fit different spaces. Generate a scene from the event brief with the chosen framing and room for copy; your design editor supplies the exact dates, venue, and ticket details.

How to use Nano Banana 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 the edit input array
The edit mode uses imageUrls with up to five sources. Keep the set small and explain each image's role before adding references with overlapping or conflicting details.
Set framing explicitly
Text and edit modes display different aspectRatio defaults, so specify the value when framing matters. The public request has no separate resolution selector.

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/nano-banana-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

Can I select Nano Banana Pro or a Gemini model ID?

This VidMage capability has no model selector. Its name alone does not establish the native Gemini model ID or the controls available in another Nano Banana version.

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↗
  • GPT Image API↗
  • Seedream API↗
  • Qwen Image API↗
  • Midjourney Image API↗
  • Z-Image API↗
  • Wan Image API↗
  • AI GIF Face Swap API for Animated Images↗