Single Video Status

This API guide offers an overview of how to track status of single video requests.

---

This API allows users to check the status of a video request by providing the video ID. The response includes:

• status: Indicates the current state of the video request (Pending, Completed, or Failed). If Pending, the video is still being generated and will be ready soon. If Completed, the video has been successfully generated. If Failed, the video generation has failed.

• video_url: If Completed, it contains the URL to access the video. If Pending, it notes that the video is in progress. If Failed, it indicates the video generation was unsuccessful.

RequestResponse(Pending)Response(Completed)Response(Failed)

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

{   
    "status": "Pending",
    "video_url": "Video generation in progress, will be ready soon!"
}

{   
    "status": "Completed",
    "video_url": "https://api.immersive-fox.com/v/<video_hash>"
}

{   
    "status": "Failed",
    "video_url": "Video generation failed, no video url is available!"
}