# Vidu LipSync Task Status

> Video Generation

Query the status and result URLs for an asynchronous lip-sync task.

## Endpoint

`GET https://api.modelverse.cn/v1/tasks/status`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| task_id | query | string | Yes | Asynchronous task identifier returned by `/v1/tasks/submit`. |

## Responses

- **200** — Task status response.
- **400** — Invalid task identifier or request parameters.
- **default** — Error response.

## OpenAPI Definition

```json
{
  "openapi": "3.1.0",
  "x-language": "en-US",
  "info": {
    "title": "ModelVerse Vidu/LipSync Video Task API",
    "version": "1.0.0",
    "description": "Self-contained OpenAPI 3.1 schema for the ModelVerse Vidu/LipSync\nasynchronous lip-sync video task API.\n"
  },
  "servers": [
    {
      "url": "https://api.modelverse.cn",
      "description": "ModelVerse API endpoint documented for this model."
    }
  ],
  "tags": [
    {
      "name": "Vidu/LipSync",
      "description": "Lip-sync video generation task operations for Vidu/LipSync."
    }
  ],
  "paths": {
    "/v1/tasks/submit": {
      "post": {
        "tags": [
          "Vidu/LipSync"
        ],
        "operationId": "submitViduLipSyncTask",
        "summary": "Vidu LipSync",
        "description": "Submit an asynchronous lip-sync video generation task. The task can be\ndriven by an audio URL or by text; if both are provided, the audio URL\ncontent takes priority.\n",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ViduLipSyncSubmitRequest"
              },
              "examples": {
                "audioDriven": {
                  "summary": "Submit an audio-driven lip-sync task",
                  "value": {
                    "model": "vidu-lip-sync",
                    "input": {
                      "video_url": "https://umodelverse-inference.cn-wlcb.ufileos.com/maxcot-dance.mp4",
                      "audio_url": "https://umodelverse-inference.cn-wlcb.ufileos.com/%E6%AC%A2%E8%BF%8E%E4%BD%BF%E7%94%A8Modelverse_API.mp3"
                    },
                    "parameters": {
                      "vidu_type": "lip-sync"
                    }
                  }
                },
                "textDriven": {
                  "summary": "Submit a text-driven lip-sync task",
                  "value": {
                    "model": "vidu-lip-sync",
                    "input": {
                      "video_url": "https://umodelverse-inference.cn-wlcb.ufileos.com/maxcot-dance.mp4",
                      "text": "Hello, welcome to the ModelVerse lip sync feature."
                    },
                    "parameters": {
                      "vidu_type": "lip-sync",
                      "voice_id": "your_voice_id",
                      "speed": 1,
                      "volume": 4
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Task submitted successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViduLipSyncSubmitResponse"
                },
                "examples": {
                  "submitted": {
                    "summary": "Submitted task",
                    "value": {
                      "output": {
                        "task_id": "task_id"
                      },
                      "request_id": "request_id"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViduLipSyncErrorResponse"
                },
                "examples": {
                  "paramError": {
                    "$ref": "#/components/examples/ViduLipSyncParamError"
                  }
                }
              }
            }
          },
          "default": {
            "description": "Error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViduLipSyncErrorResponse"
                },
                "examples": {
                  "error": {
                    "$ref": "#/components/examples/ViduLipSyncParamError"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/tasks/status": {
      "get": {
        "tags": [
          "Vidu/LipSync"
        ],
        "operationId": "getViduLipSyncTaskStatus",
        "summary": "Vidu LipSync Task Status",
        "description": "Query the status and result URLs for an asynchronous lip-sync task.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "task_id",
            "in": "query",
            "required": true,
            "description": "Asynchronous task identifier returned by `/v1/tasks/submit`.",
            "schema": {
              "type": "string"
            },
            "example": "task_id"
          }
        ],
        "responses": {
          "200": {
            "description": "Task status response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViduLipSyncStatusResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Successful task",
                    "value": {
                      "output": {
                        "task_id": "task_id",
                        "task_status": "Success",
                        "urls": [
                          "https://xxxxx/xxxx-lipsync.mp4"
                        ],
                        "submit_time": 1756959000,
                        "finish_time": 1756959050
                      },
                      "usage": {
                        "duration": 30
                      },
                      "request_id": ""
                    }
                  },
                  "failure": {
                    "summary": "Failed task",
                    "value": {
                      "output": {
                        "task_id": "task_id",
                        "task_status": "Failure",
                        "submit_time": 1756959000,
                        "finish_time": 1756959019,
                        "error_message": "error_message"
                      },
                      "usage": {
                        "duration": 5
                      },
                      "request_id": ""
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid task identifier or request parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViduLipSyncErrorResponse"
                },
                "examples": {
                  "paramError": {
                    "$ref": "#/components/examples/ViduLipSyncParamError"
                  }
                }
              }
            }
          },
          "default": {
            "description": "Error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViduLipSyncErrorResponse"
                },
                "examples": {
                  "error": {
                    "$ref": "#/components/examples/ViduLipSyncParamError"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API key",
        "description": "ModelVerse API key sent as `Authorization: Bearer <MODELVERSE_API_KEY>`."
      }
    },
    "schemas": {
      "ViduLipSyncSubmitRequest": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "model",
          "input",
          "parameters"
        ],
        "properties": {
          "model": {
            "type": "string",
            "const": "vidu-lip-sync",
            "description": "Model name. This schema is pinned to `vidu-lip-sync`."
          },
          "input": {
            "$ref": "#/components/schemas/ViduLipSyncInput"
          },
          "parameters": {
            "$ref": "#/components/schemas/ViduLipSyncParameters"
          }
        }
      },
      "ViduLipSyncInput": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "video_url"
        ],
        "anyOf": [
          {
            "required": [
              "audio_url"
            ]
          },
          {
            "required": [
              "text"
            ]
          }
        ],
        "properties": {
          "video_url": {
            "type": "string",
            "format": "uri",
            "x-supported-formats": [
              "mp4",
              "mov",
              "avi"
            ],
            "x-min-duration-seconds": 1,
            "x-max-duration-seconds": 600,
            "x-recommended-duration-seconds": "10-120",
            "x-max-file-size-gb": 5,
            "x-min-side-px": 360,
            "x-max-side-px": 4096,
            "x-required-codec": "H.264",
            "description": "Source video URL used as the visual reference for lip-sync matching.\nSupported formats are mp4, mov, and avi. Duration must be 1-600\nseconds, with 10-120 seconds recommended. File size must not exceed\n5 GB. Each side of the video must be between 360p and 4096p, and\nthe video codec must be H.264. The video must contain a target face\nsuitable for lip-sync generation.\n"
          },
          "audio_url": {
            "type": "string",
            "format": "uri",
            "description": "Audio file URL used to drive lip-sync speech. Provide either\n`audio_url` or `text`. If both are provided, `audio_url` takes\npriority. Supported formats are wav, mp3, wma, m4a, aac, and ogg.\nDuration must be greater than 1 second and less than 600 seconds.\nFile size must not exceed 100 MB.\n"
          },
          "text": {
            "type": "string",
            "maxLength": 2000,
            "x-min-chinese-chars": 2,
            "x-max-chinese-chars": 1000,
            "x-min-english-chars": 4,
            "x-max-english-chars": 2000,
            "x-pause-marker-seconds": {
              "minimum": 0.01,
              "maximum": 99.99
            },
            "description": "Text content used for text-driven lip-sync generation. Provide\neither `text` or `audio_url`. Paragraph changes can be marked with\nnewlines. Pause control is supported with `<#x#>` markers, where x\nis a pause in seconds in the range [0.01, 99.99] with at most two\ndecimal places, placed between pronounceable text segments.\n"
          },
          "ref_photo_url": {
            "type": "string",
            "format": "uri",
            "x-supported-formats": [
              "jpg",
              "jpeg",
              "png",
              "bmp",
              "webp"
            ],
            "x-min-side-px": 192,
            "x-max-side-px": 4096,
            "x-max-file-size-mb": 10,
            "description": "Optional face reference image URL used to select the target person\nwhen the video contains multiple faces. Supported formats are jpg,\njpeg, png, bmp, and webp. Each side must be 192-4096 px, size must\nnot exceed 10 MB, and the image must contain one clear frontal face\nthat appears in the video.\n"
          }
        }
      },
      "ViduLipSyncParameters": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "vidu_type"
        ],
        "properties": {
          "vidu_type": {
            "type": "string",
            "const": "lip-sync",
            "description": "Vidu API type. This schema is pinned to `lip-sync`."
          },
          "speed": {
            "type": "number",
            "format": "double",
            "minimum": 0.5,
            "maximum": 2,
            "default": 1,
            "description": "Speech speed for text-driven generation only. `0.5` is the slowest\nspeed and `2` is the fastest.\n"
          },
          "voice_id": {
            "type": "string",
            "description": "Voice ID for text-driven generation only."
          },
          "volume": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10,
            "default": 0,
            "description": "Volume for text-driven generation only. `0` is normal volume; larger\nvalues increase the volume.\n"
          }
        }
      },
      "ViduLipSyncSubmitResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "output",
          "request_id"
        ],
        "properties": {
          "output": {
            "$ref": "#/components/schemas/ViduLipSyncSubmitOutput"
          },
          "request_id": {
            "type": "string",
            "description": "Unique request identifier."
          }
        }
      },
      "ViduLipSyncSubmitOutput": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "task_id"
        ],
        "properties": {
          "task_id": {
            "type": "string",
            "description": "Unique identifier of the asynchronous task."
          }
        }
      },
      "ViduLipSyncStatusResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "output",
          "request_id"
        ],
        "properties": {
          "output": {
            "$ref": "#/components/schemas/ViduLipSyncStatusOutput"
          },
          "usage": {
            "$ref": "#/components/schemas/ViduLipSyncUsage"
          },
          "request_id": {
            "type": "string",
            "description": "Unique request identifier."
          }
        }
      },
      "ViduLipSyncStatusOutput": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "task_id",
          "task_status"
        ],
        "properties": {
          "task_id": {
            "type": "string",
            "description": "Unique identifier of the asynchronous task."
          },
          "task_status": {
            "$ref": "#/components/schemas/ViduLipSyncTaskStatus"
          },
          "urls": {
            "type": "array",
            "description": "Video result URL list.",
            "items": {
              "type": "string",
              "format": "uri"
            }
          },
          "submit_time": {
            "type": "integer",
            "format": "int64",
            "description": "Task submission timestamp."
          },
          "finish_time": {
            "type": "integer",
            "format": "int64",
            "description": "Task completion timestamp."
          },
          "error_message": {
            "type": "string",
            "description": "Error message returned when the task fails."
          }
        }
      },
      "ViduLipSyncTaskStatus": {
        "type": "string",
        "enum": [
          "Pending",
          "Running",
          "Success",
          "Failure"
        ],
        "description": "Current asynchronous task status."
      },
      "ViduLipSyncUsage": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "duration": {
            "type": "integer",
            "description": "Video duration in seconds."
          }
        }
      },
      "ViduLipSyncErrorResponse": {
        "type": "object",
        "additionalProperties": true,
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "$ref": "#/components/schemas/ViduLipSyncErrorObject"
          },
          "request_id": {
            "type": "string",
            "description": "Unique request identifier, if available."
          }
        }
      },
      "ViduLipSyncErrorObject": {
        "type": "object",
        "additionalProperties": true,
        "required": [
          "message",
          "type"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message."
          },
          "type": {
            "type": "string",
            "description": "Error type.",
            "examples": [
              "invalid_request_error"
            ]
          },
          "code": {
            "type": [
              "string",
              "null"
            ],
            "description": "Error code.",
            "examples": [
              "param_error"
            ]
          },
          "param": {
            "type": [
              "string",
              "null"
            ],
            "description": "Request parameter related to the error."
          }
        }
      }
    },
    "examples": {
      "ViduLipSyncParamError": {
        "summary": "Invalid parameter error",
        "value": {
          "error": {
            "message": "Invalid param",
            "type": "invalid_request_error",
            "code": "param_error",
            "param": "input.video_url"
          },
          "request_id": "request_id"
        }
      }
    }
  }
}
```