Lynx API Documentation

Lynx API Documentation

Playground

Lynx by converts images into subject-consistent videos, preserving visual consistency across frames for seamless animations and reliable subject fidelity. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

Easily create subject-consistent videos with Lynx, an advanced image-to-video model designed to keep a stable visual appearance across frames. Whether you’re making dynamic animations or smooth video content, Lynx ensures your subject stays consistent, delivering professional-quality results effortlessly.

Why it looks great

• Subject consistency: preserves the identity, appearance, and details of the subject across all frames.
• Smooth motion: generates fluid, natural-looking animations without jitter.
• Flexible aspect ratios: supports 16:9, 9:16, and 1:1 for versatile use cases.
• Prompt control: guide motion, style, and atmosphere with descriptive text.
• Image-driven video: start from any uploaded image and transform it into a short video clip.

Limits and Performance

• Output resolution: depends on chosen aspect ratio (16:9, 9:16, or 1:1).
• Max clip length per job: 5 seconds
• Processing speed: ~5–12 seconds of wall time per 1 second of video (varies by queue and complexity)

Pricing

Each run costs just $0.5!!!

Billing Rules

• Flat rate: $0.50 per generation
• Each run produces a 5-second clip

How to Use

1. Write a prompt to describe the motion, scene, or style.
2. Upload an image as the subject reference (JPG or PNG).
3. Choose the aspect_ratio: 16:9, 9:16, or 1:1.
4. Submit the job.
5. Download your generated 5-second video.

Pro tips for best quality

• Use high-resolution, clear source images for stronger subject consistency.
• Be specific in your prompts (e.g., “walking forward in a forest with cinematic lighting”).
• Choose the aspect ratio according to your target platform (e.g., 9:16 for TikTok, 16:9 for YouTube).

Authentication

For authentication details, please refer to the Authentication Guide.

API Endpoints

Submit Task & Query Result

set -euo pipefail

export WAVESPEED_API_KEY="your-api-key"

REQUEST_BODY=$(cat <<'JSON'
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "aspect_ratio": "16:9"
}
JSON
)

# 1. Submit the prediction.
SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  -X POST "https://api.wavespeed.ai/api/v3/wavespeed-ai/lynx" \
  -H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  -H "Content-Type: application/json" \
  -d "${REQUEST_BODY}")

TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
  printf 'Submission response did not contain a prediction id
' >&2
  exit 1
fi
RESULT_URL=$(printf '%s' "${TASK}" | jq -r '.urls.get // empty')
if [ -z "${RESULT_URL}" ]; then RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"; fi

# 2. Poll until the prediction finishes.
while true; do
  RESPONSE=$(curl --silent --show-error --fail-with-body \
    "${RESULT_URL}" \
    -H "Authorization: Bearer ${WAVESPEED_API_KEY}")
  RESULT=$(printf '%s' "${RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
  STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')

  case "${STATUS}" in
    completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
    failed|cancelled|timeout) printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
    created|processing) sleep 2 ;;
    *) printf 'Unexpected status: %s
' "${STATUS}" >&2; exit 1 ;;
  esac
done

Parameters

Task Submission Parameters

Request Parameters

Response Parameters

Result Request Parameters

Result Response Parameters