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.

​
Endpoint

GET https://openapi.akool.com/api/open/v4/image2Video/effects

​
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

​
Response Attributes

ParameterTypeDescription
codeIntegerInterface returns business status code (1000:success)
msgStringInterface returns status information
dataObjectResponse data object
- resultArrayArray of effect objects
— _idStringEffect document ID
— create_timeLongCreation timestamp
— logoStringEffect logo URL
— nameStringEffect name
— video_urlStringEffect preview video URL
— effect_codeStringEffect code
- countIntegerTotal number of effects

​
Example

​
Request

curl --location 'https://openapi.akool.com/api/open/v4/image2Video/effects' \
--header 'x-api-key: {{API Key}}'

​
Response

{
  "code": 1000,
  "msg": "Success",
  "data": {
    "result": [
      {
        "_id": "687632b95a0f52799eeed701",
        "create_time": 1752576694502,
        "logo": "https://static.website-files.org/assets/Image_to_Video/Lora/Squish.png",
        "name": "Squish",
        "video_url": "https://static.website-files.org/assets/Image_to_Video/Lora/Squish.mp4",
        "effect_code": "squish_89244231312"
      },
      {
        "_id": "687632ba5a0f52799eeed887",
        "create_time": 1752576694502,
        "logo": "https://static.website-files.org/assets/Image_to_Video/Lora/Cakeify.png",
        "name": "Cakeify",
        "video_url": "https://static.website-files.org/assets/Image_to_Video/Lora/Cakeify.mp4",
        "effect_code": "cakeify_24743216"
      },
      {
        "_id": "687632bc5a0f52799eeed929",
        "create_time": 1752576694502,
        "logo": "https://static.website-files.org/assets/Image_to_Video/Lora/Samurai.png",
        "name": "Samurai",
        "video_url": "https://static.website-files.org/assets/Image_to_Video/Lora/Samurai.mp4",
        "effect_code": "samurai_99757865"
      }
    ],
    "count": 10
  }
}

​
Important Notes

  • Use the effect_code value when creating videos with the Create Image to Video API
  • When an effect is applied, the prompt parameter will be ignored
  • Preview each effect using the video_url field before applying
  • The logo field provides a thumbnail image for displaying in your UI