Animation

POST

animation

curl --request POST \
  --url https://api.magichour.ai/v1/animation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Animation video",
  "fps": 12,
  "end_seconds": 15,
  "height": 960,
  "width": 512,
  "style": {
    "art_style": "Painterly Illustration",
    "art_style_custom": "<string>",
    "camera_effect": "Simple Zoom Out",
    "prompt_type": "custom",
    "prompt": "Cyberpunk city",
    "transition_speed": 5
  },
  "assets": {
    "audio_source": "file",
    "audio_file_path": "api-assets/id/1234.mp3",
    "youtube_url": "<string>",
    "image_file_path": "api-assets/id/1234.png"
  }
}'

{
  "id": "clx7uu86w0a5qp55yxz315r6r",
  "estimated_frame_cost": 450
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Body

fps

number

required

The desire output video frame rate

Required range: x >= 1

Example:

12

end_seconds

number

required

The end time of the input video in seconds

Required range: x >= 0.1

Example:

15

height

integer

required

The height of the final output video. The maximum height depends on your subscription. Please refer to our pricing page for more details

Required range: x >= 64

Example:

960

width

integer

required

The width of the final output video. The maximum width depends on your subscription. Please refer to our pricing page for more details

Required range: x >= 64

Example:

512

style

object

required

Defines the style of the output video

style.art_style

enum<string>

required

The art style of the final output video

Available options:

Custom,

Painterly Illustration,

Vibrant Matte Illustration,

Traditional Watercolor,

Cyberpunk,

Ink and Watercolor Portrait,

Intricate Abstract Lines Portrait,

3D Render,

Old School Comic,

Bold Colored Illustration,

Synthwave,

Minimal Cold Futurism,

Futuristic Anime,

Cinematic Miyazaki,

Studio Ghibli Film Still,

Soft Delicate Matte Portrait,

Cinematic Landscape,

Landscape Painting,

Photograph,

Jackson Pollock,

Cubist,

Abstract Minimalist,

Impressionism,

Van Gogh,

Woodcut,

Oil Painting,

Vintage Japanese Anime,

Pixar,

Cosmic,

Pixel Art,

Fantasy,

Arcane,

Sin City,

Double Exposure,

Painted Cityscape,

90s Streets,

Overgrown,

Postapocalyptic,

Spooky,

Miniatures,

Low Poly,

Art Deco,

Inkpunk,

Dark Graphic Illustration,

Dark Watercolor,

Faded Illustration,

Directed by AI

Example:

"Painterly Illustration"

style.camera_effect

enum<string>

required

Available options:

Simple Zoom Out,

Simple Zoom In,

Bounce Out,

Spin Bounce,

Rolling Bounces,

Rise and Climb,

Dramatic Zoom In,

Dramatic Zoom Out,

Sway Out,

Boost Zoom In,

Boost Zoom Out,

Heartbeat,

Bounce in Place,

Earthquake Bounce,

Slice Bounce,

Bounce In And Out,

Jump,

Road Trip,

Traverse,

Rubber Band,

Rodeo,

Accelerate,

Speed of Light,

Drift Spin,

Vertigo,

Cog in the Machine,

Quadrant,

Tron,

Pusher,

Roll In,

Hesitate In,

Zoom In - Audio Sync,

Pulse - Audio Sync,

Aggressive Zoom In - Audio Sync,

Roll In - Audio Sync,

Zoom Out - Audio Sync,

Aggressive Zoom Out - Audio Sync,

Sway Out - Audio Sync,

Bounce and Spin - Audio Sync,

Zoom In and Spin - Audio Sync,

Vertigo - Audio Sync,

Bounce Out - Audio Sync,

Earthquake Bounce - Audio Sync,

Pusher - Audio Sync,

Evolve - Audio Sync,

Devolve - Audio Sync,

Slideshow,

Pan Left,

Pan Right,

Tilt Up,

Tilt Down,

Directed by AI

style.prompt_type

enum<string>

required

custom - use your own prompt for the video.
use_lyrics - Use the lyrics of the audio to create the prompt. If this option is selected, then assets.audio_source must be file or youtube.
ai_choose - Let AI write the prompt. If this option is selected, then assets.audio_source must be file or youtube.

Available options:

custom,

use_lyrics,

ai_choose

style.prompt

string | null

required

The prompt used for the video. Prompt is required if prompt_type is custom. Otherwise this value is ignored

Example:

"Cyberpunk city"

style.transition_speed

integer

required

Change determines how quickly the video's content changes across frames. Higher = more rapid transitions. Lower = more stable visual experience.

Required range: 1 <= x <= 10

Example:

5

style.art_style_custom

string

Describe custom art style. This field is required if art_style is Custom

assets

object

required

Provide the assets for animation.

name

string

default:Animation - dateTime

The name of video

Example:

"Animation video"

Response

200

application/json

Success

string

required

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

Example:

"clx7uu86w0a5qp55yxz315r6r"

estimated_frame_cost

integer

required

Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes

Example:

450

Was this page helpful?

Delete video Face Swap video

curl --request POST \
  --url https://api.magichour.ai/v1/animation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Animation video",
  "fps": 12,
  "end_seconds": 15,
  "height": 960,
  "width": 512,
  "style": {
    "art_style": "Painterly Illustration",
    "art_style_custom": "<string>",
    "camera_effect": "Simple Zoom Out",
    "prompt_type": "custom",
    "prompt": "Cyberpunk city",
    "transition_speed": 5
  },
  "assets": {
    "audio_source": "file",
    "audio_file_path": "api-assets/id/1234.mp3",
    "youtube_url": "<string>",
    "image_file_path": "api-assets/id/1234.png"
  }
}'

{
  "id": "clx7uu86w0a5qp55yxz315r6r",
  "estimated_frame_cost": 450
}

Files

Video Projects

Image Projects

Authorizations

Body

Response