API Overview

All ModelArts APIs are proprietary.

Data Management APIs

Data management APIs include the APIs for managing datasets, dataset versions, samples, and labels. Use these APIs to create datasets and label data. For details, see Data Management APIs.

DevEnviron APIs

**Table 1** DevEnviron APIs (old version)
API	Description
Creating a Development Environment Instance	Create a development environment instance for code development.
Querying a List of Development Environment Instances	Query the development environment instances that meet the search criteria.
Querying Details About a Development Environment Instance	Query the details about a development environment 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 2** Algorithm management APIs
API	Description
Creating an Algorithm	Create an algorithm.
Querying the Algorithm List	Query the algorithm list.
Querying Algorithm Details	Query a specified algorithm based on the algorithm ID.
Modifying an Algorithm	Modify an algorithm.
Deleting an Algorithm	Delete an algorithm.
Querying the Hyperparameter Search Algorithm List	Query the hyperparameter search algorithm list.

**Table 3** APIs for managing training jobs
API	Description
Creating a Training Job	Create a training job.
Querying Details About a Training Job	Query 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.
Querying the Logs of a Specified Task in a Training Job (Preview)	Query the logs of a specified task in a training job (preview).
Querying the Logs of a Specified Task in a Training Job (OBS Link)	Query the logs of a specified task in a training job (OBS link). You can view all logs or download the logs.
Querying the Runtime Metrics of a Specified Task in a Training Job	Query the runtime metrics of a specified task in a training job.
Querying a Training Job List	Query the created training jobs by search criteria.
Querying All Trial Results in a Hyperparameter Search	Query all trial results in a hyperparameter search.
Querying a Trial Result in a Hyperparameter Search	Query the search result of a specified trial based on the input trial ID.
Obtaining Hyperparameter Sensitivity Analysis Results	Obtain hyperparameter sensitivity analysis results.
Obtaining the Path to a Hyperparameter Sensitivity Analysis Image	Obtain the path for storing a hyperparameter sensitivity analysis image.
Terminating a Trial of an In-progress Auto Search Job	Terminate a trial of an in-progress auto search job.
Obtaining the YAML Template of an Auto Search Job	Obtain the YAML template of an auto search job.
Obtaining the YAML Template Content of an Auto Search Job	Obtain the YAML template content of an auto search job.

**Table 4** APIs for resources and engine specifications
API	Description
Querying the List of General Specifications Supported by a Training Job	Query the list of general specifications supported by a training job.
Querying the List of AI Engines Supported by a Training Job	Query the list of AI engines supported by a training job.

Model Management APIs

**Table 5** Model management APIs
API	Description
Importing a Model	Import a model.
Querying a Model List	Query the models that meet the search criteria.
Querying the Details About a Model	Query 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 6** Service management APIs
API	Description
Deploying a Model as a Service	Deploy a model service.
Querying a Service List	Query model services.
Querying the Details About a Service	Query the details about a model service based on the service ID.
Updating Service Configurations	Update a model service.
Querying Service Monitoring Information	Query service monitoring information.
Querying Service Update Logs	Query the update logs of a real-time service.
Querying Service Event Logs	Query service event logs, including service operation records, key actions during deployment, and deployment failure causes.
Deleting a Service	Delete a model service.
Querying Supported Service Deployment Specifications	Query supported service deployment specifications.

Authorization Management APIs

**Table 7** Workspace 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.