Sign in

v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
V4 Avatars

Create a Video

post/expressives

Headers

x-api-key-externalstring

Request body

namestring

The name of the video

avatar_idstring required

The id of the avatar of the video

sentiment_idstring

The chosen sentiment id of the video

user_datastring
persistboolean
result_urlstring

The result url of the video. Cannot be provided together with config.result_format.

webhookstring

Example request

{
  "name": "my_expressive_video",
  "avatar_id": "public_dan@abcefg",
  "sentiment_id": "snt_IIjpTS",
  "config": {
    "logo": {
      "position": [
        0,
        500
      ]
    },
    "result_format": "mp4"
  },
  "background": {
    "value": "#47ffff"
  },
  "result_url": "https://example.com/result.mp4",
  "script": {
    "provider": {
      "voice_id": "en-US-JennyNeural",
      "voice_config": {
        "rate": "0.5",
        "pitch": "+2st"
      },
      "language": "English (United States)"
    },
    "input": "Making videos is easy with D-ID",
    "dictionary_id": "dict_V1StGXR8_Z5jdHi6B-myT"
  }
}

Response

Created

idstring required

The id of the expressive video

status'created' | 'done' | 'error' | 'started' | 'rejected' required
created_atstring required

The date the video was created

object'expressive' required

Example response

{
  "created_at": "2021-01-01T00:00:00.000Z"
}