Skip to main content

Welcome to Knowlify API

Knowlify provides three powerful APIs for video generation, each optimized for different use cases:

Parameters

Each script accepts different parameters based on the action type. Grant and Prism scripts share similar parameters, while the modify API has its own specific parameters for video modification.

Parameter Reference

ParameterGrantPrismModify APIDescription
task/queryRequiredRequiredRequiredThe instruction or prompt for video generation/modification
actionRequiredRequiredRequired"finetuned_live_gen", "Pre-Rendered", or "modify"
api_keyRequiredRequiredOptionalYour authentication API key for accessing the service
logoOptionalOptionalNot AvailableCustom logo to display in the video
languageOptionalOptionalNot AvailableLanguage for the video narration
voice_nameOptionalOptionalNot AvailableCustom voice for the video narration
background_colorNot AvailableOptionalNot AvailableCustom background color for the video
qualityNot AvailableOptionalNot AvailableVideo quality setting: “low”, “medium”, “high” (default), or “production”
linkNot AvailableNot AvailableRequiredURL of the original video to be modified
timestampNot AvailableNot AvailableRequiredTimestamp where the modification should be applied (e.g., “6:18”)

VTT Files

Alongside the video link, the API also returns a VTT (WebVTT) file containing subtitles and captions for the generated video. What is a VTT File? A VTT file is a standard format for displaying timed subtitles and captions that synchronize with video playback.

API Response

When your video generation is complete, you’ll receive both the video link and the VTT file URL in the response. Example Response:
{
  "video_link": "https://knowlify-videos1.s3.us-west-2.amazonaws.com/video.mp4",
  "vtt_file": "https://knowlify-videos1.s3.us-west-2.amazonaws.com/subtitles.vtt",
  "status": "completed"
}

Getting Started

  1. Get your API key from the Knowlify team
  2. Choose your endpoint based on your speed vs. quality needs
  3. Make your first request using the examples in each API section