GET
/
project
/
assets
/
video
/
{id}
/
curl --request GET \
  --url https://api.deepreel.com/project/assets/video/{id}/ \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "video_status": "Pending",
  "avatar": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "language": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "creator": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "script_plain_text": "<string>",
  "background_color": "<string>",
  "aspect_ratio": "16:9",
  "created_at": "2023-11-07T05:31:56Z",
  "audio_download_url": "<string>",
  "video_duration": 123,
  "video_download_url": "<string>"
}

Authorizations

X-API-KEY
string
headerrequired

Your API key with the prefix: dr_. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the account settings panel (In the bottom left corner click on your Account → profile)

Path Parameters

id
string
required

A UUID string identifying this video.

Response

200 - application/json
id
string
required

Unique Identifier of the Video.

title
string
required

Name of the Video.

video_status
enum<string>
required

Status of the video i.e. whether it's completed or failed.

  • Pending - Pending
  • Complete - Complete
  • Queued - Queued
  • Processing - Processing
  • Failed - Failed
Available options:
Pending,
Complete,
Queued,
Processing,
Failed
avatar
object
required

Avatar used for video generation.

language
object
required

Language used to generated the video. null incase video was created from audio.

creator
object
required

Detail of the user who generated the video.

script_plain_text
string
required

Plain text script used to create the video. null incase video was created from audio.

background_color
string
required

The background color video. A six-bit hex color code starts with #. (e.g. #DRDRDR)

aspect_ratio
enum<string>
required

Aspect ratio of the video.

  • 16:9 - 16:9 - Standard widescreen
  • 9:16 - 9:16 - Vertical
  • 4:3 - 4:3 - Traditional TV format
  • 1:1 - 1:1 - Square
Available options:
16:9,
9:16,
4:3,
1:1
created_at
string
required

DateTime when the video generation was requested.

audio_download_url
string
required

Url of the audio track used to generate the video. Note: Link will be valid for the next 60 minutes.

video_duration
integer
required

Duration of the generated video in seconds.

video_download_url
string
required

URL of the generated video. Note: Link will be valid for the next 60 minutes.

Get list of Videos generatedDelete a generated video