VidMage DevelopersBETA

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

AI Video to Video

Transform your videos with AI using custom prompts. Choose a style and add your own creative descriptions.

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

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

Parameter

7 parameters

prompt*string

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

videoUrlOptionalstring

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

imageUrlsOptionalstring[]

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

maxItems 3

audioUrlOptionalstring

Optional request parameter. Follow the type, default, 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/video-to-video/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "Restyle the footage as a cinematic hand-painted animation while preserving the original motion and timing",
  "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/video-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