Image to Video API Overview

​

API Endpoints

​

Image to Video Operations

• Create Image to Video - Transform a static image into a dynamic video
• Create Batch Image to Video - Create multiple videos from images in a single request
• Get Image to Video Results - Retrieve video generation results by IDs
• Get Available Effects - List all available video effects
• Update Video Audio - Add or replace audio on a generated video
• Delete Videos - Delete generated videos by IDs

​

Getting Started

​

Basic Workflow

1. Get Available Models (Optional):
   GET /api/open/v4/aigModel/list?types[]=1501
   
2. Create Image to Video:
   • Prepare your image URL (PNG or JPEG)
   • Choose resolution, duration, and optional effects
   • Call the Create Image to Video API with your resources
3. Check Results:
   • Use the Get Image to Video Results API to check the status of your video
   • Download the result URL when the status is “Success” (status = 3)
4. Update Audio (Optional):
   • Use the Update Video Audio API to add or replace audio on a completed video

​

Response Code Description

​

Video Status Codes

When checking results, the status field indicates the current state:

​

Best Practices

​

Image Requirements

• Quality: Use high-resolution images for better results
• Format: PNG or JPEG format is recommended
• Content: Clear, well-lit images produce better animation results

​

API Usage Tips

• Webhook: Use the webhookUrl parameter to receive notifications when processing is complete
• Prompt: Use descriptive prompts to guide the animation style and motion
• Negative Prompt: Specify what to avoid for cleaner results
• Effects: Browse available effects with the Get Available Effects API for creative video styles
• Resolution: Choose appropriate resolution based on your needs - higher resolution costs more credits and may take longer
• Batch Creation: Use the Batch API to create multiple videos at once with the same settings
• Result Cleanup: Save generated videos promptly as they expire after 7 days

​

Integration Workflow

1. Get Available Models
   GET /api/open/v4/aigModel/list?types[]=1501
   
2. User Selects Model and Parameters
   • Display models from step 1
   • Show supported resolutions and durations
   • Calculate and display credit cost
3. Create Video(s)
   POST /api/open/v4/image2Video/createBySourcePrompt/batch
   
   With selected model_name and parameters
4. Check Results
   POST /api/open/v4/image2Video/resultsByIds
   
   Using the _id values from creation response

Notes

• Models are sorted by sort field in descending order (higher values first)
• The value field should be used as the model_name parameter in creation APIs
• Resolution pricing may vary by model; check resolutionList for accurate costs
• Some advanced models may require paid accounts (requiresPay: true)
• The API returns an empty array for model types that are not yet implemented

​

Support

For additional help and examples, check out our:

• Authentication Guide
• Webhook Documentation