Image-to-Video API documentation
Plan | 720p | 1080p | 4k |
---|---|---|---|
Image-to-Video (5s) | 20 credits/video | 25 credits/video | 30 credits/video |
Image-to-Video (10s) | 40 credits/video | 50 credits/video | 60 credits/video |
Only Audio | 5s | 10s | |
Image-to-Video (only audio) | 5 credits/video | 10 credits/video |
Parameter | Value | Description |
---|---|---|
Authorization | Bearer {token} | Your API Key used for request authorization.getToken |
Parameter | Type | Required | Description |
---|---|---|---|
image_url | String | true | Image URL to be animated |
prompt | String | true | Prompt text describing how to animate the image |
negative_prompt | String | true | Prompt text describing what to avoid in the animation |
extend_prompt | Boolean | false | Whether to use algorithm default extended prompts |
resolution | String | true | Resolution options: 720p, 1080p, 4k |
audio_url | String | false | Audio URL, required when audio_type = 2 |
audio_type | Integer | true | Audio type: 1 = AI generate, 2 = user custom upload, 3 = none (no audio) |
video_length | Integer | true | Video duration in seconds, options: 5, 10 (10s only available for pro and above subscriptions) |
is_premium_model | Boolean | false | Whether to use premium video model for faster generation (pro and above subscriptions only) |
effect_code | String | false | Effect code: if specified, prompt content will be ignored.getEffectCode |
webhookurl | String | false | Callback URL for POST requests |
Parameter | Type | Description |
---|---|---|
code | Integer | Interface returns business status code (1000:success) |
msg | String | Interface returns status information |
data | Object | Response data object |
- create_time | Long | Creation timestamp |
- uid | Integer | User ID |
- team_id | String | Team ID |
- status | Integer | Task status: 1=queueing, 2=processing, 3=completed, 4=failed |
- webhookUrl | String | Callback URL |
- resolution | String | Video resolution |
- file_name | String | Output file name |
- effect_name | String | Effect name |
- _id | String | Document ID |
- image_url | String | Input image URL |
- prompt | String | Animation prompt |
- negative_prompt | String | Negative prompt |
- extend_prompt | Boolean | Whether extended prompts were used |
- audio_type | Integer | Audio type used |
- audio_url | String | Audio URL used |
- deduction_credit | Integer | Credits deducted |
- effect_code | String | Effect code used |
Parameter | Value | Description |
---|---|---|
Authorization | Bearer {token} | Your API Key used for request authorization.getToken |
Parameter | Type | Required | Description |
---|---|---|---|
_ids | String | true | Multiple IDs separated by commas |
Parameter | Type | Description |
---|---|---|
code | Integer | Interface returns business status code (1000:success) |
msg | String | Interface returns status information |
data | Object | Response data object |
- result | Array | Array of result objects |
— _id | String | Document ID |
— create_time | Long | Creation timestamp |
— uid | Integer | User ID |
— team_id | String | Team ID |
— update_time | Long | Last update time/completion time |
— video_duration | Number | Actual video duration |
— webhookUrl | String | Callback URL |
— file_name | String | File name |
— effect_name | String | Effect name |
— image_url | String | Image URL |
— prompt | String | Prompt text |
— resolution | String | Resolution |
— audio_type | Integer | Audio type |
— audio_url | String | Audio URL |
— deduction_credit | Integer | Actual credits deducted |
— effect_code | String | Effect code |
— video_url | String | Generated video URL |
— status | Integer | Status: 1=queueing, 2=processing, 3=completed, 4=failed |
— only_add_audio | Boolean | Whether only audio was added |
Parameter | Value | Description |
---|---|---|
Authorization | Bearer {token} | Your API Key used for request authorization.getToken |
Parameter | Type | Description |
---|---|---|
code | Integer | Interface returns business status code (1000:success) |
msg | String | Interface returns status information |
data | Object | Response data object |
- result | Array | Array of effect objects |
— _id | String | Effect document ID |
— create_time | Long | Creation timestamp |
— logo | String | Effect logo URL |
— name | String | Effect name |
— video_url | String | Effect preview video URL |
— effect_code | String | Effect code |
- count | Integer | Total number of effects |
Parameter | Value | Description |
---|---|---|
Authorization | Bearer {token} | Your API Key used for request authorization.getToken |
Parameter | Type | Required | Description |
---|---|---|---|
pre_video_id | String | true | Image-to-Video result _id |
audio_url | String | true | Audio URL, required when audio_type = 2 |
audio_type | Integer | true | 1 = AI Generate, 2 = user custom upload |
Parameter | Type | Description |
---|---|---|
code | Integer | Interface returns business status code (1000:success) |
msg | String | Interface returns status information |
data | Object | Response data object |
- create_time | Long | Creation timestamp |
- uid | Integer | User ID |
- team_id | String | Team ID |
- update_time | Long | Last update time |
- video_duration | Number | Video duration |
- webhookUrl | String | Callback URL |
- resolution | String | Resolution |
- file_name | String | File name |
- effect_name | String | Effect name |
- _id | String | Document ID |
- pre_video_id | String | Original video ID |
- image_url | String | Image URL |
- prompt | String | Prompt text |
- negative_prompt | String | Negative prompt |
- extend_prompt | Boolean | Whether extended prompts were used |
- audio_type | Integer | Audio type |
- audio_url | String | Audio URL |
- deduction_credit | Integer | Credits deducted |
- effect_code | String | Effect code |
- status | Integer | Status: 1=queueing, 2=processing, 3=completed, 4=failed |
- only_add_audio | Boolean | Whether only audio was added |
Parameter | Value | Description |
---|---|---|
Authorization | Bearer {token} | Your API Key used for request authorization.getToken |
Parameter | Type | Required | Description |
---|---|---|---|
_ids | String | true | Multiple IDs separated by commas |
Parameter | Type | Description |
---|---|---|
code | Integer | Interface returns business status code (1000:success) |
msg | String | Interface returns status information |
data | Object | Response data object |
- successIds | Array | Successfully deleted video IDs |
- noPermissionItems | Array | Failed deletion information list |
— _id | String | Failed deletion video ID |
— msg | String | Failure reason |