Skip to main content

Tutorial Intro

Let's discover Vikit.ai in less than 5 minutes.

Getting Started​

Get started by building a basic AI video generator.

Or try a sample Vikit.ai AI Video Generator immediately with our Creative AI platform.

Requirements for local installation​

  • Python 3.8+
  • requirements.txt contains requirements for python environment
  • FFMPEG and FFPROBE (on mac, using homebrew: brew install ffmpeg and on linux, using apt-get: sudo apt-get install ffmpeg)
  • ImageMagick (for subtitles only)
sudo apt-get install ffmpeg
git clone https://github.com/Vikit-ai/sdk
cd sdk
pip install -r requirements.txt

sudo apt-get install imagemagick #For mac : brew install imagemagick

Generate a simple video​

Generate a simple video using the PromptBasedVideo template.

  • First, create a Vikit API Key in the Vikit.ai Creative AI platform

  • Second, specify this Vikit API Key in the .env.secrets.dev file alongside your Vikit.ai code

.env.secrets.dev
VIKIT_API_TOKEN=YOUR_VIKIT_API_KEY
  • Next, create a video_generator.py file using the PromptBasedVideo object
video_generator.py
import asyncio
from vikit.music_building_context import MusicBuildingContext
from vikit.prompt.prompt_factory import PromptFactory
from vikit.video.prompt_based_video import PromptBasedVideo
from vikit.video.video_build_settings import VideoBuildSettings
from vikit.common.context_managers import WorkingFolderContext

prompt_text = "A flock of birds takes flight, soaring gracefully over a vast, rolling landscape as the sun sets in the distance."

video_build_settings = VideoBuildSettings(
    music_building_context=MusicBuildingContext(
        apply_background_music=True,
        generate_background_music=True,
    ),
    include_read_aloud_prompt=True,
    output_video_file_name="video.mp4",
)

async def create_video():
    prompt = await PromptFactory().create_prompt_from_text(prompt_text)
    video = PromptBasedVideo(prompt=prompt)
    await video.build(build_settings=video_build_settings)

if __name__ == "__main__":
    with WorkingFolderContext("output_folder"):
        asyncio.run(create_video())
  • Now run this file

python3 video_generator.py

The output file will then be accessible in ./output_folder/video.mp4

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.