Get generated video from studio avatar

Get generated video from studio avatar by id.

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.

Parameters

videoId · string · required

The id of the generated video. This comes back as id when video is sent for generation from both create single video and create videos.

Example Request

curl --location --request GET 'https://api-prd.vidlab7.com/api/studio-avatar/generated-video/{videoId}' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \

Response

{
    "success": true,
    "data": {
        "id": "1dde35ce-1ebf-45c5-a694-84dfcc7cfb1f",
        "script": "abc",
        "voiceId": "ab7f4aaa-6485-472c-b2ad-101caf68e6ba",
        "avatarId": "93ef9c57-a442-4c66-8b56-0de4ef5bbe84",
        "status": "PROCESSING",
        "alignment": {"characters": ["s"], "character_start_times_seconds": [0], "character_end_times_seconds": [0.1]},
        "normalized_alignment": {"characters": ["s"], "character_start_times_seconds": [0], "character_end_times_seconds": [0.1]},
        "webhookUrl": "https://e748-5-53-245-196.ngrok-free.app/api/studio-avatar/test-webhook",
        "videoUrl": "",
        "requestId": "50c8db34-00d3-436e-9c2d-a422ce0d8d90"
    }
}

Responses

---

200:

success · boolean

Indicates whether the request was successful

data · object

The color of the background in both light and dark mode

Show data

id · string

Unique identifier for the generated video

script · string

The script content used for the video

voiceId · string

Identifier for the voice used in the video

avatarId · string

Identifier for the avatar used in the video

status · string

Current status of the video generation as ENUM with four possible states:

• PENDING
• PROCESSING
• COMPLETED
• FAILED

alignment · object

An object containing the alignment data for the transcription.

Show alignment

characters · string[]

Represents an individual character.

character_start_times_seconds · number[]

The time at which the character starts (e.g., in seconds or milliseconds).

character_end_times_seconds · number[]

The time at which the character ends.

normalized_alignment · object

An object containing the normalized alignment data for the transcription.

Show normalized_alignment

characters · string[]

Represents an individual character.

character_start_times_seconds · number[]

The time at which the character starts (e.g., in seconds or milliseconds).

character_end_times_seconds · number[]

The time at which the character ends.

videoUrl · string

The url you can use to access your video.

requestId · string

The id of your video submission request.