Skip to content

Video Status

This API guide provides an overview of the process for checking the status of your bulk request.

Bulk requests may take time to process, depending on the number of contacts in your CSV file. After initiating the request, you will need to check its status to monitor progress, which will be provided as a percentage. 🦊

Quick Start

Let’s dive in and explore how to check the progress of your bulk request.

Get Bulk Status

To check the progress of your bulk request, provide the 'id' as 'video_id' obtained from the request generation or through the bulk listing API. In response, you will receive:

  • 'progress': The current progress of the request in percentage.
  • 'status': The overall status of the request.
  • 'video_links_csv': Contains 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/video/<video_id>'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json' 

{
    "id": 494,
    "csv_file_name": "my_contacts.csv",
    "progress": 55,
    "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_contacts.csv",
    "progress": 100,
    "status": "Completed",
    "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
}