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/SkyReels API

SkyReels API

Add SkyReels text-to-video and image-to-video generation to your app. Configure clip duration and resolution, and enable or disable prompt optimization directly in the request to support your video workflow.

Get API keyView API docs
Abstract illustration for SkyReels API
PlaygroundAPIPricingGuideFAQs

SkyReels 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

6 parameters

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

Optional input image URL. When provided, the task runs in image-to-video mode. In that mode, output ratio is inferred from the input image.(Optional)

Video duration in seconds.(Optional)

Default: 5

Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image.(Optional)

Default: 16:9

Output resolution tier.(Optional)

Default: 1080p

Expand and refine the prompt automatically.(Optional)

Default: true

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/skyreels-ai-video-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A detective enters a dim archive room and sweeps a flashlight across shelves of old documents",
  "duration": "5",
  "aspectRatio": "16:9",
  "resolution": "1080p",
  "promptOptimizer": 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/skyreels-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.

SkyReels AI Video Generator

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

Additional inputs; requirements vary by mode

prompt imageUrl

Media limits by mode
  • Image To VideoImage: jpg, jpeg, png, gif, bmp
Request controls
  • duration: 13 accepted values; see parameter rules
  • aspectRatio: "16:9", "9:16", "1:1", "4:3", "3:4"
  • resolution: "480p", "720p", "1080p"
  • promptOptimizer: default true

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

SkyReels AI Video Generator

POST /api/v1/skyreels-ai-video-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

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

Edit the sample inputs for your own task before submitting.

SkyReels 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/skyreels-ai-video-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A detective enters a dim archive room and sweeps a flashlight across shelves of old documents","duration":"5","aspectRatio":"16:9","resolution":"1080p","promptOptimizer":true}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules6 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the video to generate (max 2048 chars). Minimum length: 1 · Maximum length: 2048
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. In that mode, output ratio is inferred from the input image. No additional field constraint listed.
durationstringNo"5"Video duration in seconds. Values: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15" · Default: "5"
aspectRatiostringNo"16:9"Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image. Values: "16:9", "9:16", "1:1", "4:3", "3:4" · Default: "16:9"
resolutionstringNo"1080p"Output resolution tier. Values: "480p", "720p", "1080p" · Default: "1080p"
promptOptimizerbooleanNotrueExpand and refine the prompt automatically. Default: true
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2048 characters
durationValues: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
aspectRatioValues: "16:9", "9:16", "1:1", "4:3", "3:4"; mode default: "16:9"
resolutionValues: "480p", "720p", "1080p"; mode default: "1080p"
promptOptimizerDefault: true
Image To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2048 characters
durationValues: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
resolutionValues: "480p", "720p", "1080p"; mode default: "1080p"
imageUrlImage input
promptOptimizerDefault: true

Retrieve the result

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

POST /api/v1/skyreels-ai-video-generator/query

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

Task states and recovery ↗
SkyReels AI Video Generator query
curl -X POST "https://vidmage.ai/api/v1/skyreels-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)
SkyReels AI Video Generatorvideo API5-second video: 150 creditsresolution: 1080p
How this is calculated
  • 480p: 10 credits / second
  • 720p: 15 credits / second
  • 1080p: 30 credits / second

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
10–30 credits / secondBase rate varies by settings or workflow
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 SkyReels API

Turn a written scene or storyboard image into a moving shot with VidMage's SkyReels API. Duration, resolution, and prompt optimization controls shape the request. Text mode includes framing settings; image mode follows its source without a separate aspect ratio or ending-frame field. For short drama generation, the clips provide scene material that you can develop into an episode edit. To explore this model's browser workflow, open VidMage's SkyReels AI Video Generator.

SkyReels API capabilities

Generate from a scene brief
Describe a subject, action, camera, and setting to request a new video with text-mode framing controls.
Animate an existing visual
Send a starting image with a prompt explaining what should move after the opening view.
Control prompt optimization
Enable or disable promptOptimizer while selecting a listed duration and resolution for the same scene.

What you can build

Scene generation for short dramas

A character enters a room and notices something out of place. Develop that beat from a written brief or a starting image, with the action and camera direction made explicit. The clip becomes one shot in a larger episode.

Location and lighting concepts

The same fictional street can feel very different at dawn, dusk, or in rain. Request each treatment separately and collect the clips in a location reel. Directors can discuss atmosphere using moving scene concepts alongside their written notes.

Trailers from book illustrations

Publishers already have character and setting art that can guide a trailer shot. Animate an illustration with a camera reveal or movement in the scene, leaving the book title, narration, and release details to the trailer edit.

How to use SkyReels 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
Keep the original prompt
promptOptimizer defaults to true; set it to false to turn optimization off. Save your written brief and compare otherwise unchanged requests to evaluate the effect on your own prompt.
Respect the image-mode controls
Image mode has no separate aspectRatio control, and the public request does not expose lastFrameUrl. Build around the starting image, motion brief, duration, and resolution.

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/skyreels-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

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

  • PixVerse API↗
  • Midjourney Video API↗
  • Vidu API↗
  • Kling API↗
  • Grok Video API↗
  • MiniMax H3 API↗
  • Wan Video API↗
  • Seedance 2.5 API↗