Status API

he 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.

Key Features

• Real-Time Tracking: Monitor the status of video generation, from processing to completion.

• Unique Identifiers: Retrieve status updates using a video-specific ID.

• Error Handling: Get notifications if a request fails or requires adjustments.

• Efficient Workflow Integration: Enable seamless automation by checking the progress before downloading the final output.

Strategic Value

Since video generation takes 10-15 minutes, the Status API ensures users can efficiently manage their workflow by tracking progress without unnecessary manual checks. This helps optimize processing time and resource allocation.

Use Cases

• Content Creation Platforms: Allow users to track video generation progress in real-time.

• Automated Workflows: Integrate status checks to trigger actions once a video is ready.

• Error Resolution: Identify failed requests early to make necessary adjustments.

• User Notifications: Inform users when their video is complete and ready for download.

This Status API provides an essential tool for managing video processing, ensuring transparency and efficiency in automated video generation workflows.

Endpoint

The endpoint for Text to Image API is

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

Headers

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

Authorization

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

Authorization: Bearer {{API_TOKEN}}

Example API Call

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

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

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

Response

Upon a successful request, the API returns a binary json file

{
    "status": "success",
    "video": {
        "uuid": "93d32bb4-6b49-41d6-b073-2414a622212b",
        "thumbnail": "93d32bb4-6b49-41d6-b073-2414a622212b",
        "created_at": "2025-03-04T07:09:25.048523Z",
        "status": "finished",
        "code": 2,
        "settings": {
            "prompt": [
                "a flying dinosaur"
            ],
            "style_id": [
                "11002"
            ],
            "variation": [
                "text_to_video"
            ]
        },
        "url": {
            "generation": "https://video-to-video.20e6264b3285ab3e9b554e17efb157b9.r2.cloudflarestorage.com/processed/93d32bb4-6b49-41d6-b073-2414a622212b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=37a8d5ca7a564da7ba5bb455d852b72b%2F20250327%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20250327T083420Z&X-Amz-Expires=10800&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=ca0d0b991e96f4ea0f0cdf6ed1aed386fe054a33ff65cd520441711bd345fc7c",
            "thumbnail": "https://video-to-video.20e6264b3285ab3e9b554e17efb157b9.r2.cloudflarestorage.com/video/thumbnails/93d32bb4-6b49-41d6-b073-2414a622212b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=37a8d5ca7a564da7ba5bb455d852b72b%2F20250327%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20250327T083420Z&X-Amz-Expires=10800&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=3ea21086ad54f669aa7fe1915d8925f8469725f7b9244cdd953f5f11573f2498"
        }
    }
}

Response Attributes:

• status: "status" attribute inside the "video" tells the current status "Pending", "Processing", "Success", "Failed"

Error Handling

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