Single Video Request

This API guide offers and overview of how to generate a signle video.

This API allows users to generate a video. The payload for this request includes an audio file mp3_audio in MP3 format and an actor_id, which specifies the actor to be used in the video.

The response contains:

  • id: A unique identifier for the video request, which can be used for tracking it's status.

  • status: Indicates the current state of the video request, typically Started or Pending.

  • video_progress_url: Provides a URL that users can use to monitor when the video will be completed.

curl --request POST \
     --url 'https://api.immersive-fox.com/v1/video_requests/generate_video/' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: multipart/form-data' \
      -F 'mp3_audio=@audio_file.mp3' \
      -F 'actor_id=<actor_id>' \

{   
    "id": 4395,
    "status": "Pending",
    "video_progress_url": "https://api.immersive-fox.com/v1/video_requests/status/4395",
}