# API Overview

All ModelArts APIs are proprietary.

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

#### 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
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 Training management APIs
Type | API | Description
--- | --- | ---
Training Jobs | Creating a Training Job | Create a training job.
Querying a Training Job List | Query the created training jobs that meet the search criteria.
Querying the Details About a Training Job Version | Query the details about a specified training job based on the job ID.
Deleting a Version of a Training Job | Delete a version of a training job.
Querying a List of Training Job Versions | Query the version of a specified training job based on the job ID.
Creating a Version of a Training Job | Create a version of a training job.
Stopping a Training Job | Stop 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.
Obtaining the Name of a Training Job Log File | Obtain the name of a training job log file.
Querying a Built-in Algorithm | Query the details about a built-in model.
Querying Training Job Logs | Query detailed information about training job logs by row.
Training Job Parameter Configuration | Creating a Training Job Configuration | Create a training job configuration.
Querying a List of Training Job Configurations | Query the created training job configurations that meet the search criteria.
Modifying a Training Job Configuration | Modify a training job configuration.
Deleting a Training Job Configuration | Delete a training job configuration.
Querying the Details About a Training Job Configuration | Query the details about a specified training job configuration.
Visualization Job Management | Creating a Visualization Job | Create a visualization job.
Querying a Visualization Job List | Query the visualization jobs that meet the search criteria.
Querying the Details About a Visualization Job | Query the details about a specified visualization job based on the job name.
Modifying the Description of a Visualization Job | Modify the description of a visualization job.
Deleting a Visualization Job | Delete a visualization job.
Stopping a Visualization Job | Stop a visualization job.
Restarting a Visualization Job | Restart a visualization job.
Resource and Engine Specifications | Querying Job Resource Specifications | Query the resource specifications of a specified job.
Querying Job Engine Specifications | Query the engine type and version of a specified job.
Job Statuses | Job Statuses | View job statuses and status description.

#### Model Management APIs

Table 3 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 4 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.
Querying Dedicated Resource Pools | Query dedicated resource pools.

#### Authorization Management APIs

Table 5 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.