API operational59 capabilities

Beta

The Developer APIs are still in beta and may change at any time. At this stage, they are better suited to personal testing and experimentation and are not yet recommended for production use.

Playground

Image to Video

Transform your photos into stunning videos with AI - create dynamic video content from static images.

POST /api/v1/image-to-video/submit → /query

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

6 parameters

firstFrameImageUrl*string

Required request parameter. Follow the type and accepted values shown in this table.

lastFrameImageUrlOptionalstring

Optional request parameter. Follow the type, default, and accepted values shown in this table.

prompt*string

Required request parameter. Follow the type and accepted values shown in this table.

durationOptionalstring

Optional request parameter. Follow the type, default, and accepted values shown in this table.

Default: 5

ratioOptionalstring

Optional request parameter. Follow the type, default, and accepted values shown in this table.

Default: adaptive

resolutionOptionalstring

Optional request parameter. Follow the type, default, and accepted values shown in this table.

Default: 720p

API keyThe API key is used only in this browser tab and is never saved to local storage or sent to another service.

Request code

#!/usr/bin/env bash
set -euo pipefail

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/image-to-video/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "firstFrameImageUrl": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
  "prompt": "The subject gently turns toward the camera as a light breeze moves the hair and background leaves",
  "duration": "5",
  "ratio": "adaptive",
  "resolution": "720p"
}')"
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/image-to-video/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)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["videoUrl"] // .data["videoUrl"] // empty)'
      break
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

#!/usr/bin/env bash set -euo pipefail SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/image-to-video/submit" \ -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \ -H "Content-Type: application/json" \ --data-raw '{ "firstFrameImageUrl": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp", "prompt": "The subject gently turns toward the camera as a light breeze moves the hair and background leaves", "duration": "5", "ratio": "adaptive", "resolution": "720p" }')" 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/image-to-video/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) printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["videoUrl"] // .data["videoUrl"] // empty)' break ;; failed|error) printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2 exit 1 ;; esac sleep 5 done