Generate video from studio avatar

Generate a video using a studio avatar

Headers

x-api-key · string · required

Your VidLab7 API key used for authentication.

Content-Type · string

The content type of the request body. Always application/json.

Body ^{application/json}

avatarId · string · required

The ID of the avatar to be used for the video generation

script · string · required

The script to be used for the video generation

voiceId · string · required

The ID of the voice to be used for the video generation

webhookUrl · string · required

The URL to which the webhook will be sent

voice_settings · object · required

The voice_settings object

Show child attributes

stability · number · required

The stability of the voice (0-100)

similarity_boost · number · required

The similarity boost for the voice (0-100)

use_speaker_boost · boolean · required

Whether to use speaker boost

style · number · required

The style of the voice (0-100)

Example Request

curl --location --request POST 'https://api-prd.vidlab7.com/api/studio-avatar/generate-video' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    "avatarId": "avatar-uuid",
    "script": "Hello world!",
    "voiceId": "voice-uuid",
    "webhookUrl": "https://your-webhook/example-endpoint",
    "voice_settings": {
        "similarity_boost": 50,
        "use_speaker_boost": true,
        "style": 0,
        "stability": 50
    }
}'

Response

{
    "id": "123",
    "status": "PENDING"
}

Responses

---

201:

id · string

The ID of the generated video

status · string

The status of the generated video