Help Center/ MetaStudio/ API Reference/ API Overview

Updated on 2025-12-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

API Overview

The following tables list the Huawei Cloud MetaStudio APIs. Before calling a MetaStudio API, you need to obtain a user token. The obtained token can then be used to authenticate the calling of other APIs.

Digital Asset Management

**Table 1** Digital asset management APIs
API	Description
POST /v1/{project_id}/digital-assets	Creating an Asset
GET /v1/{project_id}/digital-assets	Querying Assets
PUT /v1/{project_id}/digital-assets/{asset_id}	Updating an Asset
DELETE /v1/{project_id}/digital-assets/{asset_id}	Deleting an Asset
GET /v1/{project_id}/digital-assets/{asset_id}	Querying Asset Details
POST /v1/{project_id}/digital-assets/{asset_id}/restore	Restoring a Deleted Asset
POST /v1/{project_id}/digital-assets/batch-action	Batch Asset Operations
POST /v1/{project_id}/digital-assets/summarys	Querying Asset Summary
GET /v1/{project_id}/digital-assets/{asset_id}/replication-info	Querying Asset Copy Information
POST /v1/{project_id}/digital-assets-by-replication-info	Copying an Asset

File Management

**Table 2** File management APIs
API	Description
DELETE /v1/{project_id}/files/{file_id}	Deleting a File
POST /v1/{project_id}/files	Creating a File and Obtaining the URL for File Upload
POST /v1/{project_id}/files/{file_id}/complete	Confirming the Upload of a File
POST /v1/{project_id}/large-files	Creating a Large File

Video Script Management

**Table 3** Video script management APIs
API	Description
POST /v1/{project_id}/digital-human-video-scripts	Creating a Video Script
GET /v1/{project_id}/digital-human-video-scripts	Querying Video Scripts
GET /v1/{project_id}/digital-human-video-scripts/{script_id}	Querying Video Script Details
PUT /v1/{project_id}/digital-human-video-scripts/{script_id}	Updating a Video Script
DELETE /v1/{project_id}/digital-human-video-scripts/{script_id}	Deleting a Video Script
POST /v1/{project_id}/digital-human-video-scripts/{script_id}/copy	Copying a Video Script

Video Production Management

**Table 4** Video production management APIs
API	Description
GET /v1/{project_id}/digital-human-videos	Querying Video Production Tasks

Virtual Avatar Video Production Management

**Table 5** Virtual avatar video production management APIs
API	Description
POST /v1/{project_id}/2d-digital-human-videos	Creating a Virtual Avatar Video Production Task
GET /v1/{project_id}/2d-digital-human-videos/{job_id}	Querying Virtual Avatar Video Production Task Details
POST /v1/{project_id}/2d-digital-human-videos/{job_id}/cancel	Canceling a Virtual Avatar Video Production Task in the Waiting Status

Virtual Avatar Video Subtitle File Management

**Table 6** Virtual avatar video subtitle file management APIs
API	Description
POST /v1/{project_id}/subtitle-files	Creating a Virtual Avatar Video Subtitle File
GET /v1/{project_id}/subtitle-files/{job_id}	Querying Virtual Avatar Video Subtitle File Details

Intelligent Live Room Management

**Table 7** Intelligent live room management APIs
API	Description
POST /v1/{project_id}/smart-live-rooms	Creating an Intelligent Live Room
GET /v1/{project_id}/smart-live-rooms	Querying Intelligent Live Rooms
GET /v1/{project_id}/smart-live-rooms/{room_id}	Querying Intelligent Livestreaming Script Details
PUT /v1/{project_id}/smart-live-rooms/{room_id}	Updating Intelligent Live Room Information
DELETE /v1/{project_id}/smart-live-rooms/{room_id}	Deleting an Intelligent Live Room
POST /v1/{project_id}/smart-live-interaction-rule-groups	Creating an Interaction Rule Library for Live Rooms
GET /v1/{project_id}/smart-live-interaction-rule-groups	Querying Interaction Rule Libraries for Live Rooms
PUT /v1/{project_id}/smart-live-interaction-rule-groups/{group_id}	Updating an Interaction Rule Library for Live Rooms
DELETE /v1/{project_id}/smart-live-interaction-rule-groups/{group_id}	Deleting an Interaction Rule Library for Live Rooms

Livestreaming Task Management

**Table 8** Livestreaming task management APIs
API	Description
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs	Starting a Virtual Avatar Intelligent Livestreaming Task
GET /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs	Querying Livestreaming Tasks of a Live Room
GET /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}	Querying Virtual Avatar Intelligent Livestreaming Task Details
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/stop	Ending a Virtual Avatar Intelligent Livestreaming Task
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/command	Controlling Virtual Avatar Intelligent Livestreaming
GET /v1/{project_id}/smart-live-jobs	Querying All Virtual Avatar Livestreaming Tasks of a Tenant
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/live-event-report	Reporting Livestreaming Events

Live Product Management

**Table 9** Live product management APIs
API	Description
POST /v1/{project_id}/products	Creating a Product
GET /v1/{project_id}/products	Querying Products
PUT /v1/{project_id}/products/{product_id}	Updating a Product
GET /v1/{project_id}/products/{product_id}	Querying Product Details
DELETE /v1/{project_id}/products/{product_id}	Deleting a Product
POST /v1/{project_id}/products/{product_id}/assets	Configuring a Product Asset Portfolio

Third-Party Live Platform Management

**Table 10** Third-party live platform management APIs
API	Description
POST /v1/{project_id}/live-platforms/platforms	Creating a Third-Party Live Platform
PUT /v1/{project_id}/live-platforms/platforms/{platform_id}	Updating Third-Party Live Platform Information
DELETE /v1/{project_id}/live-platforms/platforms/{platform_id}	Deleting Third-Party Live Platform Information
GET /v1/{project_id}/live-platforms/platforms	Querying Live Platforms
GET /v1/{project_id}/live-platforms/platforms/{platform_id}	Querying Third-Party Live Platforms
GET /v1/{project_id}/live-platforms/products	Querying Products on a Third-Party Live Platform

Virtual Avatar Dialog Management

**Table 11** Virtual avatar dialog management APIs
API	Description
POST /v1/{project_id}/smart-chat-rooms	Creating an Interactive Dialog
GET /v1/{project_id}/smart-chat-rooms	Querying Interactive Dialogs
GET /v1/{project_id}/smart-chat-rooms/{room_id}	Querying Interactive Dialog Details
PUT /v1/{project_id}/smart-chat-rooms/{room_id}	Updating an Interactive Dialog
DELETE /v1/{project_id}/smart-chat-rooms/{room_id}	Deleting an Interactive Dialog

Virtual Avatar Dialog Task Management

**Table 12** Virtual avatar dialog task management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/create-dialog-url	Creating a Dialog URL
POST /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs	Starting a Virtual Avatar Intelligent Interaction Task
POST /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs/{job_id}/stop	Ending a Virtual Avatar Intelligent Interaction Task
GET /v1/{project_id}/digital-human-chat/smart-chat-rooms/{room_id}/smart-chat-jobs/{job_id}/state	Querying Virtual Avatar Intelligent Interaction Tasks

Virtual Avatar Application Management

**Table 13** Virtual avatar application management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/robot	Creating an Application
GET /v1/{project_id}/digital-human-chat/robot	Querying Applications
GET /v1/{project_id}/digital-human-chat/robot/{robot_id}	Querying Application Details
PUT /v1/{project_id}/digital-human-chat/robot/{robot_id}	Modifying an Application
POST /v1/{project_id}/digital-human-chat/robot/delete	Deleting an Application

Virtual Avatar Authentication Code Management

**Table 14** Virtual avatar authentication code management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/once-code	Creating a One-Off Authentication Code

Virtual Avatar Activation Code Management

**Table 15** Virtual avatar activation code management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/active-code	Creating an Activation Code
GET /v1/{project_id}/digital-human-chat/active-code	Querying Activation Codes
GET /v1/{project_id}/digital-human-chat/active-code/{active_code_id}	Querying Activation Code Details
PUT /v1/{project_id}/digital-human-chat/active-code/{active_code_id}	Modifying an Activation Code
PUT /v1/{project_id}/digital-human-chat/active-code/{active_code_id}/reset	Resetting an Activation Code
POST /v1/{project_id}/digital-human-chat/active-code/delete	Deleting an Activation Code

Virtual Avatar Knowledge Base Skill Management

**Table 16** Virtual avatar knowledge base skill management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/knowledge/skill	Creating a Knowledge Base Skill
GET /v1/{project_id}/digital-human-chat/knowledge/skill	Querying Knowledge Base Skills
PUT /v1/{project_id}/digital-human-chat/knowledge/skill/{skill_id}	Modifying a Knowledge Base Skill
GET /v1/{project_id}/digital-human-chat/knowledge/skill/{skill_id}	Querying Knowledge Base Skill Details
POST /v1/{project_id}/digital-human-chat/knowledge/skill/delete	Deleting a Knowledge Base Skill
GET /v1/{project_id}/digital-human-chat/knowledge/skill/{skill_id}/export	Exporting a Knowledge Base Skill

Virtual Avatar Knowledge Base Intent Management

**Table 17** Virtual avatar knowledge base intent management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/knowledge/intent	Creating a Knowledge Base Intent
GET /v1/{project_id}/digital-human-chat/knowledge/intent	Querying Knowledge Base Intents
GET /v1/{project_id}/digital-human-chat/knowledge/intent/{intent_id}	Querying Knowledge Base Intent Details
PUT /v1/{project_id}/digital-human-chat/knowledge/intent/{intent_id}	Modifying a Knowledge Base Intent
POST /v1/{project_id}/digital-human-chat/knowledge/intent/delete	Deleting a Knowledge Base Intent
POST /v1/{project_id}/digital-human-chat/knowledge/intent-question	Creating a Knowledge Base Intent and Question

Virtual Avatar Knowledge Base Question Management

**Table 18** Virtual avatar knowledge base question management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/knowledge/question	Creating a Knowledge Base Question
GET /v1/{project_id}/digital-human-chat/knowledge/question	Querying Knowledge Base Questions
GET /v1/{project_id}/digital-human-chat/knowledge/question/{question_id}	Querying Knowledge Base Question Details
PUT /v1/{project_id}/digital-human-chat/knowledge/question/{question_id}	Modifying a Knowledge Base Question
POST /v1/{project_id}/digital-human-chat/knowledge/question/delete	Deleting a Knowledge Base Question
POST /v1/{project_id}/digital-human-chat/knowledge/question-batch	Batch Creating Knowledge Base Questions
PUT /v1/{project_id}/digital-human-chat/knowledge/question-batch	Batch Modifying Knowledge Base Questions

Virtual Avatar Greeting Management

**Table 19** Virtual avatar greeting management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/welcome-speech	Creating a Greeting
GET /v1/{project_id}/digital-human-chat/welcome-speech	Querying Greetings
GET /v1/{project_id}/digital-human-chat/welcome-speech/{welcome_speech_id}	Querying Greeting Details
PUT /v1/{project_id}/digital-human-chat/welcome-speech/{welcome_speech_id}	Modifying a Greeting
POST /v1/{project_id}/digital-human-chat/welcome-speech/delete	Deleting a Greeting
POST /v1/{project_id}/digital-human-chat/welcome-speech-switch	Determining Whether a Greeting Takes Effect
GET /v1/{project_id}/digital-human-chat/welcome-speech-switch	Querying Whether Greetings Are Enabled

Virtual Avatar Frequently Asked Question Management

**Table 20** Virtual avatar frequently asked question management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/hot-question	Creating a Frequently Asked Question
GET /v1/{project_id}/digital-human-chat/hot-question	Querying Frequently Asked Questions
GET /v1/{project_id}/digital-human-chat/hot-question/{hot_question_id}	Querying Frequently Asked Question Details
PUT /v1/{project_id}/digital-human-chat/hot-question/{hot_question_id}	Modifying a Frequently Asked Question
POST /v1/{project_id}/digital-human-chat/hot-question/delete	Deleting a Frequently Asked Question

Virtual Avatar Keyword Record Management

**Table 21** Virtual avatar keyword record management APIs
API	Description
POST /v1/{project_id}/digital-human-chat/hot-words	Creating a Keyword Record
GET /v1/{project_id}/digital-human-chat/hot-words	Querying Keyword Records
GET /v1/{project_id}/digital-human-chat/hot-words/{hot_words_id}	Querying Keyword Record Details
PUT /v1/{project_id}/digital-human-chat/hot-words/{hot_words_id}	Modifying a Keyword Record
DELETE /v1/{project_id}/digital-human-chat/hot-words/{hot_words_id}	Deleting a Keyword Record
POST /v1/{project_id}/digital-human-chat/hot-words-switch	Determining Whether a Keyword Takes Effect
GET /v1/{project_id}/digital-human-chat/hot-words-switch	Querying Whether Keywords Are Enabled

Virtual Avatar Agency Management

**Table 22** Virtual avatar agency management APIs
API	Description
GET /v1/{project_id}/digital-human-chat/agency	Querying Agencies
POST /v1/{project_id}/digital-human-chat/agency/{role_type}	Creating an Agency
DELETE /v1/{project_id}/digital-human-chat/agency/{role_type}	Deleting an agency

Image Modeling Management

**Table 23** Image modeling management APIs
API	Description
POST /v1/{project_id}/digital-human-training-manage/user/jobs	Creating a Virtual Avatar Model Training Task
GET /v1/{project_id}/digital-human-training-manage/user/jobs	Querying Virtual Avatar Model Training Tasks
GET /v1/{project_id}/digital-human-training-manage/user/jobs/{job_id}	Querying Virtual Avatar Model Training Task Details
DELETE /v1/{project_id}/digital-human-training-manage/user/jobs/{job_id}	Deleting a Virtual Avatar Model Training Task
PUT /v1/{project_id}/digital-human-training-manage/user/jobs/{job_id}	Updating a Virtual Avatar Model Training Task
POST /v1/{project_id}/digital-human-training-manage/user/jobs/{job_id}/command	Executing a Virtual Avatar Model Training Task as a Tenant

Voice Modeling Task Management

**Table 24** Voice modeling task management APIs
API	Description
GET /v1/{project_id}/voice-training-manage/user/tenant-duration-cfg	Querying Personalized Audio Duration
POST /v1/{project_id}/voice-training-manage/user/basic-jobs	Creating a Voice Training Task (Basic Edition)
POST /v1/{project_id}/voice-training-manage/user/middle-jobs	Creating a Voice Training Task (Advanced Edition)
POST /v1/{project_id}/voice-training-manage/user/advance-jobs	Creating a Voice Training Task (Premium Edition)
GET /v1/{project_id}/voice-training-manage/user/jobs	Querying Voice Training Tasks
POST /v1/{project_id}/voice-training-manage/user/jobs/{job_id}	Submitting a Voice Training Task
GET /v1/{project_id}/voice-training-manage/user/jobs/{job_id}	Querying Voice Training Task Details
DELETE /v1/{project_id}/voice-training-manage/user/jobs/{job_id}	Deleting a Voice Training Task
GET /v1/{project_id}/voice-training-manage/user/jobs/{job_id}/op-logs	Querying Task Operation Logs
GET /v1/{project_id}/voice-training-manage/user/jobs/{job_id}/uploading-address-url	Obtaining the URL for Uploading a Voice File
GET /v1/{project_id}/voice-training-manage/user/jobs/{job_id}/audit-result	Obtaining the Review Result of a Voice Training Task
PUT /v1/{project_id}/voice-training-manage/user/batch	Setting the Task Batch
POST /v1/{project_id}/voice-training-manage/user/training-segment	Confirming the Online Recording Result
GET /v1/{project_id}/voice-training-manage/user/training-segment	Obtaining the Confirmed Online Recording Result

TTS Management

**Table 25** TTS management APIs
API	Description
POST /v1/{project_id}/ttsc/audition	Creating a TTS Preview Task
GET /v1/{project_id}/ttsc/audition-file/{job_id}	Obtaining a TTS Preview File
POST /v1/{project_id}/ttsc/async-jobs	Creating an Asynchronous TTS Task
GET /v1/{project_id}/ttsc/async-jobs/{job_id}	Obtaining an Asynchronous TTS Task
POST /v1/{project_id}/ttsc/vocabulary-configs	Configuring a Tenant-Level Custom Pronunciation for TTS
GET /v1/{project_id}/ttsc/vocabulary-configs	Obtaining a Tenant-Level Custom Pronunciation for TTS
DELETE /v1/{project_id}/ttsc/vocabulary-configs	Deleting a Tenant-Level Custom Pronunciation for TTS
PUT /v1/{project_id}/ttsc/vocabulary-configs/{vocabulary_id}	Modifying a Tenant-Level Custom Pronunciation for TTS

Tenant Management

**Table 26** Tenant management APIs
API	Description
GET /v1/{project_id}/tenants/resources-usage	Viewing Tenant Resource Usage
GET /v1/{project_id}/tenants/resources	Viewing Tenant Resources
GET /v1/{project_id}/tenants/resources-count	Collecting Statistics on Resource Quantity in a Time Period

Subscription Management

**Table 27** Subscription management APIs
API	Description
POST /v1/{project_id}/mss/public/orders	Subscribing to a MetaStudio Product

Previous topic: Before You Start

Next topic: Calling APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.