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/Veo 3.1 API

Veo 3.1 API

Integrate Veo 3.1 video generation with text prompts, starting images, and optional ending frames. Request four-, six-, or eight-second clips with explicit controls for framing, resolution, and audio in your application.

Get API keyView API docs
Abstract illustration for Veo 3.1 API
PlaygroundAPIPricingGuideFAQs

Veo 3.1 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

9 parameters

Text prompt describing the video to generate (max 8000 chars).

Optional input image URL. When provided, the task runs in image-to-video mode.(Optional)

Optional public URL for the final frame in image-to-video mode.(Optional)

Video duration in seconds.(Optional)

Default: 8

Output aspect ratio.(Optional)

Default: 9:16

Output resolution tier.(Optional)

Default: 720p

Generate synchronized audio along with the video. No separate sound surcharge is configured.(Optional)

Default: true

Describe unwanted video content or artifacts.(Optional)

Random seed for reproducible generation.(Optional)

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/veo-3-1-ai-video-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "Aerial shot gliding above turquoise ocean waves toward a remote tropical island at sunrise",
  "duration": "8",
  "aspectRatio": "9:16",
  "resolution": "720p",
  "sound": true
}')"
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/veo-3-1-ai-video-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 // .["videoUrl"] // .data["videoUrl"] // 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
Video·videoUrl
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.

Veo 3.1 AI Video Generator

Modes: text-to-video, image-to-video

Additional inputs; requirements vary by mode

prompt imageUrl lastFrameUrl

Media limits by mode
  • Image To VideoImage: jpg, png
Request controls
  • duration: "4", "6", "8"
  • aspectRatio: "16:9", "9:16"
  • resolution: "720p", "1080p", "4k"
  • sound: default true
  • negativePrompt: see parameter rules
  • seed: 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 ↗

Veo 3.1 AI Video Generator

POST /api/v1/veo-3-1-ai-video-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the video to generate (max 8000 chars).

Edit the sample inputs for your own task before submitting.

Veo 3.1 AI Video 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/veo-3-1-ai-video-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"Aerial shot gliding above turquoise ocean waves toward a remote tropical island at sunrise","duration":"8","aspectRatio":"9:16","resolution":"720p","sound":true}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules9 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the video to generate (max 8000 chars). Minimum length: 5 · Maximum length: 8000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. No additional field constraint listed.
lastFrameUrlstringNoNot specifiedOptional public URL for the final frame in image-to-video mode. No additional field constraint listed.
durationstringNo"8"Video duration in seconds. Values: "4", "6", "8" · Default: "8"
aspectRatiostringNo"9:16"Output aspect ratio. Values: "16:9", "9:16" · Default: "9:16"
resolutionstringNo"720p"Output resolution tier. Values: "720p", "1080p", "4k" · Default: "720p"
soundbooleanNotrueGenerate synchronized audio along with the video. No separate sound surcharge is configured. Default: true
negativePromptstringNoNot specifiedDescribe unwanted video content or artifacts. No additional field constraint listed.
seednumberNoNot specifiedRandom seed for reproducible generation. Multiple of: 1 · Whole numbers only
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 5 characters; maximum 8000 characters
durationValues: "4", "6", "8"; mode default: "8"
aspectRatioValues: "16:9", "9:16"; mode default: "9:16"
resolutionValues: "720p", "1080p", "4k"; mode default: "720p"
soundBoolean control; default true
negativePromptNo additional field constraint listed.
seedNo additional field constraint listed.
Image To Video rules
ControlMode-specific rule
promptRequired; minimum 5 characters; maximum 8000 characters
durationValues: "4", "6", "8"; mode default: "8"
aspectRatioValues: "16:9", "9:16"; mode default: "9:16"
resolutionValues: "720p", "1080p", "4k"; mode default: "720p"
soundBoolean control; default false
imageUrlImage input
lastFrameUrlOptional final-frame image input
negativePromptNo additional field constraint listed.
seedNo additional field constraint listed.

Retrieve the result

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

POST /api/v1/veo-3-1-ai-video-generator/query

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

Task states and recovery ↗
Veo 3.1 AI Video Generator query
curl -X POST "https://vidmage.ai/api/v1/veo-3-1-ai-video-generator/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "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)
Veo 3.1 AI Video Generatorvideo API8-second video: 160 creditsresolution: 720p · sound: true
How this is calculated
  • 720p: 20 credits / second
  • 1080p: 20 credits / second
  • 4k: 20 credits / second

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
20 credits / secondSee 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 Veo 3.1 API

VidMage's Veo 3.1 API generates four-, six-, or eight-second video clips from scene descriptions or frame inputs. A starting image and optional ending image can guide the shot, with portrait or landscape framing, resolution, and audio controls. Short drama editors can use these brief clips to establish a location, bridge two views, or develop a story beat. To explore this model's browser workflow, open VidMage's Veo 3.1 AI Video Generator.

Veo 3.1 API capabilities

Create a scene from text
Describe the subject, environment, action, and camera movement for a four-, six-, or eight-second video.
Guide the opening and ending
Supply a starting image and optional ending frame, with a prompt describing the movement between them.
Set frame and sound choices
Choose portrait or landscape framing, a listed resolution, and an explicit audio setting for your request.

What you can build

Establishing shots for short dramas

Set the scene before the dialogue starts: a quiet cafe, an empty platform, a house at night. Four-, six-, and eight-second requests suit brief openings that orient viewers within an episode. Choose whether the shot should include output audio.

Transitions between story frames

Two frames can mark the beginning and end of a character approaching a door. Describe the movement between them to explore a connecting shot. This gives an editor a way to bridge planned views within the story.

Portrait product ad scenes

For a vertical campaign, frame the product reveal around the space a phone screen provides. Start from a scene description or product image; the generated shot supplies footage for an ad that your editor finishes with the offer and branding.

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

Input tips
Offer three duration choices
Use the string values "4", "6", and "8". They are discrete options, so design your duration selector around them rather than accepting arbitrary values in between.
Make the audio choice explicit
The merged form and text mode show sound enabled by default, while image mode shows disabled. Set sound explicitly, using false to request audio off, and check the returned clip when silence matters.

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/veo-3-1-ai-video-generator/query
Completed result
videoUrl
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 submit a reference-image set or extend a video?

No reference-image array or source-video field is listed for this VidMage route. Other Veo APIs may expose different workflows; check their request contracts separately.

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

  • Sora 2 API↗
  • SkyReels API↗
  • Midjourney Video API↗
  • MiniMax H3 API↗
  • HappyHorse API↗
  • Wan Video API↗
  • PixVerse API↗
  • Kling API↗