FastSVD - Text to Video

FastSVD Text to Video is designed to generate videos from text prompts quickly and efficiently, delivering high-quality outputs in a short amount of time.

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.

Request Body Parameters

Below are the parameters for multipart/form-data that allow for a high degree of customization when generating videos.

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="fast-svd"' \
--form 'aspect_ratio="1:1"'

Response

Upon a successful request, the API returns this response:

$
{
  "id": "<video-id>",
  "status": "processing"
}

Status API

The Status API allows users to check the progress and current state of their video generation requests. By providing a unique video ID, users can retrieve real-time updates on whether the video is still processing, completed, or encountered an error.

Status Endpoint

The endpoint for Status API is

$
POST https://api.vyro.ai/v2/assets/{id}/status

Status Headers

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

Example Status API Call

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

$
curl --location --request GET 'https://api.vyro.ai/v2/assets/{id}/status' \
--header 'Authorization: Bearer {{API_TOKEN}}' 

Status Response

Upon a successful request, the API returns this JSON:

$
{
  "status": "success",
  "video": {
    "uuid": "<video-id>",
    "created_at": "2025-03-04T07:09:25.048523Z",
    "status": "finished",
    "url": {
      "generation": "<video-url>",
      "thumbnail": "<thumbnail-url>"
    }
  }
}

Error Handling

This section provides an in-depth explanation of errors encountered while interacting with Imagine’s system. Errors are categorized to help you pinpoint issues and apply effective solutions.

Error Schema

In case of any error, the API will return a response in the following JSON format:

$
{
  "status": "error",
  "code": "<error-code>",
  "error": "<error-name>",
  "message": "<detailed-error-description>"
}

This structure ensures consistency in error handling and provides clear information for debugging and resolution.

Errors in the Imagine system are grouped into four main categories:

• Authorization Errors
• Validation Errors
• Service Errors
• General Errors

Each category is explored in detail below.

Authorization Errors

Authorization errors relate to user authentication and access privileges. Common errors include:

Validation Errors

Validation errors occur when submitted data does not meet criteria. Example:

Service Errors

Service errors can arise due to server or connectivity issues:

General Errors

General errors are broad error categories covering multiple issues:

If you face Service Error or General Errors, please reach out to Imagine Support as soon as possible.