Create a new motion graphics video generation job

curl --request POST \
  --url https://api.hera.video/v1/videos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "A spinning rainbow wheel.",
  "outputs": [
    {
      "format": "mp4",
      "aspect_ratio": "16:9",
      "fps": "30",
      "resolution": "1080p"
    }
  ],
  "reference_image_url": "<string>",
  "reference_image_urls": [
    "<string>"
  ],
  "reference_video_url": "<string>",
  "duration_seconds": 8,
  "style_id": "<string>",
  "brand_kit_id": "<string>",
  "parent_video_id": "<string>",
  "assets": [
    {
      "url": "<string>"
    }
  ],
  "sound_effects": false
}
'

import requests

url = "https://api.hera.video/v1/videos"

payload = {
    "prompt": "A spinning rainbow wheel.",
    "outputs": [
        {
            "format": "mp4",
            "aspect_ratio": "16:9",
            "fps": "30",
            "resolution": "1080p"
        }
    ],
    "reference_image_url": "<string>",
    "reference_image_urls": ["<string>"],
    "reference_video_url": "<string>",
    "duration_seconds": 8,
    "style_id": "<string>",
    "brand_kit_id": "<string>",
    "parent_video_id": "<string>",
    "assets": [{ "url": "<string>" }],
    "sound_effects": False
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: 'A spinning rainbow wheel.',
    outputs: [{format: 'mp4', aspect_ratio: '16:9', fps: '30', resolution: '1080p'}],
    reference_image_url: '<string>',
    reference_image_urls: ['<string>'],
    reference_video_url: '<string>',
    duration_seconds: 8,
    style_id: '<string>',
    brand_kit_id: '<string>',
    parent_video_id: '<string>',
    assets: [{url: '<string>'}],
    sound_effects: false
  })
};

fetch('https://api.hera.video/v1/videos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hera.video/v1/videos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => 'A spinning rainbow wheel.',
    'outputs' => [
        [
                'format' => 'mp4',
                'aspect_ratio' => '16:9',
                'fps' => '30',
                'resolution' => '1080p'
        ]
    ],
    'reference_image_url' => '<string>',
    'reference_image_urls' => [
        '<string>'
    ],
    'reference_video_url' => '<string>',
    'duration_seconds' => 8,
    'style_id' => '<string>',
    'brand_kit_id' => '<string>',
    'parent_video_id' => '<string>',
    'assets' => [
        [
                'url' => '<string>'
        ]
    ],
    'sound_effects' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hera.video/v1/videos"

	payload := strings.NewReader("{\n  \"prompt\": \"A spinning rainbow wheel.\",\n  \"outputs\": [\n    {\n      \"format\": \"mp4\",\n      \"aspect_ratio\": \"16:9\",\n      \"fps\": \"30\",\n      \"resolution\": \"1080p\"\n    }\n  ],\n  \"reference_image_url\": \"<string>\",\n  \"reference_image_urls\": [\n    \"<string>\"\n  ],\n  \"reference_video_url\": \"<string>\",\n  \"duration_seconds\": 8,\n  \"style_id\": \"<string>\",\n  \"brand_kit_id\": \"<string>\",\n  \"parent_video_id\": \"<string>\",\n  \"assets\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"sound_effects\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hera.video/v1/videos")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"A spinning rainbow wheel.\",\n  \"outputs\": [\n    {\n      \"format\": \"mp4\",\n      \"aspect_ratio\": \"16:9\",\n      \"fps\": \"30\",\n      \"resolution\": \"1080p\"\n    }\n  ],\n  \"reference_image_url\": \"<string>\",\n  \"reference_image_urls\": [\n    \"<string>\"\n  ],\n  \"reference_video_url\": \"<string>\",\n  \"duration_seconds\": 8,\n  \"style_id\": \"<string>\",\n  \"brand_kit_id\": \"<string>\",\n  \"parent_video_id\": \"<string>\",\n  \"assets\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"sound_effects\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hera.video/v1/videos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"A spinning rainbow wheel.\",\n  \"outputs\": [\n    {\n      \"format\": \"mp4\",\n      \"aspect_ratio\": \"16:9\",\n      \"fps\": \"30\",\n      \"resolution\": \"1080p\"\n    }\n  ],\n  \"reference_image_url\": \"<string>\",\n  \"reference_image_urls\": [\n    \"<string>\"\n  ],\n  \"reference_video_url\": \"<string>\",\n  \"duration_seconds\": 8,\n  \"style_id\": \"<string>\",\n  \"brand_kit_id\": \"<string>\",\n  \"parent_video_id\": \"<string>\",\n  \"assets\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"sound_effects\": false\n}"

response = http.request(request)
puts response.read_body

{
  "video_id": "<string>",
  "project_url": "<string>"
}

POST

videos

Create a new motion graphics video generation job

curl --request POST \
  --url https://api.hera.video/v1/videos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "A spinning rainbow wheel.",
  "outputs": [
    {
      "format": "mp4",
      "aspect_ratio": "16:9",
      "fps": "30",
      "resolution": "1080p"
    }
  ],
  "reference_image_url": "<string>",
  "reference_image_urls": [
    "<string>"
  ],
  "reference_video_url": "<string>",
  "duration_seconds": 8,
  "style_id": "<string>",
  "brand_kit_id": "<string>",
  "parent_video_id": "<string>",
  "assets": [
    {
      "url": "<string>"
    }
  ],
  "sound_effects": false
}
'

import requests

url = "https://api.hera.video/v1/videos"

payload = {
    "prompt": "A spinning rainbow wheel.",
    "outputs": [
        {
            "format": "mp4",
            "aspect_ratio": "16:9",
            "fps": "30",
            "resolution": "1080p"
        }
    ],
    "reference_image_url": "<string>",
    "reference_image_urls": ["<string>"],
    "reference_video_url": "<string>",
    "duration_seconds": 8,
    "style_id": "<string>",
    "brand_kit_id": "<string>",
    "parent_video_id": "<string>",
    "assets": [{ "url": "<string>" }],
    "sound_effects": False
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: 'A spinning rainbow wheel.',
    outputs: [{format: 'mp4', aspect_ratio: '16:9', fps: '30', resolution: '1080p'}],
    reference_image_url: '<string>',
    reference_image_urls: ['<string>'],
    reference_video_url: '<string>',
    duration_seconds: 8,
    style_id: '<string>',
    brand_kit_id: '<string>',
    parent_video_id: '<string>',
    assets: [{url: '<string>'}],
    sound_effects: false
  })
};

fetch('https://api.hera.video/v1/videos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hera.video/v1/videos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => 'A spinning rainbow wheel.',
    'outputs' => [
        [
                'format' => 'mp4',
                'aspect_ratio' => '16:9',
                'fps' => '30',
                'resolution' => '1080p'
        ]
    ],
    'reference_image_url' => '<string>',
    'reference_image_urls' => [
        '<string>'
    ],
    'reference_video_url' => '<string>',
    'duration_seconds' => 8,
    'style_id' => '<string>',
    'brand_kit_id' => '<string>',
    'parent_video_id' => '<string>',
    'assets' => [
        [
                'url' => '<string>'
        ]
    ],
    'sound_effects' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hera.video/v1/videos"

	payload := strings.NewReader("{\n  \"prompt\": \"A spinning rainbow wheel.\",\n  \"outputs\": [\n    {\n      \"format\": \"mp4\",\n      \"aspect_ratio\": \"16:9\",\n      \"fps\": \"30\",\n      \"resolution\": \"1080p\"\n    }\n  ],\n  \"reference_image_url\": \"<string>\",\n  \"reference_image_urls\": [\n    \"<string>\"\n  ],\n  \"reference_video_url\": \"<string>\",\n  \"duration_seconds\": 8,\n  \"style_id\": \"<string>\",\n  \"brand_kit_id\": \"<string>\",\n  \"parent_video_id\": \"<string>\",\n  \"assets\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"sound_effects\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hera.video/v1/videos")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"A spinning rainbow wheel.\",\n  \"outputs\": [\n    {\n      \"format\": \"mp4\",\n      \"aspect_ratio\": \"16:9\",\n      \"fps\": \"30\",\n      \"resolution\": \"1080p\"\n    }\n  ],\n  \"reference_image_url\": \"<string>\",\n  \"reference_image_urls\": [\n    \"<string>\"\n  ],\n  \"reference_video_url\": \"<string>\",\n  \"duration_seconds\": 8,\n  \"style_id\": \"<string>\",\n  \"brand_kit_id\": \"<string>\",\n  \"parent_video_id\": \"<string>\",\n  \"assets\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"sound_effects\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hera.video/v1/videos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"A spinning rainbow wheel.\",\n  \"outputs\": [\n    {\n      \"format\": \"mp4\",\n      \"aspect_ratio\": \"16:9\",\n      \"fps\": \"30\",\n      \"resolution\": \"1080p\"\n    }\n  ],\n  \"reference_image_url\": \"<string>\",\n  \"reference_image_urls\": [\n    \"<string>\"\n  ],\n  \"reference_video_url\": \"<string>\",\n  \"duration_seconds\": 8,\n  \"style_id\": \"<string>\",\n  \"brand_kit_id\": \"<string>\",\n  \"parent_video_id\": \"<string>\",\n  \"assets\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"sound_effects\": false\n}"

response = http.request(request)
puts response.read_body

{
  "video_id": "<string>",
  "project_url": "<string>"
}

Authorizations

x-api-key

string

header

required

Your API key for authenticating requests.

Body

application/json

Request body to create a new motion graphics export job.

prompt

string

required

Text prompt describing the motion graphics/video to generate. Be specific about subject, style, motion, and colors for best results.

Example:

"A spinning rainbow wheel."

outputs

object[]

required

Array of output configurations (1–10). Each specifies format, aspect_ratio, fps, and resolution. A good default is one entry: { format: "mp4", aspect_ratio: "16:9", fps: "30", resolution: "1080p" }.

Maximum array length: 10

Show child attributes

Example:

[
  {
    "format": "mp4",
    "aspect_ratio": "16:9",
    "fps": "30",
    "resolution": "1080p"
  }
]

reference_image_url

string

URL of a single reference image to guide visual style or content. Use reference_image_urls instead if you have multiple images.

reference_image_urls

string[]

Up to 5 reference image URLs to guide visual style or content. Preferred over reference_image_url when providing multiple images.

Maximum array length: 5

reference_video_url

string

Optional URL of a reference video.

duration_seconds

number

Duration (in seconds) for the generated video. Optional. Range: 1–120. If omitted, default or parent is used.

Required range: x <= 120

Example:

8

style_id

string

Optional ID of a style to use for styling the video.

brand_kit_id

string

deprecated

[Deprecated] Optional ID of a style to use for styling the video. Use style_id instead.

parent_video_id

string

Video ID or template ID to use as a starting point for this generation. Useful for iterations on a previous result or starting from a template.

assets

object[]

Optional array of asset files to include in the video generation. Each asset has a type and a URL.

Show child attributes

sound_effects

boolean

default:false

[Beta] When true, generates sound effects for the video

Response

200 - application/json

Job successfully queued. Returns a job/video ID.

Response for a successfully queued video generation job.

video_id

string

required

Unique ID of the job/video that was created.

project_url

string

Optional URL to view the project in the user interface.

Retrieve the status of a motion graphics video

⌘I

API Reference

Motion Graphics Generation

Files

Create a new motion graphics video generation job

Authorizations

Body

Response