βœ… Clips Overview


Enabling FULL-HD photorealistic avatars using just text or audio as input. Premium PresentersΒ (Clips) is an easy-to-use endpoint that lets users and developers supercharge training presentations, corporate communications, sales, marketing content and more. The technology allows users to add virtual presenters to slides to create more engaging presentations, with just a few lines of code.

βœ… Interface

Input
Premium Presenter + Text or Audio file URL
Output
Video URL


Presenter ID Text / Audio Video

βœ… Example #1: Default Call

POST https://api.d-id.com/clips | Create a clip

{
    "script": {
        "type": "text",
        "input": "Hello world!"
    },
    "presenter_id": "amy-jcwCkr1grs",
    "driver_id": "uM00QMwJ9x"
}
{
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "created_at": "2023-03-22T21:33:52.454Z",
    "object": "clip",
    "status": "created"
}

GET https://api.d-id.com/clips/<id> | Get a specific clip

Empty request body
See the Response tab
{
    "metadata": {
        "num_frames": 41,
        "processing_fps": 15.429858021131948,
        "resolution": [
            1920,
            1080
        ],
        "size_kib": 189.255859375
    },
    "audio_url": "https://d-id-clips-prod.s3.us-west-2.amazonaws.com/google-oauth2%7C10396q34341765131871486/clp_auvOUSOANX95VaLCKb2Il/microsoft.wav?AWSAccessKeyId=AKIA5SDFDSFIJ7CPKJNP&Expires=1679607232&Signature=%2Fo97jLpizsFfunCJKjEseb8OsPE%3D",
    "created_at": "2023-03-22T21:33:52.454Z",
    "config": {
        "logo": {
            "url": "ai",
            "position": [
                0,
                0
            ]
        },
        "result_format": ".mp4"
    },
    "source_url": "https://clips-presenters.d-id.com/amy/jcwCkr1grs/uM00QMwJ9x/thumbnail.png",
    "created_by": "google-oauth2|12345678",
    "status": "done",
    "driver_id": "uM00QMwJ9x",
    "modified_at": "2023-03-22T21:34:01.025Z",
    "completed_at": "2023-03-22T21:34:00.924",
    "presenter_id": "amy-jcwCkr1grs",
    "result_url": "https://d-id-clips-prod.s3.us-west-2.amazonaws.com/google-oauth2%7C1039658317634543586/clp_auvOUSOADFGDFKb2Il/amy-jcwCkr1grs.mp4?AWSAccessKeyId=AKIA5CUMPJBIJ7CPKJNP&Expires=1679607241&Signature=UjgamgTtNfSNL2IUiOOMSMBOI0U%3D",
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "duration": 2,
    "started_at": "2023-03-22T21:33:52.978",
    "owner_id": "google-oauth2|12345678"
}

The output video is located in the result_url field.

πŸ“˜

Note

The output video is ready only when "status": "done"

status field lifecycle:

"status": "created"When posting a new clips request
"status": "started"When starting the video processing
"status": "done"When the video is ready

Default presenters list:

actor_idpresenter_iddriver_id
amyamy-jcwCkr1grsuM00QMwJ9x
danieldaniel-OQqudmmhznl7bx4jMCdO
mattmatt-B47mX1i8GNXlLcUhu4cg

πŸ‘

Presenters list

In order to get the most updated presenters list, you should make a call to /clips/actors endpoint

GET https://api.d-id.com/clips/actors | Get actors list

Empty request body
See the Response tab
{
    "actors": [
        {
            "id": "amy",
            "created_at": "2022-10-23T15:55:15.087Z",
            "thumbnail_url": "https://clips-presenters.d-id.com/amy/thumbnail.png",
            "image_url": "https://clips-presenters.d-id.com/amy/image.png",
            "gender": "female",
            "modified_at": "2022-10-23T15:55:15.087Z"
        },
        {
            "id": "daniel",
            "created_at": "2022-10-23T15:55:15.087Z",
            "thumbnail_url": "https://clips-presenters.d-id.com/daniel/thumbnail.png",
            "image_url": "https://clips-presenters.d-id.com/daniel/image.png",
            "gender": "male",
            "modified_at": "2022-10-23T15:55:15.087Z"
        },
        {
            "id": "jess",
            "created_at": "2022-11-24T09:42:30.168Z",
            "thumbnail_url": "https://clips-presenters.d-id.com/jess/thumbnail.png",
            "image_url": "https://clips-presenters.d-id.com/jess/image.png",
            "gender": "female",
            "modified_at": "2022-11-24T09:42:30.168Z"
        },
        {
            "id": "matt",
            "created_at": "2022-10-23T15:55:15.087Z",
            "thumbnail_url": "https://clips-presenters.d-id.com/matt/thumbnail.png",
            "image_url": "https://clips-presenters.d-id.com/matt/image.png",
            "gender": "male",
            "modified_at": "2022-10-23T15:55:15.087Z"
        },
        {
            "id": "trevor",
            "created_at": "2022-10-23T15:55:15.087Z",
            "thumbnail_url": "https://clips-presenters.d-id.com/trevor/thumbnail.png",
            "image_url": "https://clips-presenters.d-id.com/trevor/image.png",
            "gender": "male",
            "modified_at": "2022-10-23T15:55:15.087Z"
        }
    ]
}

πŸ‘

Drivers list

In order to get the most updated drivers list per actor, you should make a call to /clips/actors/<id>/drivers endpoint

GET https://api.d-id.com/clips/actors/{id}/drivers | Get drivers list of an actor

Empty request body
See the Response tab
{
    "clips_drivers": [
        {
            "presenter_id": "amy-jcwCkr1grs",
            "driver_id": "uM00QMwJ9x",
            "driver_type": "scene",
            "gender": "female",
            "created_at": "2022-09-06T09:55:02.599Z",
            "modified_at": "2022-09-06T09:57:38.704Z",
            "driver_image_url": "https://clips-presenters.d-id.com/amy/jcwCkr1grs/uM00QMwJ9x/image.png",
            "thumbnail_url": "https://clips-presenters.d-id.com/amy/jcwCkr1grs/uM00QMwJ9x/thumbnail.png",
            "video_url": "https://clips-presenters.d-id.com/amy/jcwCkr1grs/uM00QMwJ9x/video.mp4",
            "preview_url": "https://clips-presenters.d-id.com/amy/jcwCkr1grs/uM00QMwJ9x/preview.mp4"
        }
    ]
}

βœ… Example #2: Webhooks

Simply create an endpoint on your side and add it in the webhook field.
Then the webhook endpoint will be triggered with the same response body once the video is ready.

POST https://api.d-id.com/clips | Create a clip

{
    "script": {
        "type": "text",
        "input": "Hello world!"
    },
    "presenter_id": "amy-jcwCkr1grs",
    "driver_id": "uM00QMwJ9x",
    "webhook": "https://myhost.com/webhook"
}
{
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "created_at": "2023-03-22T21:33:52.454Z",
    "object": "clip",
    "status": "created"
}
{
    "metadata": {
        "num_frames": 41,
        "processing_fps": 15.429858021131948,
        "resolution": [
            1920,
            1080
        ],
        "size_kib": 189.255859375
    },
    "audio_url": "https://d-id-clips-prod.s3.us-west-2.amazonaws.com/google-oauth2%7C10396q34341765131871486/clp_auvOUSOANX95VaLCKb2Il/microsoft.wav?AWSAccessKeyId=AKIA5SDFDSFIJ7CPKJNP&Expires=1679607232&Signature=%2Fo97jLpizsFfunCJKjEseb8OsPE%3D",
    "created_at": "2023-03-22T21:33:52.454Z",
    "config": {
        "logo": {
            "url": "ai",
            "position": [
                0,
                0
            ]
        },
        "result_format": ".mp4"
    },
    "source_url": "https://clips-presenters.d-id.com/amy/jcwCkr1grs/uM00QMwJ9x/thumbnail.png",
    "created_by": "google-oauth2|12345678",
    "status": "done",
    "driver_id": "uM00QMwJ9x",
    "modified_at": "2023-03-22T21:34:01.025Z",
    "completed_at": "2023-03-22T21:34:00.924",
    "presenter_id": "amy-jcwCkr1grs",
    "result_url": "https://d-id-clips-prod.s3.us-west-2.amazonaws.com/google-oauth2%7C1039658317634543586/clp_auvOUSOADFGDFKb2Il/amy-jcwCkr1grs.mp4?AWSAccessKeyId=AKIA5CUMPJBIJ7CPKJNP&Expires=1679607241&Signature=UjgamgTtNfSNL2IUiOOMSMBOI0U%3D",
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "duration": 2,
    "started_at": "2023-03-22T21:33:52.978",
    "owner_id": "google-oauth2|12345678"
}

βœ… Example #3: Text to Speech

Choose different voices, languages, and styles. See the supported Text-to-Speech providers' voices list

POST https://api.d-id.com/clips | Create a clip

{
    "script": {
        "type": "text",
        "input": "Hello world!",
        "provider": {
            "type": "microsoft",
            "voice_id": "en-US-JennyNeural",
            "voice_config": {
                "style": "Cheerful"
            }
        }
    },
    "presenter_id": "amy-jcwCkr1grs",
    "driver_id": "uM00QMwJ9x"
}
{
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "created_at": "2023-03-22T21:33:52.454Z",
    "object": "clip",
    "status": "created"
}

βœ… Example #4: Audio script

Using an audio file instead of a text

POST https://api.d-id.com/clips | Create a clip

{
    "script": {
        "type": "audio",
        "audio_url": "https://path.to/audio.mp3"
    },
    "presenter_id": "amy-jcwCkr1grs",
    "driver_id": "uM00QMwJ9x"
}
{
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "created_at": "2023-03-22T21:33:52.454Z",
    "object": "clip",
    "status": "created"
}

βœ… Example #5: Background

Change the background color. Use HEX color format.

POST https://api.d-id.com/clips | Create a clip

{
    "script": {
        "type": "audio",
        "audio_url": "https://path.to/audio.mp3"
    },
    "presenter_id": "amy-jcwCkr1grs",
    "driver_id": "uM00QMwJ9x",
    "background": {
        "color": "#aa22cc"
    }
}
{
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "created_at": "2023-03-22T21:33:52.454Z",
    "object": "clip",
    "status": "created"
}

Transparent background. Available only in webm format.

POST https://api.d-id.com/clips | Create a clip

{
    "script": {
        "type": "audio",
        "audio_url": "https://path.to/audio.mp3"
    },
    "presenter_id": "amy-jcwCkr1grs",
    "driver_id": "uM00QMwJ9x",
    "config": {
        "result_format": "webm"
    },
    "background": {
        "color": false
    }
}
{
    "id": "clp_auvOUSOANX95VaLCKb2Il",
    "created_at": "2023-03-22T21:33:52.454Z",
    "object": "clip",
    "status": "created"
}

βœ… Video Tutorial

D-ID's API - Clips Endpoint
Live Coding Session


βœ… Support


Have any questions? We are here to help! Please leave your question in the Discussions section and we will be happy to answer shortly.

Ask a question