Skip to main content
GET

Overview

Templates are pre-configured projects that allow you to create videos by replacing variables like {{name}}, {{product}}, etc.

Using Templates

Once you have a template, you can create videos by replacing the variables:

Step 1: Get Template Details

Step 2: Understanding Scene Structure

Each scene contains:
  • script: The narration text with {{variables}}
  • variables: Array of variable objects, each with:
    • key: Variable name (e.g., “first_name”)
    • type: Either “text” (from script/text overlays) or “media” (from image/video/audio overlays)
    • value: Example value - text for “text” type (e.g., “John Doe”), URL for “media” type (e.g., “https://cdn.example.com/image.jpg”)
  • avatar: Position and ID of the avatar (if any)
  • caption: Position of captions (if enabled)
Variable Types:
  • type: "text": From script ({{first_name}}) or text overlays
  • type: "media": From image/video/audio overlays (via variableName property)

Step 3: Create Video from Template

The system will:
  1. Load the template with all scenes
  2. Replace text variables in scripts and overlays
  3. Replace media variables (images, videos, audio) with provided URLs
  4. Apply avatar and caption positioning from template
  5. Generate the video

Variable Format

Variables in templates use double curly brackets: {{variable_name}} Example script:
Variables to replace:
  • name
  • product
  • customer_count
  • benefit
  • website

Creating Templates

Templates are currently created through the SlideVid dashboard. API creation will be available soon.
To create a template:
  1. Create a project in the dashboard
  2. Use {{variable}} syntax in your script
  3. Mark the project as a template
  4. The template will appear in the API

Use Cases

Create personalized video messages for each customer:
Generate product demos with different features:
Create course content at scale:
Generate property tour videos:

Best Practices

Keep variable names descriptive: Use customer_name instead of just name for clarity
Test with sample data: Always test your template with sample variables before production
Document your variables: Keep track of what variables each template expects
All variables must be provided: If a variable in the template is not provided in the API call, the video generation will fail

Example: Bulk Personalized Videos

Template Details

Get detailed information about a specific template

Generate from Template

Create a video from a template

List Avatars

Browse available avatars for templates

List Voices

Browse available voices for templates

Authorizations

x-api-key
string
header
required

Response

200

Success