Create Video Avatar
POST
/v1/video-avatarsGenerate a video with an avatar speaking the provided text.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
Request Body
| Field | Type | Description |
|---|---|---|
| avatar_id | string | The ID of the avatar to use in the video |
| voice_id | string | The ID of the voice to use for speech |
| text | string | The text for the avatar to speak |
| settings | object | Video generation settings (resolution, format, background, webhook_url) |
Settings Object
| Field | Type | Description |
|---|---|---|
| resolution | string | Video resolution (e.g., 1080p) |
| format | string | Video format (e.g., mp4) |
| background | string | Background type or name (e.g., office) |
| webhook_url | string | URL to receive a callback when video generation is complete |
Request Example
shell
curl -X POST https://api.konpro.ai/v1/video-avatars \
-H "x-api-key: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"avatar_id": "avatar-3655",
"voice_id": "voice-123",
"text": "Hello, welcome to KonPro! This is a sample video generation.",
"settings": {
"resolution": "1080p",
"format": "mp4",
"background": "office",
"webhook_url": "https://your-webhook.com/callback"
}
}'Response
| Field | Type | Description |
|---|---|---|
| job_id | string | Unique identifier for the video generation job |
| status | string | Current status of the job (e.g., processing) |
| estimated_time | integer | Estimated time in seconds for video generation |
| message | string | Status message (e.g., Video generation started) |
Sample Successful Response
json
{
"job_id": "job-456",
"status": "processing",
"estimated_time": 120,
"message": "Video generation started"
}Notes
- This endpoint requires authentication using the
x-api-keyheader. - The
avatar_idmust be a valid avatar ID from your account. - The
voice_idmust be a valid voice ID available in your account. - Video generation is asynchronous. Use the
job_idto check the status of your video generation. - If a
webhook_urlis provided, you will receive a callback when the video is ready. - For error descriptions, see Error Responses.