API Overview

All ModelArts APIs are proprietary.

You can use these APIs to manage datasets, training jobs, models, and services.

Data Management APIs

Table 1 Dataset management APIs

API	Description
Querying the Dataset List	Query created datasets by page based on specified conditions.
Creating a Dataset	Create a new dataset and determine whether to enable team labeling. Enable team labeling. The subsequent operations vary depending on the specified role. If a team is specified to assign labeling tasks, the team labeling task is started after the dataset is created. If a task manager is specified to assign labeling tasks, the manager calls the API for starting a team labeling task to assign and start the team labeling tasks. Disable team labeling. To enable team labeling later, call the API for creating a team labeling task to create team labeling tasks for the dataset.
Querying Details About a Dataset	Query details about a dataset, including the dataset name, type, and version name based on the dataset ID.
Modifying a Dataset	Modify basic information about a dataset, such as the dataset name, description, version, or labels. Modified labels take effect in the entire dataset, including the samples in the dataset.
Deleting a Dataset	Delete a dataset based on the dataset ID to release resources.
Querying Dataset Statistics	Query dataset statistics, such as sample statistics, label statistics, or hard examples based on specified conditions.
Querying the Monitoring Data of a Dataset	Query the monitoring data of a dataset within a specified period, such as the number of labeled samples, number of unlabeled samples, and total number of samples at each time point within the period.

Table 2 APIs for managing dataset versions

API	Description
Querying the Dataset Version List	Query the versions of a dataset based on the dataset ID to learn about the dataset version evolution.
Creating a Dataset Labeling Version	Publish a modified dataset as a new version. The modification includes labeling samples, adding samples, and deleting samples in the dataset.
Querying Details About a Dataset Labeling Version	Query details about a specified dataset labeling version, including the name, description, number of files, and storage path based on the dataset ID and version ID.
Deleting a Dataset Labeling Version	Delete a dataset version based on the dataset ID and version ID.

Table 3 APIs for managing samples

API	Description
Querying the Sample List	Query dataset samples by page based on specified conditions.
Adding Samples in Batches	Add samples to a dataset in batches for data labeling.
Deleting Samples in Batches	Delete unused samples from a dataset in batches.
Querying Details About a Sample	Query a single sample based on the sample ID, including the sample status and labels.
Obtaining Sample Search Criteria	Obtain sample search criteria, such as the label list and attribute key-value pairs of the dataset based on the dataset ID.
Querying the Sample List of a Team Labeling Task by Page	Query the samples of a team labeling task on the data labeling platform by page based on the dataset ID and team labeling task ID.
Querying Details About a Team Labeling Sample	Query details about a sample in a team labeling task on the data labeling platform based on the dataset ID, team labeling task ID, and sample ID.

Table 4 APIs for managing labels

API	Description
Querying the Dataset Label List	Query the labels in a specified dataset version.
Creating a Dataset Label	Create labels during dataset labeling. This function is available only in datasets of the text classification and named entity types.
Modifying Labels in Batches	Modify dataset labels in batches. The modification takes effect in the entire dataset, including the samples in the dataset.
Deleting Labels in Batches	Delete dataset labels in batches and determine whether to delete the samples with the labels.
Updating a Label by Label Name	Modify a label in a dataset based on the label name. The modification takes effect in the entire dataset, including the samples in the dataset.
Deleting a Label and the Files with This Label Only	Delete a label in a dataset based on the label name and determine whether to delete the samples with the label.

Table 5 APIs for manual labeling

API

Description

Updating Sample Labels in Batches

Label multiple samples in a dataset in batches. Label unlabeled samples. You can use an existing label or create a new label. Add, modify, or delete labels for labeled samples. You can use an existing label or create a new label. This API uses a new label list to overwrite the original one to update the sample labels. For example, if an empty label list is used to overwrite the original one, all sample labels will be deleted.

Table 6 APIs for managing labeling tasks

API	Description
Querying the Team Labeling Task List of a Dataset	Query the team labeling tasks of a dataset based on the dataset ID.
Creating a Team Labeling Task	Create a team labeling task based on an existing dataset so that multiple members can concurrently label the dataset. If a team is specified to assign labeling tasks, the team labeling task is started after the task is created. If a task manager is specified to assign labeling tasks, the manager calls the API for starting a team labeling task to assign and start the team labeling tasks.
Querying Details About a Team Labeling Task	Query details about a team labeling task based on the dataset ID and team labeling task ID, including the task name, data, and team information.
Starting a Team Labeling Task	Assign and start a team labeling task on the data labeling platform based on the dataset ID and team labeling task ID as the team labeling task manager.
Updating a Team Labeling Task	Update the description, name, and team information of a team labeling task based on the dataset ID and team labeling task ID.
Deleting a Team Labeling Task	Delete a team labeling task based on the dataset ID and team labeling task ID.
Creating a Team Labeling Acceptance Task	Start an acceptance task for a team labeling task based on the dataset ID and team labeling task ID.
Querying the Report of a Team Labeling Acceptance Task	Query the report and statistics of a team labeling acceptance task based on the dataset ID and team labeling task ID.
Updating the Status of a Team Labeling Acceptance Task	Determine the acceptance scope for a team labeling task, including all labeled data, and update the sample data accordingly.
Querying Statistics for a Team Labeling Task	Query statistics for a team labeling task on the data labeling platform, such as the sample statistics, label statistics, and hard example set based on the dataset ID and team labeling task ID.
Obtaining Details About the Progress of a Team Labeling Task Member	Query details about the progress of a team labeling task member in a team labeling task based on the dataset ID and team labeling task ID.
Querying the Team Labeling Task List by a Team Member	Obtain all team labeling tasks on the data labeling platform by page as a member in a team labeling task.

Table 7 APIs for managing the team labeling process

API	Description
Submitting Sample Review Comments of an Acceptance Task	During the acceptance of a team labeling task, provide review comments on samples, including the review result and score.
Reviewing Team Labeling Results	Review the team labeling task on the data labeling platform based on the dataset ID and team labeling task ID, determine the review result, and provide review comments as the team labeling task manager.
Updating Labels of Team Labeling Samples in Batches	Update sample labels on the data labeling platform in batches, including adding, modifying, and deleting the sample labels. Ensure that only the labels in the dataset can be added or modified.

Table 8 APIs for managing team labeling

API	Description
Querying the Labeling Team List	Query all labeling teams by page.
Creating a Labeling Team	Add a labeling team.
Querying Details About a Labeling Team	Query details about a labeling team, including the team name, description, and total number of members based on the team ID.
Updating a Labeling Team	Update the name and description of a labeling team based on the team ID.
Deleting a Labeling Team	Delete a labeling team based on the team ID.

Table 9 APIs for managing team labeling members

API	Description
Sending an Email to Labeling Team Members	Send an email to members in a labeling team to notify them of starting the team labeling task after the task is created.
Querying the List of All Labeling Team Members	Query all labeling team members by page based on specified conditions.
Querying Members in a Labeling Team	Obtain members in a labeling team by page based on the team ID.
Creating a Labeling Team Member	Add new members to a labeling team.
Deleting Labeling Team Members in Batches	Delete multiple members from a labeling team in batches.
Querying Details About a Labeling Team Member	Query details about a member in a labeling team, including the member description, email address, and role based on the team ID and member ID.
Updating a Labeling Team Member	Update the description and role of a member in a labeling team based on the team ID and member ID.
Deleting a Labeling Team Member	Delete a member from a labeling team based on the team ID and member ID.

Table 10 APIs for importing data

API	Description
Querying the Dataset Import Task List	Query historical tasks imported to a dataset by page based on the dataset ID.
Creating an Import Task	Create a dataset import task to import labels and data (such as manifest files and OBS data) from a storage system to the dataset.
Querying Details About a Dataset Import Task	Query details about a dataset import task based on the dataset ID and task ID to learn about the data source, import mode, and task status.

Table 11 APIs for exporting data

API	Description
Querying the Dataset Export Task List	Query historical tasks exported from a dataset by page based on the dataset ID.
Creating a Dataset Export Task	Export certain data as a new dataset or to OBS.
Querying the Status of a Dataset Export Task	Query details about a dataset export task based on the dataset ID and task ID to learn about the export type, task status, and number of samples.

Table 12 APIs for synchronizing data

API	Description
Synchronizing a Dataset	Synchronize data and labels from the dataset input path to the dataset.
Querying the Status of a Dataset Synchronization Task	Query the status of a data source synchronization task based on the dataset ID.

Table 13 Auto labeling task APIs

API	Description
Querying the Auto Labeling Sample List	Query the to-be-confirmed auto labeling samples in a dataset by page based on the dataset ID.
Querying Details About an Auto Labeling Sample	Query information of a single auto labeling sample based on the dataset ID and sample ID, such as the sample labels, hard example details, and sample type.
Querying Auto Labeling Tasks by Page	Query all auto labeling tasks by page based on the dataset ID.
Starting an Auto Labeling Task	Start an auto labeling task for unlabeled data to quickly label the data. After the auto labeling task is complete, call the API for updating sample labels in batches to check the labeling result.
Obtaining Details About an Auto Labeling Task	Obtain details about an auto labeling task based on the dataset ID and task ID to learn about the task configuration, name, and status.
Stopping an Auto Labeling Task	Stop an ongoing auto labeling task based on the dataset ID and task ID.

Table 14 Data processing APIs

API	Description
Querying the Data Processing Task List	Query all data processing tasks by page. Data processing extracts valuable data from a large amount of disordered, difficult-to-understand data.
Creating a Data Processing Task	Create a data processing task. Data processing involves data validation, data cleansing, data selection, and data augmentation.
Querying the Algorithms for a Data Processing Type	Query the algorithms available for a data processing type.
Querying Details About a Data Processing Task	Query details about a data processing task, including the task description, status, and version based on the task ID.
Updating a Data Processing Task	Update the description of a data processing task based on the task ID.
Deleting a Data Processing Task	Delete a data processing task based on the task ID.
Querying the Versions of a Data Processing Task	Query the versions of a data processing task by page based on the task ID.
Creating a Data Processing Task Version	Publish a data processing task as a new version after the task parameters are modified.
Querying Details About a Data Processing Task Version	Query details about a version of a data processing task, including the version description, task status, and algorithm template based on the task ID and version ID.
Deleting a Data Processing Task Version	Delete a version of a data processing task based on the task ID and version ID.
Querying the Result of a Data Processing Task Version	Query results of a data processing task by page based on the task ID and version ID.
Stopping a Data Processing Task Version	Stop an ongoing data processing task based on the task ID and version ID.

DevEnviron APIs

Table 15 DevEnviron APIs (new version)

Type	API	Description
Managing DevEnviron instances	Querying Notebook Instances	Query the list of notebook instances meeting search criteria.
	Creating a Notebook Instance	Create a notebook instance based on parameters such as the instance flavor, AI engine, and storage.
	Querying Details About a Notebook Instance	Query details about a notebook instance.
	Updating a Notebook Instance	Update a notebook instance.
	Deleting a Notebook Instance	Delete the container and all storage resources of a notebook instance.
	Saving a Running Instance as a Container Image	Save the running instance as a container image. In the saved image, the installed dependency package (pip package) is retained. In VS Code remote development, the plug-ins installed on the server are retained.
	Obtaining Available Flavors	Obtain available flavors.
	Obtaining Flavors Available for a Notebook Instance	Obtain the flavors available for a notebook instance.
	Obtaining the Available Duration of a Running Notebook Instance	Obtain the available duration of a running notebook instance.
	Prolonging a Notebook Instance	Prolong the available duration of a running notebook instance.
	Starting a Notebook Instance	Start a notebook instance.
	Stopping a Notebook Instance	Stop a notebook instance.
Dynamically mounting OBS	Obtaining the Notebook Instances with OBS Storage Mounted	Obtain the notebook instances with OBS storage mounted.
	Dynamically Mounting OBS	Dynamically mount OBS to a notebook instance in the running state.
	Obtaining Details About a Notebook Instance with OBS Storage Mounted	Obtain details about a notebook instance with OBS storage mounted.
	Dynamically Unmounting OBS	Dynamically unmount OBS from a notebook instance.
Image management	Obtaining Supported Images	Obtain all images by page based on specified conditions.
	Registering a Custom Image	Register a custom image with ModelArts image management.
	Obtaining User Image Groups	Obtain the overview of user image information. Image names are used for aggregation.
	Obtaining Details About an Image	Obtain details about an image.
	Deleting an Image	Delete an image. For a private image, you can also delete its SWR image using parameters.

Table 16 DevEnviron APIs (old version)

API	Description
Creating a Development Environment Instance	Create a development environment instance for code development.
Obtaining Development Environment Instances	Obtain the development environment instances that meet the search criteria.
Obtaining Details About a Development Environment Instance	Query details about a notebook instance.
Modifying the Description of a Development Environment Instance	Modify the description of a development environment instance.
Deleting a Development Environment Instance	Delete a development environment instance.
Managing a Development Environment Instance	Start or stop a development environment instance.

Training Management APIs

Table 17 Algorithm management APIs

API	Description
Creating an Algorithm	Create an algorithm.
Obtaining Algorithms	Obtain algorithms.
Obtaining Details About an Algorithm	Obtain a specified algorithm based on the algorithm ID.
Updating an Algorithm	Update an algorithm.
Deleting an Algorithm	Delete an algorithm.

Table 18 APIs for managing training jobs

API	Description
Creating a Training Job	Create a training job.
Obtaining Details About a Training Job	Obtain details about a training job.
Modifying the Description of a Training Job	Modify the description of a training job.
Deleting a Training Job	Delete a training job.
Terminate a Training Job	Terminate a training job. Only jobs in the creating, awaiting, or running state can be terminated.
Obtaining the Logs of a Specified Task in a Training Job (Preview)	Obtain the logs of a specified task in a training job (preview).
Obtaining the Logs of a Specified Task in a Training Job (OBS Link)	Obtain the logs of a specified task in a training job (OBS link). You can view all logs or download the logs.
Obtaining the Runtime Metrics of a Specified Task in a Training Job	Obtain the runtime metrics of a specified task in a training job.
Obtaining Training Jobs	Obtain the created training jobs by search criteria.

Table 19 APIs for resources and engine specifications

API	Description
Obtaining the General Specifications Supported by a Training Job	Obtain the general specifications supported by a training job.
Obtaining the Preset AI Frameworks Supported by a Training Job	Obtain the preset AI frameworks supported by a training job.

Model Management APIs

Table 20 Model management APIs

API	Description
Importing a Model	Import a model.
Obtaining Models	Obtain the models that meet the search criteria.
Viewing Details About a Model	View details about a model based on the model ID.
Deleting a Model	Delete a specified model based on the model ID. All versions of the model can be deleted in cascading mode.

Service Management APIs

Table 21 Service management APIs

API	Description
Deploying a Service	Deploy a model service.
Obtaining Services	Obtain model services.
Obtaining Service Details	Obtain details about a model service based on the service ID.
Updating Service Configurations	Update a model service.
Obtaining Service Monitoring	Obtain service monitoring information.
Obtaining Service Update Logs	Obtain the update logs of a real-time service.
Obtaining Service Event Logs	Obtain service event logs, including service operation records, key actions during deployment, and deployment failure causes.
Deleting a Service	Delete a model service.
Obtaining Supported Service Deployment Specifications	Obtain supported service deployment specifications.
Obtaining Dedicated Resource Pools	Obtain dedicated resource pools.

Resource Management APIs

Table 22 Configuration management APIs

API	Description
Obtaining OS Configuration Parameters	Obtain the configuration parameters of the ModelArts OS service, such as the CIDR block and user resource quota.

Table 23 Configuration management APIs

API	Description
Obtaining OS Quotas	Obtain the quotas of some ModelArts OS resources, such as the quotas for resource pool quotas and networks.

Table 24 Plug-in template management APIs

API	Description
Obtaining a Plug-in Template	Obtain details of a specified plug-in template.

Table 25 Node management APIs

API	Description
Obtaining Nodes	Obtain the nodes in a resource pool.
Deleting Nodes in Batches	Delete nodes from a specific resource pool in batches. At least one node must be reserved in the resource pool.

Table 26 Event management APIs

API	Description
Obtaining Events	Obtain events.

Table 27 Network management APIs

API	Description
Creating Network Resources	Create network resources.
Obtaining Network Resources	Obtain a list of network resources.
Obtaining a Network Resource	Obtain details about a specified network resource.
Deleting a Network Resource	Delete a specified network resource.
Updating a Network Resource	Update a specified network resource.

Table 28 Resource metric management APIs

API	Description
Obtaining the Real-Time Resource Usage	Obtain the real-time usage of all resource pools in the current project.

Table 29 Resource pool management APIs

API	Description
Creating a Resource Pool	Create a resource pool.
Obtaining Resource Pools	Obtain resource pools.
Obtaining a Resource Pool	Obtain details about a specified resource pool.
Deleting a Resource Pool	Delete a specified resource pool.
Updating a Resource Pool	Update a specified resource pool.
Monitoring a Resource Pool	Obtain the monitoring information of a resource pool.
Collecting Resource Pool Statistics	Obtain the statistics of a resource pool.

Table 30 Resource flavor management APIs

API	Description
Obtaining Resource Flavors	Obtain resource flavors.

Table 31 APIs for managing resource pool jobs

API	Description
Obtaining Dedicated Resource Pool Jobs	Obtain dedicated resource pool jobs.
Obtaining Statistics for Dedicated Resource Pool Jobs	Obtain statistics for dedicated resource pool jobs.

Authorization Management APIs

Table 32 Authorization management APIs

API	Description
Viewing an Authorization List	View an authorization list.
Configuring Authorization	Configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned.
Deleting Authorization	Delete the authorization of a specified user or all users.
Creating a ModelArts Agency	Create a ModelArts agency for dependent services such as OBS, SWR, and IEF.

last updated: 2024-07-27 00:05