1. API Description
Domain name for API request: vclm.intl.tencentcloudapi.com.
This API is used to query image animation tasks. The image animation feature supports generating videos based on dance movements and images to meet the needs of scenarios such as social entertainment and interactive marketing.
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.
2. Input Parameters
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: DescribeImageAnimateJob. |
| 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. |
| JobId | No | String | Task ID. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Task status. WAIT: waiting; RUN: running; FAIL: failed; DONE: successful. |
| ErrorCode | String | Error code. |
| ErrorMessage | String | Error message. |
| ResultVideoUrl | String | Generated video URL. It is valid for 24 hours. |
| MaskVideoUrl | String | Masked video URL. |
| 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 Successful API call example
Successful API call example
Input Example
POST / HTTP/1.1
Host: vclm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageAnimateJob
<Common request parameters>
{
"JobId": "1194931538865782784"
}
Output Example
{
"Response": {
"ErrorCode": "",
"ErrorMessage": "",
"RequestId": "a06a2134-0306-4554-aa9a-232271bfda4f",
"ResultVideoUrl": "",
"Status": "RUN"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation.DriverFailed | Driving failed. |
| FailedOperation.ImageBodySmall | The height of the body (from head to ankle) in the input image accounts for less than half of the image height. |
| FailedOperation.ImageCheckNoBody | No human body is detected in the input image. |
| FailedOperation.ImageDetectFaceFailed | Failed to detect the face in the input image. |
| FailedOperation.ImageManyPeople | Multiple human faces are detected in the input image. |
| FailedOperation.ImageRadioExcceed | The aspect ratio of the input image is not within the range of 1:1.2 to 1:2. |
| FailedOperation.JobNotFound | The task does not exist. |
| FailedOperation.KeyPointUndetected | The core joints are not detected. |
| FailedOperation.TemplateFirstFrameNotDetectFace | No face is detected in the first frame of the template video. |
| FailedOperation.TemplateNotDetectBody | The template video contains frames with no human body detected. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Invalid parameter value. |
| RequestLimitExceeded | Too many and frequent requests. |
| RequestLimitExceeded.JobNumExceed | The number of submitted tasks exceeds the maximum number of concurrent tasks. |
| UnauthorizedOperation | Unauthorized operation. |
Yes
No
Was this page helpful?