Before You Start
The MetaStudio solution offers a wide range of services, such as virtual avatar video production, livestreaming, and intelligent interaction, breathing new life into content creation across industries.
This document describes how to use application programming interfaces (APIs) to perform operations on Huawei Cloud MetaStudio, such as image modeling, voice modeling, and video production. For details about all supported operations, see API Overview.
Before calling APIs of Huawei Cloud MetaStudio, ensure that you are familiar with MetaStudio. For details, see Service Overview.
MetaStudio supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see Calling APIs.
Endpoints
An endpoint is the request address for calling an API. Endpoints vary depending on regions and services. For the endpoints of MetaStudio, see Table 1. You can also query the endpoints of MetaStudio from Regions and Endpoints.
Constraints on APIs
See Table 2.
|
Item |
Constraint |
|---|---|
|
Timbre |
Before selecting a timbre by calling livestreaming or intelligent interaction APIs, check whether the timbre is available on the live room editing or dialog setting page of the MetaStudio console. The API calling will be successful only when the timbre is available on the page. |
|
Intelligent interaction |
The following three intelligent interaction API groups apply only to iFLYTEK AIUI and iFLYTEK Spark Cognitive Model:
|
API Request Throttling
MetaStudio sets a limit on the number of API calls to prevent service interruption caused by repeated API calls in a short period of time.
If the error message APIGW.0308 is returned when an API is called, the API request throttling is triggered. You need to adjust the API calling interval by referring to the following table. Alternatively, wait for a period of time and then send API requests.
For details about error codes starting with APIGW, see Error Codes.
|
API Category |
API |
Single Tenant (CN North-Beijing4) |
Single Tenant (CN East-Shanghai1) |
Single Tenant (AP-Singapore) |
|---|---|---|---|---|
|
Digital Asset Management |
Creating an Asset |
10 times per second |
5 times per second |
5 times per second |
|
Querying Assets |
20 times per second |
10 times per second |
10 times per second |
|
|
Updating an Asset |
10 times per second |
5 times per second |
5 times per second |
|
|
Deleting an Asset |
10 times per second |
5 times per second |
5 times per second |
|
|
Querying Asset Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Restoring a Deleted Asset |
10 times per second |
5 times per second |
5 times per second |
|
|
Batch Asset Operations |
Once per second |
Once per second |
Once per second |
|
|
Querying Asset Summary |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Asset Copy Information |
20 times per second |
10 times per second |
10 times per second |
|
|
Copying an Asset |
4 times per second |
3 times per second |
3 times per second |
|
|
File Management |
Creating a File and Obtaining the URL for File Upload |
10 times per second |
5 times per second |
5 times per second |
|
Deleting a File |
10 times per second |
5 times per second |
5 times per second |
|
|
Confirming the Upload of a File |
10 times per second |
5 times per second |
5 times per second |
|
|
Creating a Large File |
10 times per second |
5 times per second |
5 times per second |
|
|
Video Script Management |
Creating a Video Script |
10 times per second |
5 times per second |
5 times per second |
|
Querying Video Scripts |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Video Script Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Updating a Video Script |
10 times per second |
5 times per second |
5 times per second |
|
|
Deleting a Video Script |
10 times per second |
5 times per second |
5 times per second |
|
|
Copying a Video Script |
10 times per second |
5 times per second |
5 times per second |
|
|
Video Production Management |
Querying Video Production Tasks |
20 times per second |
10 times per second |
10 times per second |
|
Virtual Avatar Video Production Management |
Creating a Virtual Avatar Video Production Task |
5 times per second |
3 times per second |
3 times per second |
|
Querying Virtual Avatar Video Production Task Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Canceling a Virtual Avatar Video Production Task in the Waiting Status |
5 times per second |
3 times per second |
3 times per second |
|
|
Intelligent Live Room Management |
Creating an Intelligent Live Room |
5 times per second |
3 times per second |
3 times per second |
|
Querying Intelligent Live Rooms |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Intelligent Livestreaming Script Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Updating Intelligent Live Room Information |
5 times per second |
3 times per second |
3 times per second |
|
|
Deleting an Intelligent Live Room |
4 times per second |
3 times per second |
3 times per second |
|
|
Creating an Interaction Rule Library for Live Rooms |
4 times per second |
3 times per second |
3 times per second |
|
|
Querying Interaction Rule Libraries for Live Rooms |
20 times per second |
10 times per second |
10 times per second |
|
|
Updating an Interaction Rule Library for Live Rooms |
4 times per second |
3 times per second |
3 times per second |
|
|
Deleting an Interaction Rule Library for Live Rooms |
4 times per second |
3 times per second |
3 times per second |
|
|
Livestreaming Task Management |
Starting a Virtual Avatar Intelligent Livestreaming Task |
4 times per second |
3 times per second |
3 times per second |
|
Querying Livestreaming Tasks of a Live Room |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Virtual Avatar Intelligent Livestreaming Task Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Ending a Virtual Avatar Intelligent Livestreaming Task |
4 times per second |
3 times per second |
3 times per second |
|
|
Controlling Virtual Avatar Intelligent Livestreaming |
4 times per second |
3 times per second |
3 times per second |
|
|
Querying All Virtual Avatar Livestreaming Tasks of a Tenant |
10 times per second |
5 times per second |
5 times per second |
|
|
Reporting Livestreaming Events |
4 times per second |
3 times per second |
3 times per second |
|
|
Live Product Management |
Creating a Product |
4 times per second |
3 times per second |
3 times per second |
|
Querying Products |
20 times per second |
10 times per second |
10 times per second |
|
|
Updating a Product |
4 times per second |
3 times per second |
3 times per second |
|
|
Querying Product Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Deleting a Product |
4 times per second |
3 times per second |
3 times per second |
|
|
Configuring a Product Asset Portfolio |
4 times per second |
3 times per second |
3 times per second |
|
|
Image Modeling Management |
Creating a Virtual Avatar Model Training Task |
10 times per second |
3 times per second |
3 times per second |
|
Querying Virtual Avatar Model Training Tasks |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Virtual Avatar Model Training Task Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Deleting a Virtual Avatar Model Training Task |
10 times per second |
3 times per second |
3 times per second |
|
|
Updating a Virtual Avatar Model Training Task |
10 times per second |
3 times per second |
3 times per second |
|
|
Executing a Virtual Avatar Model Training Task as a Tenant |
10 times per second |
3 times per second |
3 times per second |
|
|
Voice Modeling Task Management |
Querying Personalized Audio Duration |
20 times per second |
10 times per second |
10 times per second |
|
Creating a Voice Training Task (Basic Edition) |
10 times per second |
3 times per second |
3 times per second |
|
|
Creating a Voice Training Task (Advanced Edition) |
10 times per second |
3 times per second |
3 times per second |
|
|
Creating a Voice Training Task (Premium Edition) |
10 times per second |
3 times per second |
3 times per second |
|
|
Querying Voice Training Tasks |
20 times per second |
10 times per second |
10 times per second |
|
|
Submitting a Voice Training Task |
10 times per second |
3 times per second |
3 times per second |
|
|
Querying Voice Training Task Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Deleting a Voice Training Task |
10 times per second |
3 times per second |
3 times per second |
|
|
Querying Task Operation Logs |
20 times per second |
10 times per second |
10 times per second |
|
|
Obtaining the URL for Uploading a Voice File |
20 times per second |
10 times per second |
10 times per second |
|
|
Obtaining the Review Result of a Voice Training Task |
20 times per second |
10 times per second |
10 times per second |
|
|
Setting the Task Batch |
10 times per second |
3 times per second |
3 times per second |
|
|
Confirming the Online Recording Result |
10 times per second |
3 times per second |
3 times per second |
|
|
Obtaining the Confirmed Online Recording Result |
20 times per second |
10 times per second |
10 times per second |
|
|
TTS Management |
Creating a TTS Preview Task |
5 times per second |
3 times per second |
3 times per second |
|
Obtaining a TTS Preview File |
20 times per second |
10 times per second |
10 times per second |
Concepts
- Account
A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.
- IAM user
An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).
An IAM user can view the account ID and user ID on the My Credentials page of the console. The domain name, username, and password will be required for API authentication.
- Region
A region is a physical location where cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet but AZs in different regions cannot communicate with each other. For low network latency and quick resource access, select the nearest region. The choice of regions may also be subject to legal compliance requirements.
- AZ
An AZ is one or more physical data centers within a region. It has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, networking, storage, and other resources are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers for high availability.
- Project
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
Figure 1 Project isolating model
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
