LogoLogo
  • Welcome
  • Imagine API Studio
  • Get Your API Key
  • Imagine API Reference
  • Getting Started
    • How the API Works
    • API Key Management
    • Selecting the Right API Plan
    • Get Free API Calls
    • Your First API Call
    • Available AI Features in the API
    • Integrating the API into Your Project
    • API Call Billing and Token Usage
  • Troubleshooting
    • Request and Response Formats
    • Error Documentation
    • Troubleshooting Tips
    • Getting Support
  • Core Concepts
    • API Prototyping
    • Creating an Effective Prompt
    • Selecting the Right Style
    • Randomization Control (Seed)
  • Image Generation APIs
    • Introduction
    • Text to Image API
    • Text to PNG API
  • Image Editing APIs
    • Introduction
    • Background Remover API
    • Image Upscale API
    • Generative Fill API
    • AI Resize API
    • Retouch API
  • E-Commerce APIs
    • AI Backgrounds API
  • Video Generation API's
    • Introduction
    • Text to Video API
    • Image to Video API
    • Status API
    • Delete API
Powered by GitBook
On this page
  • Key Features
  • Strategic Value
  • Endpoint
  • Headers
  • Request Body Parameters
  • Example API Call
  • Response
  • Error Handling
  1. Video Generation API's

Text to Video API

PreviousIntroductionNextImage to Video API

Last updated 1 month ago

Turn text prompts into high-quality, dynamic videos in seconds. This AI-powered feature enables users to effortlessly generate unique, royalty-free videos with customizable motion, styles, and effects, offering flexibility for diverse creative applications.

For additional details on each parameter and its optimal use, check out the .

Key Features

• Automated Video Generation: Create high-quality videos from text prompts transforming ideas into dynamic visual content.

• Customisation: Control motion, styles, and effects to match specific creative needs.

• Versatility: Generate videos in various styles, from cinematic and animated to abstract, for digital content, and marketing.

• Refinement: Fine-tune results through iterative prompts and adjustments for precise, high-quality outputs.

Strategic Value

Enhance video creation efficiency while reducing production costs and resource demands. Though video generation takes 10-15 minutes, this AI-powered feature enables detailed, high-quality motion content without the need for complex animation tools, making it ideal for prototyping, content creation, and storytelling.

This AI-powered video generation feature provides businesses and creators with a powerful way to bring ideas to life, offering flexibility for a wide range of creative and professional applications.

Endpoint

The endpoint for Text to Video API is

POST https://api.vyro.ai/v2/video/text-to-video

Headers

You need to pass the following headers along with the request.

Authorization

Authorization: Bearer {{API_TOKEN}}

Request Body Parameters

Below are the parameters that allow for a high degree of customization when generating videos. Click on each parameter to learn more about its use and best practices:

prompt

prompt="A futuristic cityscape at night with neon lights"

style

style="kling-1.0-pro"

aspect_ratio

Defines the width-to-height ratio of the output video, such as "1:1" for square video. You can try other available aspect ratios such as "16:9" and "9:16".

aspect_ratio="1:1"

Example API Call

Here’s a sample curl request that uses the parameters above:

curl --location --request POST 'https://api.vyro.ai/v2/video/text-to-video' \
--header 'Authorization: Bearer {{API_TOKEN}}' \
--form 'prompt="A futuristic cityscape at night with neon lights"' \
--form 'style="kling-1.0-pro"' \
--form 'aspect_ratio="1:1"'

Response

Upon a successful request, the API returns a binary video file which can be directly rendered or saved.

Response Attributes:

  • video (binary): The generated video in binary format. You can decode and display or store it based on your application needs.

Error Handling

Pass your API token as a Bearer token in the Authorization header. Refer to the for guidance on managing your API keys.

The main text description of the video you want to generate. Use descriptive and detailed language to achieve optimal results. See .

Specifies the style of the generated video. Experiment with different styles to find the look that best suits your needs. See

For additional details on each parameter and its optimal use, check out the .

In case of errors, the response includes status codes and error messages. See the section for help with interpreting and resolving these errors.

Text to Video API References
Authorization Section
Selecting the Right Style
Text to Video API References
Creating Prompt
Errors and Troubleshooting