Skip to main content
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_video_url": "<string>",
  "duration_seconds": 8,
  "style_id": "<string>",
  "brand_kit_id": "<string>",
  "parent_video_id": "<string>"
}
'
{
  "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.

Example:

"A spinning rainbow wheel."

​
outputs
object[]
required

Array of desired output configurations for export (format, aspect, resolution, etc). Maximum of 10 outputs.

Maximum array length: 10
Example:
[
  {
    "format": "mp4",
    "aspect_ratio": "16:9",
    "fps": "30",
    "resolution": "1080p"
  }
]
​
reference_image_url
string

Optional URL of a reference image.

​
reference_video_url
string

Optional URL of a reference video.

​
duration_seconds
number

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

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

Optional video ID to use as the base/parent for this generation. (e.g http://app.hera.video/motions/xxx?v=this-is-the-video-id, https://app.hera.video/templates/this-is-the-video-id)

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.