1. API Description
Domain name for API request: vclm.intl.tencentcloudapi.com.
Submit a Vidu image-to-video task API
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: SubmitImageToVideoViduJob. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2024-05-23. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| IsRec |
No |
Boolean |
Whether to use recommended prompts, off by default
-true: Yes, the system automatically recommends prompts and uses prompt content to generate video. The number of recommended prompts is 1.
-false: No, generate video based on input prompt.
Note: Each task consumes 1 more point when recommended prompts are enabled. |
| VoiceId |
No |
String |
Voice type ID
Used to determine the voice type in the video. If left empty, the system will automatically recommend. Optional enumerated values reference list: supported timbre list
Voice clone functionality is not currently supported |
| MovementAmplitude |
No |
String |
Exercise range
Default: auto, available values: auto, small, medium, large
Note: This parameter does not take effect for q2 and q3 series models. |
| Bgm |
No |
Boolean |
bgm |
| AudioType |
No |
String |
Audio type, required when audio is true, default is all
Note: This parameter currently only supports audio split for q2, q1, and 2.0 series models Enumeration value: - all: Sound effects + voice
- speech_only: Voice only
- sound_effect_only: Sound effects only
|
| MetaData |
No |
String |
Metadata identification, a string in json format, passthrough field. You can customize the format or use the example format, for example:
{
"Label": "your_label",
"ContentProducer": "your_content_producer",
"ContentPropagator": "your_content_propagator",
"ProduceID": "your_product_id",
"PropagateID": "your_propagate_id",
"ReservedCode1": "your_reserved_code1",
"ReservedCode2": "your_reserved_code2"
}
If empty, use the metadata identification generated by vidu by default. |
| CallbackUrl |
No |
String |
Callback protocol
You need to actively set Callback_url when creating a task. The request method is POST. Upon video generation completion, a Callback request containing the latest task status will be sent to this address. The content structure of the Callback request matches the return format of the query task API.
The "status" returned by the Callback includes the following states: - success Task completed (e.g., if sending fails, Callback three times)
- failed Task failure (e.g., if sending fails, Callback three times)
|
| Payload |
No |
String |
Pass-through parameter
Without any processing, only data transmission
Note: Up to 1048576 characters |
| OffPeak |
No |
Boolean |
Off-peak mode, defaults to false. Available values: - true: Generate video in off-peak mode;
- false: Generate video instantly;
Note 1: Off-peak mode consumes lower points.
Note 2: Tasks submitted in off-peak mode will be processed within 48 hours. Uncompleted tasks will be canceled automatically, and the points of the task will be returned.
|
3. Output Parameters
| Parameter Name |
Type |
Description |
| JobId |
String |
Task ID. |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Calling the API
POST / HTTP/1.1
Host: vclm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitImageToVideoViduJob
<Common request parameters>
{}
Output Example
{
"Response": {
"JobId": "1384472585461940224",
"RequestId": "3ca4a3d1-28c7-4be5-a394-5902c97dcca4"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.