Get generated fictional avatar video

Get generated video from fictional 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.

Example Request

curl --location --request GET 'https://api-prd.vidlab7.com/api/v1/fictional-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",
        "mediaUrl": "https://your-media-url",
        "mediaType": "image",
        "status": "PROCESSING",
        "webhookUrl": "https://your-webhook-url/example-endpoint",
        "videoUrl": "https://example-video-url",
        "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

mediaUrl · string

URL where the media file can be accessed

mediaType · string

Type of the media file. Can be either “image” or “video”

status · string

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

• PENDING
• PROCESSING
• COMPLETED
• FAILED

videoUrl · string

The url you can use to access your video.

requestId · string

The id of your video submission request.