POST
/
project
/
assets
/
generate_video_from_text
/
curl --request POST \
  --url https://api.deepreel.com/project/assets/generate_video_from_text/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "background_color": "<string>",
  "background_image": "<string>",
  "aspect_ratio": "16:9",
  "title": "<string>",
  "slate_script": [
    {
      "children": [
        {
          "text": "<string>"
        }
      ]
    }
  ],
  "language_id": 123,
  "stability": 0.5,
  "style_exaggeration": 0.5
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "estimated_completion_time": 123,
  "message": "<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 Accountprofile)

Body

application/json
avatar_id
string
required

The avatar to be used to generate the video

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 | null

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

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
title
string | null

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

slate_script
object[]
required
language_id
integer
default: 94

Language used to generate the audio. Language Id for English - Default (en-us) is 94

stability
number
default: 0.5

This controls the level of variation in generated audio. Low stability will increase expressiveness of speech while high stability will lower expressiveness but increase the predictability of how the script is spoken.

style_exaggeration
number
default: 0

Level of exaggeration of the speaking style. Available only for custom voices. Higher values will make increase similarity of cloned voice but may cause the audio to be less stable.

Response

200 - application/json
id
string
required

Unique Identifier of the video.

estimated_completion_time
integer

Video generation estimated completion time in seconds.

message
string

Extra detail.