> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crun.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Kling Avatar API
> kling-avatar: Turn any portrait into a talking avatar with audio-synchronized lip sync and natural expressions.
## Overview
Kling Avatar from transforms a single static image into a talking video that matches your audio. Upload a portrait
and an audio file, and the model generates facial movements, lip sync, and expressions that follow the speech patterns
in your audio.
## Tips for Best Results
Use high-quality, front-facing portraits where facial features are clearly visible. Avoid extreme angles or
heavy occlusion of the face. Higher resolution source images produce better identity preservation and fewer artifacts.
## Query Task Status
After submitting a task, use the unified query endpoint to check progress and retrieve results:
Learn how to query task status and retrieve generation results
For production use, we recommend using the `callback_url` parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.
## Related Resources
Explore all available models
Check credits and account usage
## OpenAPI
````yaml models/kling/avatar.json post /api/v1/client/job/CreateTask
openapi: 3.0.0
info:
title: Crun Kling Avatar API
description: crun.ai Kling Avatar API Documentation
version: 1.0.0
contact:
name: Technical Support
email: support@crun.ai
servers:
- url: https://api.crun.ai
description: API Server
security:
- ApiKeyAuth: []
paths:
/api/v1/client/job/CreateTask:
post:
summary: kling avatar image to video generation
operationId: kling/avatar
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- kling/avatar
description: |-
The model name to use for generation. Required field.
- Must be `kling/avatar` for this endpoint
callback_url:
type: string
format: uri
description: >-
Optional. Callback URL for receiving task completion
notifications.
- System will POST task status and results to this URL when
generation completes
- Callback payloads structure is consistent with the `data`
object returned by the task status query
- Your callback endpoint should accept POST requests with
JSON payload containing results
- It returns an HTTP 200 status code upon successful receipt
example: https://your-domain.com/api/callback
input:
type: object
description: >-
Input parameters for the kling avatar image-to-video
generation task
properties:
mode:
type: string
description: Standard has a resolution of 720p, pro is 1080p.
enum:
- std
- pro
default: std
example: std
image_url:
type: string
description: >-
Avatar reference image. Supports .jpg/.jpeg/.png, max
10MB, dimensions >= 300px, aspect ratio 1:2.5 to 2.5:1.
example: https://example.com/reference_avatar.png
audio_url:
type: string
description: >-
Audio file for avatar. Supports .mp3/.wav/.m4a/.aac, max
5MB. Duration must be between 2-300 seconds
example: https://example.com/avatar_audio.mp3
prompt:
type: string
description: >-
Positive text prompt. Can be used to define avatar
actions, emotions, and camera movements
example: >-
While talking, excitedly shaking head, finally reaching
out and making a fist, deciding to set off, hopping
happily
maxLength: 2500
required:
- image_url
- audio_url
example:
model: kling/avatar
input:
mode: pro
image_url: https://example.com/reference_avatar.png
audio_url: https://example.com/avatar_audio.mp3
prompt: >-
While talking, excitedly shaking head, finally reaching out
and making a fist, deciding to set off, hopping happily
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
task_id:
type: string
description: >-
Task ID, can be used with Get Task Details
endpoint to query task status
example: task_12345678
example:
code: 200
message: success
data:
task_id: task_12345678
'422':
description: Validation Error
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
errors:
type: array
description: Detailed validation error messages
items:
type: string
example:
- specific error field message
example:
code: 422
message: Missing Params or Type Error
errors:
- specific error field message
'500':
$ref: '#/components/responses/Error'
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 455
- 500
- 501
- 505
description: >-
Response status code
- **200**: Success - Request has been processed successfully
- **401**: Unauthorized - Authentication credentials are missing or
invalid
- **402**: Insufficient Credits - Account does not have enough
credits to perform the operation
- **404**: Not Found - The requested resource or endpoint does not
exist
- **422**: Validation Error - The request parameters failed
validation checks
- **429**: Rate Limited - Request limit has been exceeded for this
resource
- **455**: Service Unavailable - System is currently undergoing
maintenance
- **500**: Server Error - An unexpected error occurred while
processing the request
- **501**: Generation Failed - Content generation task failed
- **505**: Feature Disabled - The requested feature is currently
disabled
message:
type: string
description: Response message, error description when failed
example: success
responses:
Error:
description: Server Error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
All APIs require authentication via API Key.
Get API Key:
1. Visit [API Key Management Page](https://crun.ai/user-api-key) to get
your API Key
Usage:
Add to request header:
x-api-key: YOUR_API_KEY
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately
in the management page
````