POST
/
v1
/
ai-gif-generator
Python
from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.ai_gif_generator.generate(
    style={"prompt": "Cute dancing cat, pixel art"}, name="Ai Gif gif"
    wait_for_completion=True,
    download_outputs=True,
    download_directory="outputs"
)
{
  "id": "cuid-example",
  "frame_cost": 50,
  "credits_charged": 50
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

​
style
object
required
​
name
string
default:Ai Gif - dateTime

The name of gif. This value is mainly used for your own identification of the gif.

Example:

"Ai Gif gif"

​
output_format
enum<string>
default:gif

The output file format for the generated animation.

Available options:
gif,
mp4,
webm
Example:

"gif"

Response

Success

​
id
string
required

Unique ID of the image. This value can be used in the get image project API to fetch additional details such as status

Example:

"cuid-example"

​
frame_cost
integer
required
deprecated

Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.

Example:

50

​
credits_charged
integer
required

The amount of credits deducted from your account to generate the image. We charge credits right when the request is made.

If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.

Example:

50