> ## Documentation Index > Fetch the complete documentation index at: https://platform.vidu.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Image to Video ## Q3 Turbo Create Task ``` POST /ent/v2/img2video ``` ### Headers | Name | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | Required | Replace `{your api key}` with your API key;Example: `Token {your api key}` | ### Body parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `model` | `string` | Required | Model name viduq3-turbo: Compared to viduq3-pro, the generation speed is faster | | `images` | `array` | Required | The start frame image The model will use the image provided in this parameter as the start frame to generate the video. Note 1: Accepts Base64-encoded image or image URL (make sure it is accessible). Note 2: Only accepts 1 image. Note 3: Supported formats: png, jpeg, jpg, webp. Note 4: The aspect ratio of the image must be less than 1:4 or 4:1. Note 5: The image size is limited to 50MB. Note 6: The byte length after Base64 decode must be less than 10MB, and the encoding must include an appropriate content type string, for base64,{base64_encode}normal;Example: `data:image/png` | | `prompt` | `string` | Optional | Text prompt A textual description for video generation, with a maximum length of **20000 characters**. Note: If the is_rec parameter for recommended prompts is used, the model will ignore the prompt entered in this parameter. | | `audio` | `boolean` | Optional | Whether to use direct audio-video generation capability. Default: true. Enumerated values: false: No direct audio-video generation, outputs silent video true: Direct audio-video generation required, outputs video with dialogue and background sound Note 1: The voice_id parameter takes effect only when this parameter is true Note 2: When this parameter is true, off-peak mode is not supported | | `is_rec` | `boolean` | Optional | Whether to use the recommended prompt. `true`: System will automatically recommend a prompt and use its content to generate the video. `false`: The video will be generated based on user input prompt. | | `duration` | `integer` | Optional | Video duration. viduq3-turbo: default is 5, available: 1 - 16 | | `seed` | `integer` | Optional | Random seed When not provided or set to 0, a random number will be used instead. Manually set values will use the specified seed. | | `resolution` | `string` | Optional | Resolution. The default value depends on the model and video duration: viduq3-turbo 1-16s: default 720p, options: 540p, 720p, 1080p | | `payload` | `string` | Optional | Transparent transmission parameters No processing, only data transmission. Note: Maximum of **1048576 characters** | | `off_peak` | `boolean` | Optional | Off-peak mode. Default: `false`. Accepted values: `true`: Generate the video in off-peak mode `false`: Generate the video immediately Note 1: Off-peak mode consumes fewer credits. For details, see [Pricing](https://platform.vidu.com/docs/pricing). Note 2: Tasks submitted in off-peak mode will be generated within 48 hours. Tasks that are not completed will be automatically cancelled and their credits will be refunded. Note 3: You can also [manually cancel](https://platform.vidu.com/docs/cancel-generation) off-peak tasks. | | `callback_url` | `string` | Optional | Callback When creating a task, you need to actively set the `callback_url` with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the [Get Creation](https://platform.vidu.com/docs/get-generation) API. The "status" in the callback response includes the following states: processing: Task is being processed. success: Task is completed (if sending fails, it will retry the callback three times). failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: [Callback Signature](https://platform.vidu.com/docs/callback-signature) | ### Request example ```shell curl -X POST -H "Authorization: Token {your_api_key}" -H "Content-Type: application/json" -d ' { "model": "viduq3-turbo", "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/image2video.png"], "prompt": "The astronaut waved and the camera moved up.", "audio": true, "voice_id": "professional_host", "duration": 5, "seed": 0, "resolution": "1080p" }' https://api.vidu.com/ent/v2/img2video ``` ### Response #### 200 OK | Name | Type | Required | Description | | --- | --- | --- | --- | | `task_id` | `string` | Optional | Task ID generated by Vidu | | `state` | `string` | Optional | It will be returned to a specific processing state: `created` created task successfully `queueing` task in queue `processing` processing `success` generation successful `failed` task failed | | `model` | `string` | Optional | The model name used for this call | | `prompt` | `string` | Optional | The text prompt used for this call | | `images` | `string` | Optional | The images used for this call | | `duration` | `integer` | Optional | The video duration parameter used for this call | | `seed` | `integer` | Optional | The random seed parameter used for this call | | `resolution` | `string` | Optional | The resolution parameter used for this call | | `payload` | `string` | Optional | The payload parameter used for this call | | `off_peak` | `boolean` | Optional | Whether off-peak mode is used for this call | | `credits` | `integer` | Optional | The credits used for this call | | `created_at` | `string` | Optional | Task creation time | ```json { "task_id": "your_task_id_here", "state": "created", "model": "viduq3-turbo", "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/image2video.png"], "prompt": "The astronaut waved and the camera moved up.", "duration": 5, "seed": random_number, "resolution": "1080p", "payload":"", "credits":credits_number, "created_at": "2025-01-01T15:41:31.968916Z" } ``` ## Q3 Turbo Query Creations ``` GET /ent/v2/tasks/{id}/creations ``` ### Headers | Name | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | Required | Replace `{your api key}` with your API key;Example: `Token {your api key}` | ### Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | `string` | Required | Task id The id is returned upon the successful creation of a task by the **Start Generating API** | ### Request example ```shell curl -X GET -H "Authorization: Token {your_api_key}" https://api.vidu.com/ent/v2/tasks/{your_id}/creations ``` ### Response #### 200 OK | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | `string` | Optional | Task ID | | `state` | `string` | Optional | It will be returned to a specific processing state: `created` created task successfully `queueing` task in queue `processing` processing `success` generation successful `failed` task failed | | `err_code` | `string` | Optional | Error code. See the error code table for details. | | `credits` | `integer` | Optional | The number of credits consumed by this task. Unit: credits. | | `payload` | `string` | Optional | The payload parameter used for this call | | `off_peak` | `boolean` | Optional | Whether to use off_peak mode for this call | | `creations` | `array` | Optional | Generated results | | ↳ `id` | `string` | Optional | Creation id, used to identify different creations | | ↳ `url` | `string` | Optional | The URL of the generated results, valid for 24 hours | | ↳ `cover_url` | `string` | Optional | The cover URL of the generated results, valid for 24 hours | | ↳ `watermarked_url` | `string` | Optional | The URL of the watermarked generated results, valid for 24 hours | ```json { "id":"your_task_id", "state": "success", "err_code": "", "credits": 4, "payload": "", "creations": [ { "id": "your_creations_id", "url": "your_generated_results_url", "cover_url": "your_generated_results_cover_url", "watermarked_url": "your_generated_results_watermarked_url" } ] } ``` ## Q3 Pro Create Task ``` POST /ent/v2/img2video ``` ### Headers | Name | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | Required | Replace `{your api key}` with your API key;Example: `Token {your api key}` | ### Body parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `model` | `string` | Required | Model name viduq3-pro-fast: Efficiently generate high-quality audio and video content with faster generation speed and high cost-effectiveness | | `images` | `array` | Required | An image to be used as the start frame of the generated video. The model will use the image provided via this parameter as the first frame to generate the video. Note 1: Accepts Base64-encoded image or image URL (ensure it is accessible). Note 2: Only 1 image is accepted. Note 3: Supported image formats: png, jpeg, jpg, webp. Note 4: The aspect ratio of the image must be less than 1:4 or 4:1. Note 5: The image size must not exceed 50MB. Note 6: Note that the byte length after base64 decode must be less than 10MB, and the encoding must contain an appropriate content type string. For base64,{base64_encode}normal;Example: `data:image/png` | | `prompt` | `string` | Optional | Text prompt A textual description for video generation. Note 1: Maximum length of **20000 characters**. Note 2: If the is_rec recommended prompt parameter is used, the model will ignore the prompt entered for this parameter. | | `audio` | `boolean` | Optional | Whether to use direct audio-video generation capability. Default: true. Enumerated values: false: No direct audio-video generation, outputs silent video true: Direct audio-video generation required, outputs video with dialogue and background sound Note 1: The voice_id parameter takes effect only when this parameter is true Note 2: When this parameter is true, off-peak mode is not supported | | `is_rec` | `boolean` | Optional | Whether to use the recommended prompt. `true`: System will automatically recommend a prompt and use its content to generate the video. `false`: The video will be generated based on user input prompt. | | `duration` | `integer` | Optional | Video duration. viduq3-pro: default is 5, available: 1 - 16 | | `seed` | `integer` | Optional | Random seed Defaults to a random seed number (used when not provided or set to 0) Manually set values will override the default random seed | | `resolution` | `string` | Optional | Resolution (based on model & duration): viduq3-pro 1-16s: default 720p, options: 540p, 720p, 1080p | | `payload` | `string` | Optional | transparent transmission parameters No processing, only data transmission, with a maximum length of **1048576 characters** | | `off_peak` | `boolean` | Optional | off peak mode, Defaults to `false`, accepted value: `true` `false` `true`: off peak generate mode; `false`: normal generate mode; Note 1: The off_peak mode consumes lower credits, please refer to [Pricing](https://platform.vidu.com/docs/pricing) for details Note 2: Tasks submitted in off peak mode will be generated within 48 hours. Tasks that are not completed will be automatically cancelled and their credits will be refunded. Note 3: You can also [cancel off_peak](https://platform.vidu.com/docs/cancel-generation) tasks manually | | `callback_url` | `string` | Optional | Callback When creating a task, you need to actively set the `callback_url` with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the Get Generation API. The "status" in the callback response includes the following states: processing: Task is being processed. success: Task is completed (if sending fails, it will retry the callback three times). failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: [Callback Signature](https://platform.vidu.com/docs/callback-signature) | ### Request example ```shell curl -X POST -H "Authorization: Token {your_api_key}" -H "Content-Type: application/json" -d ' { "model": "viduq3-pro", "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/image2video.png"], "prompt": "The astronaut waved and the camera moved up.", "audio": true, "voice_id": "professional_host", "duration": 5, "seed": 0, "resolution": "1080p" }' https://api.vidu.com/ent/v2/img2video ``` ### Response #### 200 OK | Name | Type | Required | Description | | --- | --- | --- | --- | | `task_id` | `string` | Optional | Task ID | | `state` | `string` | Optional | It will be returned to a specific processing state: `created` created task successfully `queueing` task in queue `processing` processing `success` generation successful `failed` task failed | | `model` | `string` | Optional | The model parameter used for this call | | `prompt` | `string` | Optional | The text prompt used for this call | | `images` | `string` | Optional | The images used for this call | | `duration` | `integer` | Optional | The video duration parameter used for this call | | `seed` | `integer` | Optional | The random seed parameter used for this call | | `resolution` | `string` | Optional | The resolution parameter used for this call | | `payload` | `string` | Optional | The payload parameter used for this call | | `off_peak` | `boolean` | Optional | The off_peak parameter used for this call | | `credits` | `integer` | Optional | The credits used for this call | | `created_at` | `string` | Optional | Task creation time | ```json { "task_id": "your_task_id_here", "state": "created", "model": "viduq3-pro", "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/image2video.png"], "prompt": "The astronaut waved and the camera moved up.", "duration": 5, "seed": random_number, "resolution": "1080p", "payload":"", "credits":credits_number, "created_at": "2025-01-01T15:41:31.968916Z" } ``` ## Q3 Pro Query Creations ``` GET /ent/v2/tasks/{id}/creations ``` ### Headers | Name | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | Required | Replace `{your api key}` with your API key;Example: `Token {your api key}` | ### Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | `string` | Required | Task ID, returned by the Create Task API upon successful creation | ### Request example ```shell curl -X GET -H "Authorization: Token {your_api_key}" https://api.vidu.com/ent/v2/tasks/{your_id}/creations ``` ### Response #### 200 OK | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | `string` | Optional | Task ID | | `state` | `string` | Optional | Processing state Accepted values: `created` created successfully `queueing` task in queue `processing` processing `success` generation successful `failed` task failed | | `err_code` | `string` | Optional | Error code, see the error code table for details | | `credits` | `integer` | Optional | The number of credits consumed by this task | | `payload` | `string` | Optional | The payload (pass-through) parameter passed in for this task call | | `off_peak` | `boolean` | Optional | Whether off peak mode is used for this task call | | `creations` | `array` | Optional | Generation results | | ↳ `id` | `string` | Optional | Generation ID, used to identify different creations | | ↳ `url` | `string` | Optional | Creation URL, valid for 24 hours | | ↳ `cover_url` | `string` | Optional | Creation cover, valid for 24 hours | | ↳ `watermarked_url` | `string` | Optional | Watermarked creation URL, valid for 24 hours | ```json { "id":"your_task_id", "state": "success", "err_code": "", "credits": 4, "payload": "", "creations": [ { "id": "your_creations_id", "url": "your_generated_results_url", "cover_url": "your_generated_results_cover_url", "watermarked_url": "your_generated_results_watermarked_url" } ] } ``` ## Q3 Pro Fast Create Task ``` POST /ent/v2/img2video ``` ### Headers | Name | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | Required | Replace {your api key} with your token;Example: `Token {your api key}` | ### Body parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `model` | `string` | Required | Model name viduq3-pro-fast: Efficiently generate high-quality audio and video content, with faster generation speed and high cost-effectiveness | | `images` | `array` | Required | Start frame image The model will use the image passed in this parameter as the start frame to generate the video. Note 1: Supports passing a Base64-encoded image or an image URL (ensure it is accessible); Note 2: Only 1 image is supported; Note 3: Supported image formats: png, jpeg, jpg, webp; Note 4: The aspect ratio of the image must be less than 1:4 or 4:1; Note 5: The image size must not exceed 50 MB; Note 6: Please note that the byte length after base64 decode must be less than 10M, and the encoding must include an appropriate content type string, for base64,{base64_encode}normal;Example: `data:image/png` | | `prompt` | `string` | Optional | Text prompt A text description of the video to be generated. Note 1: The length must not exceed 20000 characters Note 2: If the is_rec recommended prompt parameter is used, the model will ignore the prompt entered in this parameter | | `audio` | `boolean` | Optional | Whether to use the direct audio-video generation capability. Default is true. Enumerated values: false: No direct audio-video generation, outputs silent video true: Direct audio-video generation required, outputs video with dialogue and background sound Note 1: The voice_id parameter takes effect only when this parameter is true Note 2: When this parameter is true, off peak mode is not supported | | `is_rec` | `boolean` | Optional | Whether to use the recommended prompt. `true`: System will automatically recommend a prompt and use its content to generate the video. `false`: The video will be generated based on user input prompt. | | `duration` | `integer` | Optional | Video duration Default is 5 for viduq3-pro-fast, available: 1 - 16 | | `seed` | `integer` | Optional | Random seed When not passed or passed as 0 by default, a random number will be used instead When set manually, the set seed will be used | | `resolution` | `string` | Optional | Resolution parameter. The default value depends on the model and video duration: viduq3-pro-fast 1-16s: default 720p, options: 720p, 1080p | | `payload` | `string` | Optional | Transparent transmission parameter No processing, only data transmission Note: Maximum 1048576 characters | | `off_peak` | `boolean` | Optional | Off peak mode. Default is false. Accepted values: true: Generate video in off peak mode; false: Generate video immediately; Note 1: Off peak mode consumes fewer credits, see [Pricing](https://platform.vidu.cn/docs/pricing) for details Note 2: Tasks submitted in off peak mode will be generated within 48 hours. Tasks that are not completed will be automatically cancelled and the credits for that task will be refunded; Note 3: You can also [manually cancel](https://platform.vidu.cn/docs/cancel-task-api) off peak tasks | | `callback_url` | `string` | Optional | Callback protocol You need to actively set the callback_url when creating a task. The request method is POST. When the status of the video generation task changes, Vidu will send a callback request containing the latest status of the task to this address. The structure of the callback request content is the same as the return body of the Query Task API The "status" returned by the callback includes the following states: processing Task is being processed success Task is completed (if sending fails, the callback will be retried three times) failed Task failed (if sending fails, the callback will be retried three times) Vidu uses a callback signature algorithm for authentication, see [Callback Signature](https://platform.vidu.cn/docs/callback-signature) for details | ### Request example ```shell curl -X POST -H "Authorization: Token {your_api_key}" -H "Content-Type: application/json" -d ' { "model": "viduq3-pro-fast", "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/image2video.png"], "prompt": "The astronaut waved and the camera moved up.", "audio": true, "voice_id": "professional_host", "duration": 5, "seed": 0, "resolution": "1080p" }' https://api.vidu.com/ent/v2/img2video ``` ### Response #### 200 OK | Name | Type | Required | Description | | --- | --- | --- | --- | | `task_id` | `string` | Optional | Task ID generated by Vidu | | `state` | `string` | Optional | Processing state Accepted values: created Task created successfully queueing Task in queue processing Task is being processed success Task succeeded failed Task failed | | `model` | `string` | Optional | The model name used for this call | | `prompt` | `string` | Optional | The prompt parameter used for this call | | `images` | `string` | Optional | The image parameter used for this call | | `duration` | `integer` | Optional | The video duration parameter used for this call | | `seed` | `integer` | Optional | The random seed parameter used for this call | | `resolution` | `string` | Optional | The resolution parameter used for this call | | `payload` | `string` | Optional | The transparent transmission parameter passed in for this call | | `off_peak` | `boolean` | Optional | Whether off peak mode is used for this call | | `credits` | `integer` | Optional | The credits consumed by this call | | `created_at` | `string` | Optional | Task creation time | ```json { "task_id": "your_task_id_here", "state": "created", "model": "viduq3-pro-fast", "images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/image2video.png"], "prompt": "The astronaut waved and the camera moved up.", "duration": 5, "seed": random_number, "resolution": "1080p", "payload":"", "credits":credits_number, "created_at": "2025-01-01T15:41:31.968916Z" } ``` ## Q3 Pro Fast Query Creations ``` GET /ent/v2/tasks/{id}/creations ``` ### Headers | Name | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | Required | Replace `{your api key}` with your token;Example: `Token {your api key}` | ### Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | `string` | Required | Task ID, returned by the Create Task API upon successful creation | ### Request example ```shell curl -X GET -H "Authorization: Token {your_api_key}" https://api.vidu.com/ent/v2/tasks/{your_id}/creations ``` ### Response #### 200 OK | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | `string` | Optional | Task ID | | `state` | `string` | Optional | Processing state Accepted values: `created` Task created successfully `queueing` Task in queue `processing` Task is being processed `success` Task succeeded `failed` Task failed | | `err_code` | `string` | Optional | Error code, see the error code table for details | | `credits` | `integer` | Optional | The number of credits consumed by this task, unit: credits | | `payload` | `string` | Optional | The transparent transmission parameter passed in when this task was called | | `off_peak` | `boolean` | Optional | Whether off peak mode is used in this task call | | `creations` | `array` | Optional | Generated results | | ↳ `id` | `string` | Optional | Creation ID, used to identify different creations | | ↳ `url` | `string` | Optional | Creation URL, valid for 24 hours | | ↳ `cover_url` | `string` | Optional | Creation cover, valid for 24 hours | | ↳ `watermarked_url` | `string` | Optional | Watermarked creation URL, valid for 24 hours | ```json { "id":"your_task_id", "state": "success", "err_code": "", "credits": 4, "payload": "", "creations": [ { "id": "your_creations_id", "url": "your_generated_results_url", "cover_url": "your_generated_results_cover_url", "watermarked_url": "your_generated_results_watermarked_url" } ] } ```