APIs
Constraints on APIs
See Table 1.
|
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 |
|
|
Virtual Avatar Video Subtitle File Management |
Creating a Virtual Avatar Video Subtitle File |
5 times per second |
3 times per second |
3 times per second |
|
Querying Virtual Avatar Video Subtitle File Details |
20 times per second |
10 times per second |
10 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 |
|
|
Third-Party Live Platform Management |
Creating a Third-Party Live Platform |
Once per second |
Once per second |
Once per second |
|
Updating Third-Party Live Platform Information |
Once per second |
Once per second |
Once per second |
|
|
Deleting Third-Party Live Platform Information |
Once per second |
Once per second |
Once per second |
|
|
Querying Live Platforms |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Third-Party Live Platforms |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Products on a Third-Party Live Platform |
5 times per second |
3 times per second |
3 times per second |
|
|
Virtual Avatar Dialog Management |
Creating an Interactive Dialog |
5 times per second |
3 times per second |
- |
|
Querying Interactive Dialogs |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Interactive Dialog Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Updating an Interactive Dialog |
5 times per second |
3 times per second |
- |
|
|
Deleting an Interactive Dialog |
5 times per second |
3 times per second |
- |
|
|
Virtual Avatar Dialog Task Management |
Creating a Dialog URL |
5 times per second |
3 times per second |
- |
|
Starting a Virtual Avatar Intelligent Interaction Task |
5 times per second |
3 times per second |
- |
|
|
Ending a Virtual Avatar Intelligent Interaction Task |
5 times per second |
3 times per second |
- |
|
|
Querying Virtual Avatar Intelligent Interaction Tasks |
20 times per second |
10 times per second |
10 times per second |
|
|
Virtual Avatar Application Management |
Creating an Application |
5 times per second |
3 times per second |
- |
|
Querying Applications |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Application Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying an Application |
5 times per second |
10 times per second |
- |
|
|
Deleting an Application |
5 times per second |
3 times per second |
- |
|
|
Virtual Avatar Authentication Code Management |
Creating a One-Off Authentication Code |
20 times per second |
10 times per second |
- |
|
Virtual Avatar Activation Code Management |
Creating an Activation Code |
5 times per second |
3 times per second |
- |
|
Querying Activation Codes |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Activation Code Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying an Activation Code |
5 times per second |
3 times per second |
- |
|
|
Resetting an Activation Code |
5 times per second |
3 times per second |
- |
|
|
Deleting an Activation Code |
5 times per second |
3 times per second |
- |
|
|
Virtual Avatar Knowledge Base Skill Management |
Creating a Knowledge Base Skill |
4 times per second |
3 times per second |
3 times per second |
|
Querying Knowledge Base Skills |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying a Knowledge Base Skill |
4 times per second |
3 times per second |
3 times per second |
|
|
Querying Knowledge Base Skill Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Deleting a Knowledge Base Skill |
4 times per second |
3 times per second |
3 times per second |
|
|
Exporting a Knowledge Base Skill |
Once per second |
Once per second |
Once per second |
|
|
Virtual Avatar Knowledge Base Intent Management |
Creating a Knowledge Base Intent |
4 times per second |
3 times per second |
3 times per second |
|
Querying Knowledge Base Intents |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Knowledge Base Intent Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying a Knowledge Base Intent |
4 times per second |
3 times per second |
3 times per second |
|
|
Deleting a Knowledge Base Intent |
4 times per second |
3 times per second |
3 times per second |
|
|
Creating a Knowledge Base Intent and Question |
4 times per second |
3 times per second |
3 times per second |
|
|
Virtual Avatar Knowledge Base Question Management |
Creating a Knowledge Base Question |
4 times per second |
3 times per second |
3 times per second |
|
Querying Knowledge Base Questions |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Knowledge Base Question Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying a Knowledge Base Question |
4 times per second |
3 times per second |
3 times per second |
|
|
Deleting a Knowledge Base Question |
4 times per second |
3 times per second |
3 times per second |
|
|
Batch Creating Knowledge Base Questions |
Once per second |
Once per second |
Once per second |
|
|
Batch Modifying Knowledge Base Questions |
Once per second |
Once per second |
Once per second |
|
|
Virtual Avatar Greeting Management |
Creating a Greeting |
4 times per second |
3 times per second |
3 times per second |
|
Querying Greetings |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Greeting Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying a Greeting |
4 times per second |
3 times per second |
3 times per second |
|
|
Deleting a Greeting |
4 times per second |
3 times per second |
3 times per second |
|
|
Determining Whether to Configure a Greeting |
4 times per second |
3 times per second |
3 times per second |
|
|
Querying Whether Greetings Are Enabled |
20 times per second |
10 times per second |
10 times per second |
|
|
Virtual Avatar Frequently Asked Question Management |
Creating a Frequently Asked Question |
4 times per second |
3 times per second |
3 times per second |
|
Querying Frequently Asked Questions |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Frequently Asked Question Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying a Frequently Asked Question |
4 times per second |
3 times per second |
3 times per second |
|
|
Deleting a Frequently Asked Question |
4 times per second |
3 times per second |
3 times per second |
|
|
Virtual Avatar Keyword Record Management |
Creating a Keyword Record |
4 times per second |
3 times per second |
3 times per second |
|
Querying Keyword Records |
20 times per second |
10 times per second |
10 times per second |
|
|
Querying Keyword Record Details |
20 times per second |
10 times per second |
10 times per second |
|
|
Modifying a Keyword Record |
4 times per second |
3 times per second |
3 times per second |
|
|
Deleting a Keyword Record |
4 times per second |
3 times per second |
3 times per second |
|
|
Determining Whether to Configure a Keyword |
4 times per second |
3 times per second |
3 times per second |
|
|
Querying Whether Keywords Are Enabled |
20 times per second |
10 times per second |
10 times per second |
|
|
Virtual Avatar Agency Management |
Querying Agencies |
20 times per second |
10 times per second |
10 times per second |
|
Creating an Agency |
Once per second |
Once per second |
- |
|
|
Deleting an Agency |
Once per second |
Once 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 |
|
|
Creating an Asynchronous TTS Task |
5 times per second |
3 times per second |
3 times per second |
|
|
Obtaining an Asynchronous TTS Task |
20 times per second |
10 times per second |
10 times per second |
|
|
Configuring a Tenant-Level Custom Pronunciation for TTS |
10 times per second |
3 times per second |
3 times per second |
|
|
Obtaining a Tenant-Level Custom Pronunciation for TTS |
10 times per second |
3 times per second |
3 times per second |
|
|
Deleting a Tenant-Level Custom Pronunciation for TTS |
10 times per second |
3 times per second |
3 times per second |
|
|
Modifying a Tenant-Level Custom Pronunciation for TTS |
10 times per second |
3 times per second |
3 times per second |
|
API Category |
API |
Single Tenant |
System-based |
|---|---|---|---|
|
Tenant Management |
Viewing Tenant Resource Usage |
10 times per second |
20 times per second |
|
Viewing Tenant Resources |
10 times per second |
20 times per second |
|
|
Collecting Statistics on Resource Quantity in a Time Period |
10 times per second |
20 times per second |
|
|
Subscription Management |
Subscribing to a MetaStudio Product |
Once per second |
10 times per second |
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
