You can use the List videos endpoint to get an overview of all videos generated (and not in draft) in your Synthesia account.

Query Parameters

The SOURCE query parameter is optional.

When specified, the results will only include videos from the given source. Otherwise, the results will include videos from all sources.

You can specify that the result should only include videos from the workspace (workspace), or that it should only include your private videos (my_videos), or that it should only include videos that have been shared with you (shared_with_me).

Status-specific Results

A video's status may be in_progress for 2-40 minutes.

If the video's status is completed, the response will include time-limited download URLs for the:

  • captions in .srt and .vtt formats
  • video file in .mp4 format
  • static thumbnail in .jpg format
  • animated thumbnail in .gif format (if a GIF thumbnail is present)

If the video is published and the call-to-action option is enabled, the response will include the label and URL specified in the video's call-to-action settings.

Language
Authorization
Header
Click Try It! to start a request and see the response here!