Skip to content

Video Listing

This API guide offers an overview of how to retrieve a list of your previously generated videos.

To obtain a list of videos that have already been generated and to check the total number of videos you have created, you can use this API. This endpoint will provide you with a comprehensive list of all previously generated videos, allowing you to review and manage your video creations efficiently. 🦊

Quick Start

Let’s delve into the process of retrieving a comprehensive list of all your previously generated videos.

Listing Bulk Requests

This API provides a comprehensive list of all your requests, and in the response, you will receive:

  • 'progress': The current progress of each request in percentage.
  • 'status': The overall status of each request.
  • 'video_links_csv': A file containing URLs for downloading the videos.

You can call this endpoint multiple time . This will return partial results in csv as well. When videos generation is in progress it will return status in-progress and progress will be below 100. If all videos are generated then the status will be completed and progress will be 100.

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/videos/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json' 

[
    {
        "id": 494,
        "csv_file_name": "my_contacts.csv",
        "progress": 34,
        "status": "in-progress",
        "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
    },
    {
        "id": 494,
        "csv_file_name": "my_employees.csv",
        "progress": 80,
        "status": "in-progress",
        "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_employee_videos.csv"
    }

]

[
    {
        "id": 494,
        "csv_file_name": "my_contacts.csv",
        "progress": 100,
        "status": "Completed",
        "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
    },
    {
        "id": 494,
        "csv_file_name": "my_employees.csv",
        "progress": 100,
        "status": "Completed",
        "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_employee_videos.csv"
    }

]