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 Image

Transform your images with AI using text prompts. Upload a photo and describe the changes — our AI reimagines it in seconds.

POST /api/v1/image-to-image/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

imageUrls*string[]

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

minItems 1

prompt*string

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

aspectRatioOptionalstring

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

Default: 9:16

resolutionOptionalstring

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

Default: 2k

widthOptionalstring

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

Default: 1080

heightOptionalstring

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

Default: 1920

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-image/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "imageUrls": [
    "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp"
  ],
  "prompt": "Transform the uploaded portrait into a refined watercolor illustration while preserving the face and pose",
  "aspectRatio": "9:16",
  "resolution": "2k",
  "width": "1080",
  "height": "1920"
}')"
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-image/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 // .["imageUrl"] // .data["imageUrl"] // 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-image/submit" \ -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \ -H "Content-Type: application/json" \ --data-raw '{ "imageUrls": [ "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp" ], "prompt": "Transform the uploaded portrait into a refined watercolor illustration while preserving the face and pose", "aspectRatio": "9:16", "resolution": "2k", "width": "1080", "height": "1920" }')" 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-image/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 // .["imageUrl"] // .data["imageUrl"] // empty)' break ;; failed|error) printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2 exit 1 ;; esac sleep 5 done