Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.akool.com/llms.txt

Use this file to discover all available pages before exploring further.

The resources (image, video, voice) generated by our API are valid for 7 days. Please save the relevant resources as soon as possible to prevent expiration.

​
Endpoint

POST https://openapi.akool.com/api/open/v4/image2Video/createBySourcePrompt

​
Request Headers

ParameterValueDescription
x-api-keyAPI KeyYour 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.
AuthorizationBearer {token}Your API Key used for request authorization.Get Token

​
Body Attributes

ParameterTypeRequiredDescription
image_urlStringtrueImage URL to be animated
promptStringtruePrompt text describing how to animate the image
negative_promptStringtruePrompt text describing what to avoid in the animation
extend_promptBooleanfalseWhether to use algorithm default extended prompts
resolutionStringtrueResolution options: 720p, 1080p, 4k
audio_urlStringfalseAudio URL, required when audio_type = 2
audio_typeIntegertrueAudio type: 1 = AI generate, 2 = user custom upload, 3 = none (no audio)
video_lengthIntegertrueVideo duration in seconds, options: 5, 10 (10s only available for pro and above subscriptions)
is_premium_modelBooleanfalseWhether to use premium video model for faster generation (pro and above subscriptions only)
effect_codeStringfalseEffect code: if specified, prompt content will be ignored.Get Effect Code
webhookurlStringfalseCallback URL for POST requests

​
Response Attributes

ParameterTypeDescription
codeIntegerInterface returns business status code (1000:success)
msgStringInterface returns status information
dataObjectResponse data object
- create_timeLongCreation timestamp
- uidIntegerUser ID
- team_idStringTeam ID
- statusIntegerTask status: 1=queueing, 2=processing, 3=completed, 4=failed
- webhookUrlStringCallback URL
- resolutionStringVideo resolution
- file_nameStringOutput file name
- effect_nameStringEffect name
- _idStringDocument ID
- image_urlStringInput image URL
- promptStringAnimation prompt
- negative_promptStringNegative prompt
- extend_promptBooleanWhether extended prompts were used
- audio_typeIntegerAudio type used
- audio_urlStringAudio URL used
- deduction_creditIntegerCredits deducted
- effect_codeStringEffect code used

​
Example

​
Request Body

{
  "image_url": "https://drz0f01yeq1cx.cloudfront.net/1753772478686-9524-b6e4169bb1b44d5d8361936b3f6eddb8.png",
  "prompt": "Animate this image with smooth camera movement and subtle object motion.",
  "negative_prompt": "blurry, distorted hands, missing fingers, unnatural pose, double hands, extra limbs, bad anatomy, low quality, cartoonish, exaggerated features, open mouth, aggressive expression, modern clothing, pixelated, vibrant colors, overexposed, flickering, blurry details, subtitles, logo, style, artwork, painting, picture, static, overall grayish, worst quality, JPEG compression artifacts, ugly, incomplete, extra fingers, poorly drawn hands, poorly drawn face, deformed, disfigured, malformed limbs, fused fingers, static characters, messy background, three legs, crowded background, walking backwards",
  "extend_prompt": true,
  "resolution": "4k",
  "audio_url": "https://drz0f01yeq1cx.cloudfront.net/1753772497950-9213-1749809724426audio.mp3",
  "audio_type": 2,
  "video_length": 10,
  "is_premium_model": true,
  "effect_code": "squish_89244231312",
  "webhookurl": ""
}

​
Request

curl --location 'https://openapi.akool.com/api/open/v4/image2Video/createBySourcePrompt' \
--header 'x-api-key: {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
  "image_url": "https://drz0f01yeq1cx.cloudfront.net/1753772478686-9524-b6e4169bb1b44d5d8361936b3f6eddb8.png",
  "prompt": "Animate this image with smooth camera movement and subtle object motion.",
  "negative_prompt": "blurry, distorted hands, missing fingers, unnatural pose, double hands, extra limbs, bad anatomy, low quality, cartoonish, exaggerated features, open mouth, aggressive expression, modern clothing, pixelated, vibrant colors, overexposed, flickering, blurry details, subtitles, logo, style, artwork, painting, picture, static, overall grayish, worst quality, JPEG compression artifacts, ugly, incomplete, extra fingers, poorly drawn hands, poorly drawn face, deformed, disfigured, malformed limbs, fused fingers, static characters, messy background, three legs, crowded background, walking backwards",
  "extend_prompt": true,
  "resolution": "4k",
  "audio_url": "https://drz0f01yeq1cx.cloudfront.net/1753772497950-9213-1749809724426audio.mp3",
  "audio_type": 2,
  "video_length": 10,
  "is_premium_model": true,
  "effect_code": "squish_89244231312",
  "webhookurl": ""
}'

​
Response

{
  "code": 1000,
  "msg": "OK",
  "data": {
    "create_time": 1754362985482,
    "uid": 101400,
    "team_id": "6805fb69e92d9edc7ca0b409",
    "status": 1,
    "webhookUrl": "",
    "resolution": "4k",
    "file_name": "Image2Video_Animate this image with .mp4",
    "effect_name": "Squish",
    "_id": "689174694b4dbdd4ab3d28c9",
    "image_url": "https://drz0f01yeq1cx.cloudfront.net/1753772478686-9524-b6e4169bb1b44d5d8361936b3f6eddb8.png",
    "prompt": "Animate this image with smooth camera movement and subtle object motion.",
    "negative_prompt": "blurry, distorted hands, missing fingers, unnatural pose, double hands, extra limbs, bad anatomy, low quality, cartoonish, exaggerated features, open mouth, aggressive expression, modern clothing, pixelated, vibrant colors, overexposed, flickering, blurry details, subtitles, logo, style, artwork, painting, picture, static, overall grayish, worst quality, JPEG compression artifacts, ugly, incomplete, extra fingers, poorly drawn hands, poorly drawn face, deformed, disfigured, malformed limbs, fused fingers, static characters, messy background, three legs, crowded background, walking backwards",
    "extend_prompt": true,
    "audio_type": 2,
    "audio_url": "https://drz0f01yeq1cx.cloudfront.net/1753772497950-9213-1749809724426audio.mp3",
    "deduction_credit": 60,
    "effect_code": "squish_89244231312"
  }
}

​
Important Notes

  • Image Quality: Use high-resolution images for better animation results
  • Prompt: Use descriptive prompts to guide the animation style and motion
  • Negative Prompt: Specify what to avoid (e.g., “blurry, distorted”) for cleaner results
  • Effects: If effect_code is specified, the prompt content will be ignored. Browse effects with Get Available Effects
  • Resolution: Choose from 720p, 1080p, or 4k - higher resolution costs more credits
  • Video Length: 10-second videos are only available for pro and above subscriptions
  • Premium Model: Use is_premium_model for faster generation (pro and above subscriptions only)
  • Resource Expiration: Generated videos are valid for 7 days, save them promptly
  • Webhook: Use webhookUrl to receive notifications when video generation is complete
  • Save the _id from the response to check video status using the Get Image to Video Results API