---
title: "Create a clip"
method: POST
path: "/clips"
tags: ["Clips (Premium Avatars)"]
---

# Create a clip

`POST /clips`

## Headers

- `x-api-key-external` string

## Request body

- CreateClipRequest
  - `presenter_id` string — a selection from the list or provided driver ids.
  - `driver_id` string — 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.
  - `script` union, required
    - TextScript3
      - `type` 'text', required — The type of the script.
      - `subtitles` boolean — Should subtitles be created.
      - `provider` union
        - MicrosoftTtsProvider
          - `type` 'microsoft', required
          - `voice_id` string, required — Voice ID selected from the list of available voices.</br>Retrieve available options from the GET /voices endpoint.
          - `voice_config` VoiceConfigMicrosoft
            - `style` string — The style of the voice. Available styles change between voices.
            - `rate` string — The speed of the voice. The value is relative to 1, 0.5 being half speed, 2 being twice as fast, etc. Another option is a constant value from x-slow/slow/medium/fast/x-fast.
            - `pitch` string — The pitch of the voice. Value could be an absolute value in Hz (including units), a relative value in Hz or st(semitones) or a constant value from x-low/low/medium/high/x-high.
          - `language` string — Voice customization options. To save the language of the selected agent voice
        - ElevenlabsTtsProvider
          - `type` 'elevenlabs', required
          - `voice_id` string — Voice ID selected from the list of available voices.</br>Retrieve available options from the GET /voices endpoint.
          - `voice_config` VoiceConfigElevenlabs
            - `stability` number, double — How stable the voice is and the randomness of each new generation. If ElevenLabs V3 model is selected, must be one of these values: 0.0, 0.5, 1.0 (0.0 = Creative, 0.5 = Natural, 1.0 = Robust).
            - `similarity_boost` number, double — The similarity slider dictates how closely the AI should adhere to the original voice when attempting to replicate it.
            - `rate` string — The speed of the voice. The value is relative to 1. Valid range is 0.7 to 1.2.
            - `style` string — Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0. Valid range is 0 to 1.
            - `use_speaker_boost` boolean — boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.
            - `apply_language_text_normalization` boolean — Controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese.
            - `apply_text_normalization` 'auto' | 'on' | 'off' — Controls text normalization on the ElevenLabs side (expanding numbers, abbreviations and symbols). 'auto' lets ElevenLabs decide, 'on' forces normalization, 'off' disables it. Defaults to 'off' when not provided.
          - `model_id` string — The model id from the list of available models. https://elevenlabs.io/docs/speech-synthesis/models.
          - `language` string — Voice customization options. To save the language of the selected voice
        - AmazonTtsProvider
          - `type` 'amazon', required
          - `voice_id` 'Amy' | 'Aria' | 'Ayanda' | 'Bianca' | 'Brian' | 'Camila' | 'Emma' | 'Gabrielle' | 'Ivy' | 'Joanna' | 'Joey' | 'Justin' | 'Kendra' | 'Kevin' | 'Kimberly' | 'Léa' | 'Lucia' | 'Lupe' | 'Matthew' | 'Olivia' | 'Salli' | 'Seoyeon' | 'Takumi' | 'Vicki', required
          - `language` string — Voice customization options. To save the language of the selected agent voice
        - GoogleTtsProvider
          - `type` 'google', required
          - `voice_id` string — Voice ID selected from the list of available voices.</br>Retrieve available options from the GET /voices endpoint.
        - AzureOpenAiTtsProvider
          - `voice_id` string, required — Voice ID selected from the list of available voices.</br>Retrieve available options from the GET /voices endpoint.
          - `voice_config` VoiceConfigMicrosoft
            - `style` string — The style of the voice. Available styles change between voices.
            - `rate` string — The speed of the voice. The value is relative to 1, 0.5 being half speed, 2 being twice as fast, etc. Another option is a constant value from x-slow/slow/medium/fast/x-fast.
            - `pitch` string — The pitch of the voice. Value could be an absolute value in Hz (including units), a relative value in Hz or st(semitones) or a constant value from x-low/low/medium/high/x-high.
          - `language` string — Voice customization options. To save the language of the selected agent voice
          - `type` 'azure-openai', required
      - `input` string — The input text that will be synthesized to an audio file. Note that each provider has its own limitations on the text length. Maximum 40K characters (10K excluding SSML tags).
      - `ssml` boolean — Is the text provided in ssml form.
      - `dictionary_id` string — Pronunciation dictionary ID for word/phrase substitutions before TTS.
    - AudioScript3
      - `type` 'audio', required — The type of the script.
      - `subtitles` boolean — Should subtitles be created.
      - `audio_url` string, required
  - `config` ClipConfig
    - `logo` Logo
      - `url` string, required — https url to an ARGB jpg/png image, a default logo is used otherwise
      - `position` integer[], required — position of the logo in pixels from the top left corner (w,h) negative values are subtracted from last pixel
    - `result_format` 'mp4' | 'mov' | 'webm' — File format of the animated result
    - `output_resolution` number, double — The output resolution sets the maximum height or width of the output video. The aspect ratio is preserved from the source image.
  - `presenter_config` ClipPresenterConfig
    - `crop` union
      - WideCrop
        - `type` 'wide', required — The type of the crop.
      - RectangleCrop — Custom crop
        - `type` 'rectangle', required — The type of the crop.
        - `rectangle` object, required — A set of numbers between 0 and 1 representing the top, left, right and bottom of the crop. Each number correlates to the distance from the top left corner of the image, relative the the image width. For example, right: 0.75 means that the right side of the crop is 75% of the image width from the left side.
          - `bottom` number, double, required — Bottom position.
          - `right` number, double, required — Right position.
          - `left` number, double, required — Left position.
          - `top` number, double, required — Top position.
  - `background` ClipBackground
    - `color` union — Background color of the animated result, or false to use transparent background in-case of webm result format.
      - string — Background color of the animated result, must be a valid 6-characters long color css code.
      - false — Set 'false' to use transparent background (supported only with result_format = 'webm')
    - `source_url` string — URL to image that will be used as background.
  - `user_data` string
  - `name` string — The name of the clip
  - `webhook` string
  - `result_url` string

## Response `201`

Created

- CreateClipResponse
  - `id` string, required — The ID of the clip
  - `object` 'clip', required — An identifier of this clip
  - `created_at` string, required — Clip creation time as iso-8601 string
  - `status` 'created' | 'done' | 'error' | 'started' | 'rejected', required

## Other responses

- `400`
- `401` — AuthorizationError
- `402` — InsufficientCreditsError
- `403` — PermissionError
- `451` — ImageModerationError | CelebrityRecognizedError | TextModerationError | AudioModerationError

---

[API](https://skmtc.net/d-id/apis/realtime-endpoints.md) · [All operations](https://skmtc.net/d-id/apis/realtime-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/d-id/realtime-endpoints/versions/2f2425e1b6b6/schema)