Sign in

v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
Scenes (Express Avatars)

Create a Scene

post/scenes

Headers

x-api-key-externalstring

Request body

avatar_idstring required

The avatar that will be used to create the scene.

webhookstring
user_datastring
namestring

The name of the scene

result_urlstring

The URL of the scene, if not provided use default destination.

Example request

{
  "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"
  },
  "result_url": "https://path.to.directory/movie.mp4",
  "config": {
    "logo": {
      "position": [
        0,
        500
      ]
    }
  },
  "background": {
    "color": "#47ffff",
    "source_url": "https://path.to.image/"
  }
}

Response

Created

idstring required

The ID of the scene

object'scene' required

An identifier of this scene

created_atstring required

Video creation time as iso-8601 string

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