Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hera.video/llms.txt

Use this file to discover all available pages before exploring further.

The Hera MCP server lets AI assistants generate motion graphics videos on your behalf. It exposes the same capabilities as the REST API, but through the standardized Model Context Protocol — so your AI tools can call Hera directly.

Prerequisites

Available tools

The MCP server exposes three tools:
ToolDescription
create_videoCreate a new video generation job from a text prompt and output configurations. Returns a video_id for polling.
get_videoCheck the status of a video job and retrieve download URLs for completed outputs.
upload_fileUpload a file (image, video, audio, font, or CSV) for use as model input. Returns a hosted URL.

Setup

Run the following command in your terminal:
claude mcp add --transport http hera https://mcp.hera.video/mcp --header "x-api-key: YOUR_API_KEY"
Replace YOUR_API_KEY with your actual API key.

Example workflow

Once connected, you can ask your AI assistant to generate videos naturally:
“Create a 10-second 1080p MP4 video of a spinning globe with a blue gradient background”
Behind the scenes, the assistant will:
  1. Call create_video with your prompt and output settings
  2. Receive a video_id
  3. Poll get_video until the status is success
  4. Return the download URL

Tool reference

create_video

Creates a new video generation job. Parameters:
ParameterTypeRequiredDescription
promptstringYesText prompt describing the video to generate.
outputsarrayYes1-10 output configurations (see below).
reference_image_urlstringNoURL of a reference image.
reference_image_urlsstring[]NoUp to 5 reference image URLs.
reference_video_urlstringNoURL of a reference video.
duration_secondsnumberNoDuration in seconds (1-60).
style_idstringNoStyle ID for consistent branding.
parent_video_idstringNoVideo or template ID to use as a base.
assetsarrayNoArray of asset objects ({ type, url }) to include. Use upload_file to get URLs.
Output configuration:
FieldTypeOptions
formatstringmp4, prores, webm, gif
aspect_ratiostring16:9, 9:16, 1:1, 4:5
fpsstring24, 25, 30, 60
resolutionstring360p, 480p, 720p, 1080p, 4k
Returns: video_id and project_url.

get_video

Retrieves the status and download URLs for a video job. Parameters:
ParameterTypeRequiredDescription
video_idstringYesThe video ID returned by create_video.
Returns: video_id, status (in-progress, success, or failed), project_url, and an outputs array with individual status, download URL, config, and error (if any).

upload_file

Uploads a remote file to Hera’s CDN for use as model input. For local files, pass the local path and the tool will return a ready-to-use curl command. Parameters:
ParameterTypeRequiredDescription
urlstringYesHTTP or HTTPS URL of the file to upload. For local files, pass the path to get a curl command.
file_namestringNoCustom filename (e.g. logo.png). Inferred from the URL if omitted.
Supported types: images (PNG, JPEG, GIF, SVG, WebP, BMP), videos (MP4, MPEG, WebM, MOV, AVI, FLV, MPG, WMV, 3GP), audio (MP3, WAV, AAC), fonts (TTF, OTF, EOT, WOFF, WOFF2), and CSV. Max size: 10 MB. Returns: url — the hosted URL to pass to create_video fields like reference_image_url, reference_image_urls, reference_video_url, or assets.
Looking for support or have questions? Email us at [email protected].