Skip to main content
POST
/
project
/
assets
/
generate_video_from_audio
cURL
curl --request POST \
  --url https://api.deepreel.com/project/assets/generate_video_from_audio/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "aspect_ratio": "16:9",
  "audio_url": "<string>",
  "background_color": "#3D3D3D",
  "background_image": "<string>",
  "title": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "estimated_completion_time": 123,
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

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)

Body

​
avatar_id
string<uuid>
required

The avatar to be used to generate the video

​
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
​
audio_url
string<uri>
required

A public HTTPS link of an audio file (mp3).

​
background_color
string
default:#3D3D3D

The background color video. A six-bit hex color code starts with #. (e.g. #DRDRDR) NOTE: The background_image will get preference over background_color if both are specified.

​
background_image
string<uri> | null

A public HTTPS link of an image (jpg/jpeg/png).

​
title
string | null

Title of the video. Length should be less than 100 characters.

Response

​
id
string<uuid>
required

Unique Identifier of the video.

​
estimated_completion_time
integer

Video generation estimated completion time in seconds.

​
message
string

Extra detail.