Delete API

The Delete API allows users to remove previously generated videos from the system. By providing a unique video ID, users can permanently delete videos they no longer need, ensuring efficient storage management and data privacy.

Key Features

• Permanent Video Removal: Securely delete generated videos from the system.

• Unique Identifiers: Remove videos using a specific video ID.

• Storage Optimisation: Free up storage by eliminating unwanted or outdated content.

• Seamless Integration: Automate deletion as part of content lifecycle management.

Strategic Value

With AI-generated videos taking 10-15 minutes to process, managing storage efficiently is crucial. The Delete API helps maintain a clean and organised workspace by allowing users to remove unnecessary videos, optimising resource usage.

UseCase

• Content Management Platforms: Enable users to delete outdated videos as needed.

• Automated Cleanup Workflows: Integrate deletion into scheduled maintenance tasks.

• Privacy Compliance: Allow users to remove personal or sensitive content securely.

• Storage Optimisation: Prevent accumulation of unnecessary files, reducing costs.

The Delete API ensures better resource management by providing a reliable way to remove AI-generated videos, keeping workflows efficient and storage well-managed.

Endpoint

The endpoint for Text to Image API is

POST https://api.vyro.ai/v2/video/delete/{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 DELETE 'https://api.vyro.ai/v2/video/delete/{id}' \
--header 'Authorization: Bearer {{API_TOKEN}}' \

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

Response

Upon a successful request, the API returns a json file

{
    "message": "video deleted",
    "status": "success"
}

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.