Skip to main content

​
Endpoint

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

​
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
_idsStringtrueMultiple IDs separated by commas

​
Response Attributes

ParameterTypeDescription
codeIntegerInterface returns business status code (1000:success)
msgStringInterface returns status information
dataObjectResponse data object
- resultArrayArray of result objects
— _idStringDocument ID
— create_timeLongCreation timestamp
— uidIntegerUser ID
— team_idStringTeam ID
— update_timeLongLast update time/completion time
— video_durationNumberActual video duration
— webhookUrlStringCallback URL
— file_nameStringFile name
— effect_nameStringEffect name
— image_urlStringImage URL
— promptStringPrompt text
— resolutionStringResolution
— audio_typeIntegerAudio type
— audio_urlStringAudio URL
— deduction_creditIntegerActual credits deducted
— effect_codeStringEffect code
— video_urlStringGenerated video URL
— statusIntegerStatus: 1=queueing, 2=processing, 3=completed, 4=failed
— only_add_audioBooleanWhether only audio was added

​
Example

​
Request Body

{
  "_ids": "68919a464b4dbdd4ab3d3034,6891a07f5d612f78c9204f1c"
}

​
Request

curl --location 'https://openapi.akool.com/api/open/v4/image2Video/resultsByIds' \
--header 'x-api-key: {{API Key}}' \
--header 'Content-Type: application/json' \
--data '{
  "_ids": "68919a464b4dbdd4ab3d3034,6891a07f5d612f78c9204f1c"
}'

​
Response

​
Queueing Status (status = 1)

{
  "code": 1000,
  "msg": "OK",
  "data": {
    "result": [
      {
        "_id": "6891a2295d612f78c9204f77",
        "create_time": 1754374697629,
        "uid": 101400,
        "team_id": "6805fb69e92d9edc7ca0b409",
        "update_time": 1754374394023,
        "video_duration": 5.063,
        "webhookUrl": "",
        "file_name": "Image2Video_Animate this image with .mp4",
        "effect_name": "Squish",
        "image_url": "https://drz0f01yeq1cx.cloudfront.net/1753772478686-9524-b6e4169bb1b44d5d8361936b3f6eddb8.png",
        "prompt": "Animate this image with smooth camera movement and subtle object motion.",
        "resolution": "4k",
        "audio_type": 2,
        "audio_url": "https://drz0f01yeq1cx.cloudfront.net/1753772497950-9213-1749809724426audio.mp3",
        "deduction_credit": 5,
        "effect_code": "squish_89244231312",
        "status": 1,
        "only_add_audio": true
      }
    ]
  }
}

​
Completed Status (status = 3)

{
  "code": 1000,
  "msg": "OK",
  "data": {
    "result": [
      {
        "_id": "6891abe782f7cd2a890c44ba",
        "create_time": 1754377191100,
        "uid": 101400,
        "team_id": "6805fb69e92d9edc7ca0b409",
        "sub_type": 1501,
        "video_duration": 5.063,
        "webhookUrl": "",
        "file_name": "Image2Video_Animate this image with .mp4",
        "effect_name": "Squish",
        "update_time": 1754377293090,
        "image_url": "https://drz0f01yeq1cx.cloudfront.net/1753772478686-9524-b6e4169bb1b44d5d8361936b3f6eddb8.png",
        "prompt": "Animate this image with smooth camera movement and subtle object motion.",
        "resolution": "4k",
        "audio_type": 2,
        "audio_url": "https://drz0f01yeq1cx.cloudfront.net/1753772497950-9213-1749809724426audio.mp3",
        "deduction_credit": 30,
        "effect_code": "squish_89244231312",
        "video_url": "https://d2qf6ukcym4kn9.cloudfront.net/1754377291791-1423.mp4",
        "status": 3,
        "only_add_audio": false
      }
    ]
  }
}

​
Video Status

StatusDescription
1In Queue - Your request is waiting to be processed
2Processing - Video is currently being generated
3Success - Video completed, result URL is available in the video_url field
4Failed - Video generation failed, check your input resources

​
Important Notes

  • Use the _id values from the Create Image to Video or Create Batch Image to Video response as the _ids parameter
  • You can query multiple video results at once by separating IDs with commas
  • Poll this endpoint periodically to check the video generation status
  • When status is 3 (Success), the video_url field will contain the URL of the generated video
  • Generated videos are valid for 7 days, download and save them promptly
  • If a webhook URL was provided during creation, you will receive a callback when the task completes (no need to poll)