B-roll Animation API

Dashboard & API Reference

Swagger UI ReDoc
Base URL

Quick Start

  1. GET /templates — list available templates
  2. GET /templates/{id} — inspect schema & example
  3. POST /render — start render job (include Authorization: Bearer <key>)
  4. POST /highlight-text/render — typed text-effect render route with stacked highlight layers and independent timing controls
  5. GET /render/status/{job_id} — poll until completed
  6. GET /render/download/{job_id} — download MP4

Text-effect variants also have focused schema routes such as GET /templates/highlight-text/underline and GET /templates/highlight-text/ellipse.

2D Infographics

Chart and data-visualization templates rendered through the generic POST /render endpoint. Open the documented output parameter to set render-level controls such as output.fps and output.frames.

Text Effects

Typography-focused templates for reveals, callouts, and highlight treatments. Use output.fps to change frame rate and output.frames to control total duration. highlight-text also supports background video syncing when output.frames is omitted. Use a remote URL or a file placed in remotion/public, such as highlight-text-sample-bg.mp4. The dashboard shows all 7 highlight-style previews with matching curl payloads.

For highlight-text, use highlight_target for a single decorated word or phrase, or highlight_layers to combine multiple targets and styles in one render. Set in_animation or out_animation to "none" to disable motion. Use ellipse_variant: "auto" to let the renderer choose a fitting hand-drawn ellipse, and optionally pass ellipse_seed when you want deterministic selection. Use \n inside text_content for manual line breaks; otherwise the text stays on one line and scales down instead of auto-wrapping.

Pre-selected Styles

Add "style": "name" to your render request body to apply a complete visual preset (colors, fonts, backgrounds, effects). User-provided values always take precedence.