> ## 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.
# Crun Vidu Lip Sync API
> Replace or dub audio on an existing video with vidu lip sync, audio-driven lip sync. Give it a video and new audio or text, and it re-animates the speaker’s lip movements to match.
## 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/vidu/lip-sync.json post /api/v1/client/job/CreateTask
openapi: 3.0.0
info:
title: Crun Vidu Lip Sync API
description: crun.ai Vidu Lip Sync 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: vidu lip sync generation
operationId: vidu/lip-sync
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- vidu/lip-sync
description: |-
The model name to use for generation. Required field.
- Must be `vidu/lip-sync` 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 Vidu lip sync model.
properties:
video_url:
type: string
format: uri
description: >-
Source video URL.
Note 1: Supported video formats only: mp4, mov, avi;
Note 2: Supported duration ranges from 1 to 600 seconds,
with a recommended duration of 10 to 120 seconds;
example: https://example.com/video.mp4
audio_url:
type: string
format: uri
nullable: true
description: >-
Audio URL. The text and timbre used in lip-sync videos
shall be subject to the content of the audio file.
Cannot be used together with `text`.
example: https://example.com/audio.mp3
text:
type: string
nullable: true
description: >-
Text content for speech generation. Text content used
for lip-sync video generation. The text content shall be
no less than 4 characters and no more than 2000
characters (2 to 1000 Chinese characters or 4 to 2000
English characters). Cannot be used together with
`audio_url`.
minLength: 2
maxLength: 2000
example: Hello everyone, welcome to our demo.
voice_id:
type: string
nullable: true
description: >-
Voice ID used for text-to-speech generation. Required
when using `text`. See: [Vidu Voice
IDs](https://shengshu.feishu.cn/sheets/EgFvs6DShhiEBStmjzccr5gonOg)
example: male-qn-qingse
speed:
type: number
nullable: true
description: >-
Speech speed multiplier. 1.0 stands for the normal
speech rate, with a range of [0.5, 2]. The playback
speed is the slowest when the value is 0.5 and the
fastest when the value is 2. Only effective during
`text` generation.
minimum: 0.5
maximum: 2
example: 1
volume:
type: integer
nullable: true
description: >-
Speech volume level. 0 stands for normal volume; the
higher the value, the louder the volume. Only effective
during `text` generation.
minimum: 0
maximum: 10
example: 5
moderation:
type: string
description: >-
Content moderation switch. Use `enabled` to enable
moderation and `disabled` to disable it. Defaults to
`enabled`.
enum:
- disabled
- enabled
default: enabled
example: enabled
required:
- video_url
example:
model: vidu/lip-sync
input:
video_url: https://example.com/video.mp4
text: Hello everyone, welcome to Crun AI.
voice_id: male-qn-qingse
speed: 1
volume: 5
moderation: enabled
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
````