- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
Query the task's production progress and results through the taskId.
Calling Protocol
HTTPS + JSON
POST /v2/ivh/assetmanager/customservice/getprogress
Header Content-Type: application/json;charset=utf-8
Request Parameters
Parameters | Type | Mandatory | Description |
TaskId | string | Yes | The taskId returned by the Custom API |
Response Parameter
Parameters | Type | Mandatory | Description |
Status | string | Yes | Task production status: MAKING: In process SUCCESS: Production succeeded FAIL: Production failed |
FailMessage | string | No | When the Status is FAIL, the error reason is returned for troubleshooting. |
StageV2 | string | No | (New Version) When the Status is MAKING, the specific stage of the task in progress is returned: SUBMIT: Material submission AUDIT: Manual review PROCESS: Preprocessing (only applicable for avatar customization) TRAIN: Intelligent training CONFIRM: Effect confirmation (not applicable for photo customization) END: Completion |
StatusV2 | string | No | When StageV2 is at a certain stage, the specific status of that stage is: WAIT_PROCESS: To be processed PROCESSING: In process SUCCESS: Succeeded FAIL: Failed |
StageInfo | string | No | Extra information for a certain stage, strings in JSON format, and the JSON format types for different stages are listed in the table below. Currently, only the effect confirmation stage (StageV2: CONFIRM) has values. |
AssetList | Array of [AssetInfo] | No | Returns the avatar or voice information for customization. Currently supported customization types are:
IMAGE_PHOTO: Photo Avatar Image Customization
ZERO_SHOT_VOICE: Voice Clone (ultra edition) |
Extra StageInfo information for different stages is shown in the table below:
StageV2 | Type | Description | Example |
CONFIRM: effect confirmation stage | string of [CustomerConfirmContent] | When the stage is at the effect confirmation stage (StageV2: CONFIRM) and the status is to be processed (StatusV2: WAIT_PROCESS), a demo video of the effect to be confirmed is returned. The customer can call the Effect Confirmation API to approve or reject the effect of the demo video based on the returned video. | {\\"TrainResult\\":[\\"url1\\",\\"url2\\"],\\"RejectReason\\":\\"\\",\\"TrainRecord\\":[{\\"StartTime\\":\\"2023-11-01 23:00:17\\",\\"Record\\":[\\"url1\\",\\"url2\\"]}]} |
CustomerConfirmContent
Parameters | Type | Mandatory | Description |
TrainResult | Array of [string] | Yes | URL address of the demo video for customer to confirm the effect |
RejectReason | string | Yes | Reasons for the digital human side not accepting retraining |
TrainRecord | Array of [TrainRecord] | No | List of demo videos of historical training |
TrainRecord
Parameters | Type | Mandatory | Description |
StartTime | string | Yes | Historical training time |
Record | Array of [string] | Yes | URL address of demo videos of historical training |
AssetInfo
Parameters | Type | Mandatory | Description |
VirtualmanTypeCode | string | No | Digital human type code, see Appendix 3 - Types of Intelligent Humans, returned by avatar customization |
VirtualmanKey | string | No | Digital human virtualmankey, returned by avatar customization |
Resolution | string | No | Digital human resolution, returned by avatar customization |
OriginZoom | string | No | Scale factor, rounded to three decimal places, returned by avatar customization |
VirtualmanResourceId | int32 | No | Digital human resource ID, returned by avatar customization |
TimbreKey | string | No | Timbre key, returned by voice clone |
TimbreSample | string | No | Timbre demo link, returned by voice clone |
MakeType | string | Yes | Customization Types:
IMAGE_PHOTO: Photo Avatar Image Customization
ZERO_SHOT_VOICE: Voice Clone (ultra edition) |
Request Sample
{"Header": {},"Payload": {"TaskId": 666}}
Response Sample
{"Header": {"RequestID": "gz1a74c25f17030396653416949","SessionID": "gz1a74c25f17030396653416950","DialogID": "","Code": 0,"Message": "ok"},"Payload": {"StageInfo": "{\\"TrainResult\\":[\\"url1\\",\\"url2\\"],\\"RejectReason\\":\\"\\",\\"TrainRecord\\":[{\\"StartTime\\":\\"2023-11-01 23:00:17\\",\\"Record\\":[\\"url1\\",\\"url2\\"]}]}","Status": "MAKING","StatusV2": "WAIT_PROCESS","FailMessage": "","StageV2": "CONFIRM"}}
Yes
No
Was this page helpful?