v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB

Clips (Premium Avatars)

Create a clip

post/clips

Headers

x-api-key-externalstring

Use your own ElevenLabs API key for TTS (IVC voices only), consuming your ElevenLabs quota. Example: {"elevenlabs": "ABCDEFGH123456"}

Request body

presenter_idstring

a selection from the list or provided driver ids.

driver_idstring

a selection from the list or provided driver ids. If not provided a driver video will be selected for you from the predefined drivers bank.

user_datastring

namestring

The name of the clip

webhookstring

result_urlstring

Example request

{
  "presenter_id": "jack-Pt27VkP3hW",
  "driver_id": "Vcq0R4a8F0",
  "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"
  },
  "config": {
    "logo": {
      "position": [
        0,
        500
      ]
    },
    "output_resolution": 1080
  },
  "presenter_config": {
    "crop": {
      "rectangle": {
        "bottom": 1,
        "right": 1
      }
    }
  },
  "background": {
    "color": "#47ffff",
    "source_url": "https://path.to.image/"
  },
  "result_url": "https://path.to.directory/movie.mp4"
}

Response

Created

idstring required

The ID of the clip

object'clip' required

An identifier of this clip

created_atstring required

Clip creation time as iso-8601 string

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