Getting Started

Quickstart

Get started with VidRouter in under 5 minutes. This guide will walk you through making your first API call.

Prerequisites: You'll need a VidRouter API key. Get one from your account settings.

Step 1: Get Your API Key

First, you'll need to get your API key from the VidRouter dashboard.

Get API Key

Step 2: Choose Your Model

VidRouter supports multiple AI video generation models. Let's see what's available:

GET

List Available Models

curl -X GET "https://api.vidrouter.com/v1/models" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Step 3: Generate Your First Video

Now let's generate a video using one of the available models:

POST

Create Generation

curl -X POST "https://api.vidrouter.com/v1/generations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "runway-gen3",
    "prompt": "A serene lake surrounded by mountains at sunset",
    "duration": 5,
    "aspect_ratio": "16:9"
  }'

Step 4: Check Generation Status

Video generation takes time. Use the generation ID to check the status:

GET

Check Generation Status

curl -X GET "https://api.vidrouter.com/v1/generations/{generation_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Note: Video generation can take anywhere from 30 seconds to several minutes depending on the model and video length.

Next Steps

Authentication Guide

Learn more about API key management and security best practices.

API Reference

Explore all available parameters and response formats.