GigaReels LogoGigaReels

Introduction

Welcome to the GigaReels documentation

Introduction

Welcome to the GigaReels documentation. Here you will find everything you need to get started with our powerful video creation API.

Quick Start

Follow these steps to get your local environment set up and ready to use GigaReels.

1. Install the SDK

You can install the GigaReels SDK using your favorite package manager.

pnpm add gigareels-sdk
npm install gigareels-sdk
yarn add gigareels-sdk

2. Set up your API Key

To use the GigaReels API, you need an API key. You can get one from your dashboard.

Once you have your key, you can set it as an environment variable:

export GIGAREELS_API_KEY="YOUR_API_KEY"

3. Make your first API call

Now you're ready to create your first video! Here's an example of how to add a text overlay to a video.

import { GigaReels } from 'gigareels-sdk';

const gigareels = new GigaReels({
  apiKey: process.env.GIGAREELS_API_KEY,
});

async function createVideo() {
  const render = await gigareels.render.text({
    videoUrl: 'https://example.com/my-video.mp4',
    textOverlays: [
      {
        text: 'Hello, World!',
        start: 0,
        end: 5,
      },
    ],
  });

  console.log('Render started with ID:', render.id);
}

createVideo();