Endpoint
Request Headers
| Parameter | Value | Description |
|---|---|---|
| x-api-key | API Key | Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded. |
| Authorization | Bearer {token} | Your API Key used for request authorization.Get Token |
Body Attributes
| Parameter | Type | Required | Description |
|---|---|---|---|
| image_url | String | true | Image URL to be animated |
| prompt | String | true | Prompt text describing how to animate the image |
| model_name | String | false | AI model name (get available models from Get AI Model List) |
| negative_prompt | String | false | Prompt text describing what to avoid in the animation |
| extend_prompt | Boolean | false | Whether to use algorithm default extended prompts |
| resolution | String | true | Resolution value (e.g., 720p, 1080p, 4k). Available options are retrieved from the resolutionList field of the selected model in Get AI Model List |
| video_length | Integer | true | Video duration in seconds. Available durations are retrieved from the durationList field of the selected model in Get AI Model List |
| last_image_url | String | false | URL of the image to use as the last frame of the video |
| generate_audio | Boolean | false | Whether to generate AI audio alongside the video. Only applicable to models that support audio generation — check the generate_audio field in Get AI Model List (non-null means supported). Default: false. Enabling this on supported models may increase credit consumption |
| count | Integer | false | Number of videos to create simultaneously (1-10), default: 1 |
| webhookurl | String | false | Callback URL for POST requests |
Response Attributes
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Interface returns business status code (1000:success) |
| msg | String | Interface returns status information |
| data | Object | Response data object |
| - successList | Array | Array of successfully created video tasks |
| - errorList | Array | Array of failed tasks with error information |
successList Item Attributes
| Parameter | Type | Description |
|---|---|---|
| _id | String | Document ID |
| 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 |
| image_url | String | Input image URL |
| prompt | String | Animation prompt |
| negative_prompt | String | Negative prompt |
| extend_prompt | Boolean | Whether extended prompts were used |
| last_image_url | String | Last frame image URL |
| deduction_credit | Integer | Credits deducted |
| model_name | String | AI model name used |
| batch_id | String | Batch ID for grouping videos created in the same request |
| batch_count | Integer | Total number of videos in this batch |
Example
Request Body
Request Body - With Audio Generation
Usegenerate_audio when the selected model supports audio generation (e.g., AkoolImage2VideoFastV1, AkoolImage2VideoHDV1):
Request
Response
Important Notes
- Batch Size: You can create 1-10 videos simultaneously in a single request
- Model Selection: Use the Get AI Model List API to get available models and their supported resolutions/durations
- Resolution: Available options depend on the selected model; check the model’s
resolutionListfield - Video Length: Available durations depend on the selected model; check the model’s
durationListfield - Last Frame: Use
last_image_urlto specify what the video’s last frame should look like - Audio Generation: Set
generate_audiototrueto add AI-generated audio to the output video. This parameter is only effective for models where thegenerate_audiofield is not null in the Get AI Model List response. If the selected model does not support audio generation, this parameter is ignored - Credits: Each video in the batch is charged individually based on resolution and duration. Enabling
generate_audioon supported models may increase credit consumption - Resource Expiration: Generated videos are valid for 7 days, save them promptly
- Webhook: Use
webhookUrlto receive notifications when each video generation is complete - Save the
_idvalues from the response to check video status using the Get Image to Video Results API