Help Center/ MetaStudio/ API Reference/ API Overview

Updated on 2024-07-04 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 the Asset List
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/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

Virtual Human Video Production Management

**Table 4** Virtual human 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

Intelligent Live Room Management

**Table 6** 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 7** Livestreaming task management APIs
API	Description
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs	Starting a Virtual Human 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 Human Intelligent Livestreaming Task Details
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/stop	Ending a Virtual Human Intelligent Livestreaming Task
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/command	Controlling Virtual Human Intelligent Livestreaming
GET /v1/{project_id}/smart-live-jobs	Querying All Virtual Human 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

Image Modeling Management

**Table 8** 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 9** Voice modeling task management APIs
API	Description
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}/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
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 10** 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

Previous topic: Concepts

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.