Skip to main content
POST
/
api
/
v1
/
fictional-avatar
/
generated-video
curl --location --request POST 'https://api-prd.vidlab7.com/api/v1/fictional-avatar/generated-video' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    "mediaUrl": "https://your-storage-url",
    "mediaType": "image",
    "script": "Hello world!",
    "voiceId": "voice-uuid",
    "webhookUrl": "https://your-webhook/example-endpoint",
    "voice_settings": {
        "stability": 50,
        "similarity_boost": 50,
        "use_speaker_boost": true,
        "style": 0
    }
}'

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

​
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

​
mediaUrl
string
required
The url of the image or video used for creation (preferably GCP storage URL)
​
mediaType
string
required
The type of media used for creation, either “image” or “video”
​
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
curl --location --request POST 'https://api-prd.vidlab7.com/api/v1/fictional-avatar/generated-video' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    "mediaUrl": "https://your-storage-url",
    "mediaType": "image",
    "script": "Hello world!",
    "voiceId": "voice-uuid",
    "webhookUrl": "https://your-webhook/example-endpoint",
    "voice_settings": {
        "stability": 50,
        "similarity_boost": 50,
        "use_speaker_boost": true,
        "style": 0
    }
}'

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

​
Responses

​
201:

​
id
string
The ID of the generated video
​
status
string
The status of the generated video
⌘I