API overview
Updated at:
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (AIWorkSpace/2021-02-04) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Experiment
|
API |
Title |
Description |
| CreateExperiment | CreateExperiment | Creates an experiment. |
| UpdateExperiment | UpdateExperiment | Updates an experiment. |
| GetExperiment | GetExperiment | Retrieves an experiment. |
| ListExperiment | ListExperiment | Retrieves a list of experiments. |
| DeleteExperiment | DeleteExperiment | Deletes an experiment. |
| SetExperimentLabels | SetExperimentLabels | Updates the labels of an experiment. |
| DeleteExperimentLabel | DeleteExperimentLabel | Deletes a label from an experiment. |
| CreateRun | CreateRun | Creates a run for an experiment. The run can be associated with a specific workload or be a standalone code execution. |
| UpdateRun | UpdateRun | Updates the details of a run. |
| GetRun | GetRun | Retrieves run details. |
| ListRuns | ListRuns | Retrieves a list of runs. |
| DeleteRun | DeleteRun | Deletes a run. |
| DeleteRunLabel | DeleteRunLabel | Deletes a label from a run. |
| LogRunMetrics | LogRunMetrics | Records the metrics of a run in a batch. |
| ListRunMetrics | ListRunMetrics | Retrieves a list of metric records for a run. |
Image
|
API |
Title |
Description |
| AddImage | AddImage | Adds a custom image to a workspace. |
| AddImageLabels | AddImageLabels | Adds labels to a specified image. |
| GetImage | GetImage | Retrieves the details of an image. |
| ListImageLabels | ListImageLabels | Queries a list of image labels. |
| ListImages | ListImages | Queries a list of images. |
| RemoveImage | RemoveImage | Deletes an image. |
| PublishImage | PublishImage | Publishes an image and changes its visibility from PRIVATE to PUBLIC. |
| RemoveImageLabels | RemoveImageLabels | Removes a label from an image. |
| CreateImageBuild | CreateImageBuild | Builds a custom image based on the specified configuration. After the image is successfully built, it is added to the list of custom images in the current workspace. |
Workspace
|
API |
Title |
Description |
| Permissions | Permissions | |
| ListPermissions | ListPermissions | Retrieves a list of user permissions in a workspace. |
| GetPermission | GetPermission | Retrieves the permissions of a workspace. |
| Resources | Resources | |
| DeleteWorkspaceResource | DeleteWorkspaceResource | Deletes a resource reference from a workspace. This operation does not delete the underlying resource. |
| UpdateWorkspaceResource | UpdateWorkspaceResource | Updates the resources of a workspace. |
| ListResources | ListResources | Lists resources associated with a workspace. |
| CreateWorkspaceResource | CreateWorkspaceResource | Adds a resource reference to a workspace. |
| Members | Members | |
| AddMemberRole | AddMemberRole | Assigns a role to a member in a workspace, granting that member the role's permissions. |
| RemoveMemberRole | RemoveMemberRole | Removes a role from a member. |
| DeleteMembers | DeleteMembers | Deletes members from a workspace. |
| GetMember | GetMember | Retrieves a member of a workspace. |
| ListMembers | ListMembers | Lists members in a workspace. |
| CreateMember | CreateMember | Adds one or more users to a workspace. |
| Configuration | Configuration | |
| UpdateConfigs | UpdateConfigs | Updates or creates workspace configurations in batches. |
| GetConfig | GetConfig | Retrieves the configurations of a workspace. |
| ListConfigs | ListConfigs | Lists the configurations for a workspace. |
| DeleteConfig | DeleteConfig | Deletes a workspace configuration. |
| UpdateConfig | UpdateConfig | Updates or creates workspace configurations. |
| Work space | Work space | |
| ListWorkspaces | ListWorkspaces | Lists the workspaces in a region. |
| CreateWorkspace | CreateWorkspace | Creates a workspace. |
| GetWorkspace | GetWorkspace | Retrieves the details of a workspace. |
| DeleteWorkspace | DeleteWorkspace | Deletes a workspace. This operation does not release associated resources. You must release them manually. |
| UpdateWorkspace | UpdateWorkspace | Updates the name and description of a workspace. |
| GetDefaultWorkspace | GetDefaultWorkspace | Retrieves the details of the default workspace. |
| UpdateDefaultWorkspace | UpdateDefaultWorkspace | Sets a workspace as the default. |
| ListWorkspaceUsers | ListWorkspaceUsers | Lists users that can be added as members to a workspace. |
| ListQuotas | ListQuotas | Retrieves a list of resource quotas. |
Dataset
|
API |
Title |
Description |
| Multimodal retrieval | Multimodal retrieval | |
| GetDatasetFileMetasStatistics | GetDatasetFileMetasStatistics | Retrieves statistics for metadata in a dataset. |
| StopDatasetJob | StopDatasetJob | Stops a dataset Job. |
| GetDatasetJob | GetDatasetJob | Retrieves a dataset job. |
| CreateDatasetFileMetas | CreateDatasetFileMetas | Creates file metadata records for a dataset in a batch. |
| UpdateDatasetJob | UpdateDatasetJob | Updates a dataset job. |
| ListDatasetJobs | ListDatasetJobs | Lists dataset jobs. |
| DeleteDatasetJobConfig | DeleteDatasetJobConfig | Deletes a dataset job configuration. |
| DeleteDatasetJob | DeleteDatasetJob | Deletes a dataset Job. |
| UpdateDatasetJobConfig | UpdateDatasetJobConfig | Updates a dataset job configuration. |
| UpdateDatasetFileMetas | UpdateDatasetFileMetas | Updates multiple file metadata records in a dataset. |
| ListDatasetJobConfigs | ListDatasetJobConfigs | Lists dataset job configurations in batches. |
| ListDatasetFileMetas | ListDatasetFileMetas | Queries the files in a dataset. |
| GetDatasetJobConfig | GetDatasetJobConfig | Retrieves the configuration of a dataset job. |
| GetDatasetFileMeta | GetDatasetFileMeta | Retrieves the metadata record of a specified file in a dataset. |
| DeleteDatasetFileMetas | DeleteDatasetFileMetas | Deletes file metadata records from a dataset in batches. |
| CreateDatasetJobConfig | CreateDatasetJobConfig | Creates a dataset Job configuration. |
| CreateDatasetJob | CreateDatasetJob | Creates a dataset job. |
| CreateDataset | CreateDataset | Creates a dataset. |
| GetDataset | GetDataset | Retrieves a dataset. |
| UpdateDataset | UpdateDataset | Updates the properties of a dataset, such as its name and description. |
| PublishDataset | PublishDataset | Publishes a private dataset in a workspace. |
| ListDatasets | ListDatasets | Lists the datasets in a workspace. |
| DeleteDataset | DeleteDataset | Deletes a dataset. |
| CreateDatasetLabels | CreateDatasetLabels | Adds labels to a dataset. |
| DeleteDatasetLabels | DeleteDatasetLabels | Deletes labels from a dataset. |
| CreateDatasetVersion | CreateDatasetVersion | Creates a dataset version. |
| GetDatasetVersion | GetDatasetVersion | Retrieves information about a specific dataset version. |
| ListDatasetVersions | ListDatasetVersions | Retrieves a list of dataset versions. |
| UpdateDatasetVersion | UpdateDatasetVersion | Updates the information for a specific version of a dataset. |
| DeleteDatasetVersion | DeleteDatasetVersion | Deletes a specified version of a dataset. This operation cannot be used to delete version v1. Version v1 is deleted with the dataset when you call the DeleteDataset operation. |
| DeleteDatasetVersionLabels | DeleteDatasetVersionLabels | Deletes labels from a dataset version. |
| CreateDatasetVersionLabels | CreateDatasetVersionLabels | Creates labels for a dataset version. |
Connection
|
API |
Title |
Description |
| CreateConnection | CreateConnection | Creates a connection to link PAI cloud services with your models, databases, and other services. This is useful for scenarios such as LangStudio and multimodal dataset retrieval. |
| GetConnection | GetConnection | Retrieves the details of a connection. |
| UpdateConnection | UpdateConnection | Updates a connection configuration. |
| ListConnections | ListConnections | Queries a list of connections. |
| DeleteConnection | DeleteConnection | Deletes a connection. |
| ValidateConnection | ValidateConnection | Validates a connection. |
Code Configuration
|
API |
Title |
Description |
| CreateCodeSource | CreateCodeSource | Creates a code configuration in PAI using a code branch and commit ID from a Git repository. This configuration can then be referenced in DLC jobs. |
| DeleteCodeSource | DeleteCodeSource | Deletes a code source configuration by its ID. |
| PublishCodeSource | PublishCodeSource | Publishes a private code source, making it public in a workspace. |
| UpdateCodeSource | UpdateCodeSource | Updates a code source. |
| GetCodeSource | GetCodeSource | Gets the details of a specified code source configuration. |
| ListCodeSources | ListCodeSources | Queries a list of code source configurations with support for paging, sorting, and filtering. |
Model
|
API |
Title |
Description |
| CreateModel | CreateModel | Creates a model, which is a collection of model versions. You must specify information such as the model name and description. |
| UpdateModel | UpdateModel | Updates the basic configuration of a model. |
| GetModel | GetModel | Gets the details of a specified model. |
| ListModels | ListModels | Retrieves a list of models. |
| DeleteModel | DeleteModel | Deletes a model. |
| CreateModelVersion | CreateModelVersion | Adds a new version to a specified model. |
| UpdateModelVersion | UpdateModelVersion | Updates a model version. |
| GetModelVersion | GetModelVersion | Retrieves a model version. |
| ListModelVersions | ListModelVersions | Retrieves a list of model versions. |
| DeleteModelVersion | DeleteModelVersion | Deletes a model version. |
| CreateModelLabels | CreateModelLabels | Creates labels for a model. |
| DeleteModelLabels | DeleteModelLabels | Deletes model labels. |
| CreateModelVersionLabels | CreateModelVersionLabels | Creates labels for a model version. |
| DeleteModelVersionLabels | DeleteModelVersionLabels | Deletes labels from a model version. |
User Configuration
|
API |
Title |
Description |
| SetUserConfigs | SetUserConfigs | Updates user configurations. |
| DeleteUserConfig | DeleteUserConfig | Deletes a user configuration. |
| ListUserConfigs | ListUserConfigs | Retrieves user configurations. |
Other
|
API |
Title |
Description |
| ListProducts | ListProducts | Lists products. |
| CreateProductOrders | CreateProductOrders | Purchases products. This operation supports pay-as-you-go purchases of DataWorks, OSS, PAI, and MaxCompute. |
| AcceptDataworksEvent | AcceptDataworksEvent | PAI accepts and processes system event messages from DataWorks. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of a specified resource. |
| ListFeatures | ListFeatures | Retrieves a list of features. |
Others
|
API |
Title |
Description |
| DeleteWorkspaceRoles | DeleteWorkspaceRoles | Deletes one or more roles from a specified workspace. |
Is this page helpful?