# Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace API

> Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace API on Apizie: 128 endpoints (PAI accepts and processes system event messages from DataWorks, Adds a custom image to a workspace, Adds labels to a specified image, Assigns a role to a member in a workspace, granting that member the role's permissions, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-aiworkspace`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/aiworkspace
- Page: https://zieapi.vercel.app/api/cloud/aliyun-aiworkspace
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-aiworkspace/openapi.json

Alibaba Cloud OpenAPI for Platform for Artificial Intelligence PAI - AIWorkspace (aiworkspace, version 2021-02-04). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### PAI accepts and processes system event messages from DataWorks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/accept-dataworks-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Data | object | no | The event content of the message |
| MessageId | string | no | The ID of the DataWorks open message. After an extension point event is triggered, the message ID is available in the received event… |

### Adds a custom image to a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/add-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the image. Valid values: PUBLIC: All members in the current workspace can manage the image. PRIVATE: Only the creator… |
| Description | string | no | The description of the image |
| ImageId | string | no | The ID of the image. If you do not specify this parameter, the system automatically generates an image ID. The format is image- followed… |
| ImageUri | string | yes | The URI of the image. The URI can be duplicated. For more information about how to view the image URI, see… |
| Labels | array | no | The labels of the image. This parameter is an array, and each item in the array contains the key and value fields. Official images have… |
| Name | string | yes | The name of the image. The naming rules are as follows: The name must be 1 to 50 characters in length. The name can contain lowercase… |
| Size | integer | no | The size of the image. Unit: GB |
| SourceId | string | no | The source ID of the image. If the source type of the image is Build, the source ID is the image build ID |
| SourceType | string | no | The source type of the image. Valid values: Import: The image is imported. Build: The image is built |
| UserId | string | no | The user ID (UID) of the image creator |
| WorkspaceId | string | no | The ID of the workspace to which the image belongs. For more information about how to obtain the workspace ID, see… |

### Adds labels to a specified image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/add-image-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The ID of the image. For more information, see https://help.aliyun.com/document_detail/449118.html |
| Labels | array | yes | A list of image labels |

### Assigns a role to a member in a workspace, granting that member the role's permissions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/add-member-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace. To obtain this ID, see https://help.aliyun.com/document_detail/449124.html |
| MemberId | string | yes | The ID of the member. To obtain this ID, see https://help.aliyun.com/document_detail/449135.html |
| RoleName | string | yes | The role to assign. You can specify a built-in role or a custom role. Built-in role: You can specify one of the following built-in roles.… |

### Changes the resource group of a specified resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| NewResourceGroupId | string | no | The ID of the new resource group. For more information about how to obtain a resource group ID, see… |
| ResourceId | string | no | The resource ID. This ID is the same as the workspace ID. For more information about how to obtain a workspace ID, see… |
| ResourceType | string | no | The type of the resource. You must set this parameter to workspace |

### Creates a code configuration in PAI. You can configure a Git code branch and CommitId. After the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-code-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the code configuration |
| CloneType | integer | no | The clone mode. Valid values: 0 (default): creates a new subdirectory. 1: tiles to the current directory |
| CodeBranch | string | no | The code branch |
| CodeCommit | string | no | The CommitID of the code. CodeCommit takes priority over CodeBranch. If you specify CodeCommit, CodeBranch does not take effect |
| CodeRepo | string | no | The URL of the code repository. This parameter is required |
| CodeRepoAccessToken | string | no | The access token of the code repository |
| CodeRepoUserName | string | no | The username of the code repository |
| Description | string | no | The description of the code configuration, which helps distinguish different code configurations |
| DisplayName | string | yes | The name of the code configuration |
| MountPath | string | no | The local mount directory for the code. This parameter is required |
| WorkspaceId | string | yes | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Creates a connection to link PAI cloud services with your models, databases, and other services. This is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the workspace. The default value is `PRIVATE` |
| Configs | object | yes | Configuration properties for the connection, provided as key-value pairs. The required keys depend on the connection type. For details,… |
| ConnectionName | string | yes | The name of the connection |
| ConnectionType | string | no | The type of the connection |
| Description | string | no | The description of the connection |
| Models | array | no | A list of models. This parameter applies to model service connections |
| ResourceMeta | object | no | Resource metadata for the connection. This parameter is typically used for database connection types |
| Secrets | object | no | Sensitive connection properties that require encryption, such as database credentials or an API key for a model service |
| WorkspaceId | string | no | The ID of the workspace. To get this ID, call the https://help.aliyun.com/document_detail/449124.html operation |

### Creates a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The workspace visibility. Valid values: PRIVATE: Visible only to the creator and administrators in the workspace. This is the default… |
| AccessibleRoleIdList | array | no | Takes effect only when Accessibility is set to ROLE_PUBLIC. The list of workspace role names that have visibility to the dataset. Role IDs… |
| DataCount | integer | no | The number of files in the dataset |
| DataSize | integer | no | The storage space occupied by the dataset files. Unit: bytes |
| DataSourceType | string | yes | The data source type. Valid values: OSS: Alibaba Cloud Object Storage Service (OSS). NAS: Alibaba Cloud File Storage NAS… |
| DataType | string | no | The data type of the dataset. Default value: COMMON. Valid values: COMMON: Common data. PIC: Image data. TEXT: Text data. VIDEO: Video… |
| DatasetTaskRamRole | string | no | DatasetTaskRamRole |
| Description | string | no | The custom description of the dataset, which is used to distinguish it from other datasets |
| DryRun | string | no | Specifies whether to perform only a dry run without actually creating the dataset |
| Edition | string | no | The dataset edition. Default value: BASIC. Valid values: BASIC: Basic edition. Does not support file metadata management for the dataset.… |
| ImportInfo | string | no | The storage import configuration of the dataset. OSS, NAS, and CPFS are supported. OSS { "region": "${region}",// The region ID. "bucket":… |
| Labels | array | no | The list of labels |
| MountAccessReadWriteRoleIdList | array | no | The list of workspace role names that have read and write permissions when the dataset is mounted. Role IDs starting with PAI are basic… |
| Name | string | yes | The name of the dataset. The naming rules are as follows: The name must start with a lowercase letter, an uppercase letter, a digit, or a… |
| Options | string | no | The extended fields in JSON string format. When DLC uses the dataset, you can configure the mountPath field to specify the default mount… |
| Property | string | yes | The property of the dataset. Valid values: FILE: File. DIRECTORY: Directory |
| Provider | string | no | The provider of the dataset. You cannot set this parameter to pai |
| ProviderType | string | no | The data source type of the dataset. Valid values: Ecs: Elastic Compute Service (ECS). This is the default value. Lingjun: Lingjun |
| SourceDatasetId | string | no | The ID of the source dataset from which the labeled dataset is generated |
| SourceDatasetVersion | string | no | The version of the source dataset from which the labeled dataset is generated |
| SourceId | string | no | The ID of the data source. When SourceType is set to USER, SourceId can be customized. When SourceType is set to ITAG, which indicates… |
| SourceType | string | no | The data source type. Default value: USER |
| Uri | string | yes | The URI configuration examples are as follows: If the data source type is OSS: `oss://bucket.endpoint/object` If the data source type is… |
| UserId | string | no | The Alibaba Cloud account ID of the dataset owner. The workspace owner and administrators have the permissions to create datasets for… |
| UserMetricsEndpoints | array | no | UserMetricsEndpoints |
| VersionDescription | string | no | The description of the initial version of the dataset |
| VersionLabels | array | no | The list of labels for the initial version |
| WorkspaceId | string | no | The ID of the workspace to which the dataset belongs. For more information about how to obtain the workspace ID, see… |

### Creates file metadata records in a dataset in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset-file-metas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetFileMetas | array | yes | The list of file metadata entries |
| DatasetVersion | string | yes | The dataset version name |
| WorkspaceId | string | yes | The ID of the workspace where the dataset resides. For information about how to obtain the workspace ID, see… |

### Creates a dataset job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetVersion | string | no | The name of the dataset version |
| Description | string | no | The description |
| JobAction | string | yes | The task operation. SemanticIndex: semantic index IntelligentTag: intelligent tagging FileMetaExport: metadata export FileMetaBuild: build… |
| JobMode | string | no | The task type. Full (default): forces the processing of all metadata. This task takes a long time to execute. Increment: processes only… |
| JobSpec | string | yes | The task details |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Creates a dataset Job configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID |
| Config | string | yes | The configuration content. The format is as follows: MultimodalIntelligentTag { "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }… |
| ConfigType | string | yes | The configuration type |
| DatasetVersion | string | no | The name of the dataset version |
| WorkspaceId | string | yes | The workspace ID |

### Adds labels to a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain a dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| Labels | array | no | The list of labels |

### Creates a dataset version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DataCount | integer | no | The number of files in the dataset |
| DataSize | integer | no | The size of the space occupied by the dataset files. Unit: bytes |
| DataSourceType | string | yes | The data source type. Separate multiple values with commas. Valid values: NAS: Alibaba Cloud File Storage NAS. OSS: Alibaba Cloud Object… |
| DatasetTaskRamRole | string | no | UserMetricsEndpoints |
| Description | string | no | The custom description of the dataset version. You can use this description to distinguish between different dataset versions |
| DryRun | string | no | Specifies whether to perform only a dry run without actually creating the dataset version |
| ImportInfo | string | no | The storage import configuration of the dataset. OSS, NAS, and CPFS are supported. OSS { "region": "${region}",// The region ID. "bucket":… |
| Labels | array | no | The list of labels for the dataset version |
| Options | string | no | The extended field. The value is a JSON string. When DLC uses the dataset, you can configure the mountPath field to specify the default… |
| Property | string | yes | The property of the dataset. Valid values: FILE: file DIRECTORY: directory |
| SourceId | string | no | The source ID. If SourceType is set to USER, you can specify a custom SourceId. If SourceType is set to ITAG, the dataset is generated… |
| SourceType | string | no | The source type. Default value: USER. Valid values: PAI-PUBLIC-DATASET: PAI public dataset. ITAG: dataset generated from the labeling… |
| Uri | string | yes | The URI. Configuration examples: If the data source type is OSS: `oss://bucket.endpoint/object` If the data source type is NAS: For… |
| UserMetricsEndpoints | array | no | The list of user metric collection endpoints |

### Creates labels for a dataset version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-dataset-version-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information, see https://help.aliyun.com/document_detail/457222.html |
| VersionName | string | yes | The name of the dataset version |
| Labels | array | yes | The list of labels |

### Creates an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the experiment. Valid values: PUBLIC: Visible to all users. PRIVATE: Visible only to the creator and the Alibaba Cloud… |
| ArtifactUri | string | no | The default artifact output path for all tasks associated with the experiment. Currently, only OSS paths are supported |
| Labels | array | no | The labels |
| Name | string | yes | The name of the experiment. The name must meet the following rules: The name must start with a lowercase or uppercase letter. The name can… |
| WorkspaceId | string | yes | The workspace ID |

### Builds a custom image based on the specified configuration. After the image is successfully built, it is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-image-build` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | An idempotence token |
| Accessibility | string | no | The visibility of the image. PUBLIC: The image is public. PRIVATE: The image is private |
| BuildConfig | object | yes | The build configuration. Specify the content of the Dockerfile to be built |
| Image | object | yes | The metadata of the image |
| ImageBuildJobName | string | no | The name of the image build task |
| OverwriteImageTag | string | no | Specifies whether to overwrite an existing image version in the image repository |
| RegionId | string | no | The region ID |
| Resource | object | yes | The resources used to run the task |
| TargetRegistry | object | yes | The configuration of the target image repository |
| UserVpc | object | no | The information about the user's virtual private cloud (VPC). This parameter is required when you use the public resource group |
| WorkspaceId | string | yes | The workspace ID |

### Adds one or more users to a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace. For more information, see https://help.aliyun.com/document_detail/449124.html |
| Members | array | yes | The list of members |

### Creates a model, which is a collection of model versions. You must specify information such as the model…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the model in the workspace. Valid values: PRIVATE (default): The model is visible only to you and administrators in the… |
| Domain | string | no | The domain. This describes the field that the model is designed for, such as nlp (Natural Language Processing) or cv (computer vision) |
| ExtraInfo | object | no | Other information about the model |
| Labels | array | no | A list of labels. This parameter is deprecated and is replaced by the Tag parameter |
| ModelDescription | string | no | The description of the model. Use this to distinguish different models |
| ModelDoc | string | no | The model documentation |
| ModelName | string | yes | The name of the model. The name must be 1 to 127 characters in length |
| ModelType | string | no | The model type, such as Checkpoint or LoRA |
| OrderNumber | integer | no | The ordinal number of the model. You can use this for custom sorting |
| Origin | string | no | The source of the model. This specifies the community or organization that the source model belongs to, such as ModelScope and HuggingFace |
| ParameterSize | integer | no | The number of parameters, in millions |
| Tag | array | no | A list of tags |
| Task | string | no | The task. This describes the specific problem that the model solves, such as text-classification (text classification) |
| WorkspaceId | string | no | The ID of the workspace. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Creates labels for a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-model-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The model ID. For more information, see https://help.aliyun.com/document_detail/461944.html |
| Labels | array | no | The list of labels |

### Adds a new version to a specified model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ApprovalStatus | string | no | The approval status. Valid values: Pending: The version is pending approval. Approved: The version is approved for deployment. Rejected:… |
| CompressionSpec | object | no | The compression configurations |
| DistillationSpec | object | no | The distillation configurations |
| EvaluationSpec | object | no | The evaluation configurations |
| ExtraInfo | object | no | Other information |
| FormatType | string | no | The format of the model. Valid values: OfflineModel SavedModel Keras H5 Frozen Pb Caffe Prototxt TorchScript XGBoost PMML AlinkModel ONNX |
| FrameworkType | string | no | The framework of the model. Valid values: Pytorch XGBoost Keras Caffe Alink Xflow TensorFlow |
| InferenceSpec | object | no | The configurations for downstream inference services, such as the processor and container for Elastic Algorithm Service (EAS). Example: `{… |
| Labels | array | no | The list of labels |
| Metrics | object | no | The model metrics. The serialized data cannot exceed 8,192 bytes in length |
| Options | string | no | The extended fields. This parameter is a JSON string |
| SourceId | string | no | The source ID. If SourceType is set to Custom, this parameter has no format restrictions. If SourceType is PAIFlow or TrainingService, the… |
| SourceType | string | no | The source type of the model. Valid values: Custom (default): The model is custom. PAIFlow: The model is from a PAI pipeline.… |
| TrainingSpec | object | no | The training configurations. These configurations are used for fine-tuning and incremental training |
| Uri | string | yes | The URI of the model version, which is the storage location of the model. The following types of model URIs are supported: An HTTP or… |
| VersionDescription | string | no | The description of the model version |
| VersionName | string | no | The model version. The version must be unique within the model. If you do not specify this parameter, the first version defaults to 0.1.0.… |
| ModelId | string | yes | The model ID. For more information about how to obtain the model ID, see https://help.aliyun.com/document_detail/461944.html |

### Creates labels for a model version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-model-version-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Labels | array | no | A list of labels |
| ModelId | string | yes | The model ID. For more information, see https://help.aliyun.com/document_detail/461944.html |
| VersionName | string | yes | The model version |

### Purchases products. Currently, only pay-as-you-go DataWorks, OSS, PAI, and MaxCompute are supported
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-product-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| AutoPay | string | no | Specifies whether automatic payment is applied to all products specified in the Products parameter. Valid values: true: automatic payment… |
| Products | array | no | The list of products to purchase, separated by commas |

### Creates a prompt
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-prompt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The workspace visibility. Valid values: PRIVATE (default): Visible only to you and administrators in this workspace. PUBLIC: Visible to… |
| Description | string | no | The prompt description |
| FrameworkContent | string | no | The prompt framework content |
| FrameworkType | string | no | The prompt optimization template |
| PromptName | string | yes | The prompt name |
| WorkspaceId | string | yes | The workspace ID. You can obtain the ID by calling the https://help.aliyun.com/document_detail/449124.html operation |

### Creates a run. A run belongs to an experiment and can be associated with a specific workload or can be a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | The experiment ID associated with the run |
| Labels | array | no | The list of labels for the run |
| Name | string | no | The name of the run. Naming rules: Must start with a lowercase or uppercase letter. Can contain uppercase and lowercase letters, digits,… |
| Params | array | no | The list of parameters for the run |
| SourceId | string | no | The PAI workload ID associated with the run |
| SourceType | string | no | The type of PAI workload source associated with the run. Valid values: TrainingService, DLC, or empty. This parameter is optional and… |

### Creates a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Description | string | yes | The description of the workspace. The description cannot exceed 80 characters in length |
| DisplayName | string | no | We recommend that you name the workspace based on its business attribute to facilitate identification of its purpose. If you do not… |
| EnvTypes | array | yes | The environments included in the workspace: The simple mode contains only the production environment (prod). The standard mode contains… |
| ResourceGroupId | string | no | The resource group ID. For information about how to obtain the resource group ID, see https://help.aliyun.com/document_detail/151181.html |
| WorkspaceName | string | yes | The name of the workspace. The format is as follows: The length is 3 to 23 characters and can contain letters, underscores (_), or digits.… |

### Add a resource reference to a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-workspace-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace. To obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| Option | string | no | The creation behavior. Valid values: `CreateAndAttach`: Creates a resource and attaches it to the workspace. `Attach`: Attaches an… |
| Resources | array | yes | The list of resources |

### Adds a role to a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/create-workspace-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. You can call https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID |
| ModulePermissions | array | no | (Required) The role permission configurations |
| RoleName | string | no | (Required) The custom role name. The name must be unique within the same workspace. The name can contain letters, digits, underscores (_),… |
| RoleType | string | no | The role type. Valid values: custom: custom role. Only custom roles are supported. This is the default value |
| UserId | string | no | The user ID |

### Deletes a code source configuration by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-code-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| CodeSourceId | string | yes | The ID of the code source configuration to delete. For more information, see https://help.aliyun.com/document_detail/459922.html |

### Deletes a workspace configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| ConfigKey | string | yes | The key of the configuration item. The following keys are supported: tempStoragePath: The temporary storage path. This key is valid only… |
| CategoryName | string | no | The classification of the configuration item. The following classifications are supported: DLCAutoRecycle: The DLC automatic release… |
| Labels | string | no | The filter conditions. Separate multiple conditions with commas. The conditions are combined with a logical AND |

### Deletes a connection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ConnectionId | string | yes | The connection ID. For more information, see [ListConnections](url) |

### Deletes a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information, see https://help.aliyun.com/document_detail/457222.html |

### Deletes file metadata records from a dataset in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset-file-metas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information, see https://help.aliyun.com/document_detail/457222.html |
| DatasetVersion | string | no | The name of the dataset version |
| WorkspaceId | string | no | The ID of the workspace where the dataset is located. For more information, see https://help.aliyun.com/document_detail/449124.html |
| DatasetFileMetaIds | string | yes | The ID of the dataset file metadata |

### Deletes a dataset Job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetJobId | string | yes | Dataset task ID |

### Deletes a dataset job configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID |
| DatasetJobConfigId | string | yes | The configuration ID |
| WorkspaceId | string | no | The workspace ID |

### Deletes labels from a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information about how to obtain the ID of a dataset, see https://help.aliyun.com/document_detail/457222.html |
| LabelKeys | string | no | The keys of the labels. For more information about how to query the keys of labels, see… |

### Deletes a specified version of a dataset. This operation cannot be used to delete version v1. Version v1 is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information, see https://help.aliyun.com/document_detail/457222.html |
| VersionName | string | yes | The dataset version. The version must be later than v1. Version v1 is deleted when the dataset is deleted |

### Deletes labels from a dataset version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-dataset-version-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information about how to obtain a dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| VersionName | string | yes | The name of the dataset version |
| Keys | string | yes | The keys of the version labels. Separate multiple keys with commas |

### Deletes an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | The experiment ID |

### Deletes a label from an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-experiment-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | The experiment ID |
| Key | string | yes | The key of the experiment label to delete |

### Deletes members from a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| MemberIds | string | yes | A list of member IDs. Separate multiple member IDs with commas (,). For more information about how to obtain member IDs, see… |

### Deletes a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The ID of the model. For more information, see https://help.aliyun.com/document_detail/461944.html |

### Deletes model labels
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-model-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The ID of the model. For more information, see https://help.aliyun.com/document_detail/461944.html |
| LabelKeys | string | no | The tag keys to delete. Separate multiple tag keys with commas (,) |

### Deletes a model version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The model ID. For more information, see https://help.aliyun.com/document_detail/461944.html |
| VersionName | string | yes | The version of the model |

### Deletes labels from a model version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-model-version-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The ID of the model. For more information about how to obtain the model ID, see https://help.aliyun.com/document_detail/461944.html |
| VersionName | string | yes | The model version |
| LabelKeys | string | no | The keys of the labels that you want to delete. Separate multiple keys with commas (,) |

### Deletes a prompt
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-prompt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| PromptId | string | yes | The unique identifier of the prompt |
| WorkspaceId | string | yes | The workspace ID |

### Deletes a run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| RunId | string | yes | The run ID |

### Deletes a label from a run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-run-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| RunId | string | yes | The ID of the run |
| Key | string | yes | The key of the run label to delete |

### Deletes a user configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-user-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ConfigKey | string | no | The configuration key. Only customizePAIAssumedRole is supported |
| CategoryName | string | yes | The classification. Only DataPrivacyConfig is supported |
| Scope | string | no | The scope. Valid values: subUser and owner |

### Deletes a workspace. This operation does not release associated resources. You must release them manually
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For more information, see https://help.aliyun.com/document_detail/449124.html |

### Detaches a resource from a workspace. This operation does not delete the underlying resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-workspace-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ProductType | string | no | This parameter is deprecated and will be removed. Use the `ResourceType` parameter instead |
| GroupName | string | no | The resource group name. To get the resource group name, see https://help.aliyun.com/document_detail/449143.html |
| WorkspaceId | string | yes | The workspace ID. To get the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| Option | string | no | The deletion behavior. Valid values: `DetachAndDelete` (default): Detaches the resource from the workspace and deletes the resource.… |
| ResourceType | string | no | The resource type. Valid values: `ECS`: general-purpose computing resources `Lingjun`: Lingjun intelligent computing resources `ACS`: ACS… |
| Labels | string | no | A comma-separated list of labels |
| ResourceIds | string | no | A comma-separated list of resource IDs. All specified resources must belong to the same `GroupName`. You must specify a value for at least… |

### Deletes one or more roles from a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/delete-workspace-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace. You can call the https://help.aliyun.com/document_detail/449124.html operation to obtain the workspace ID |
| RoleIds | array | no | The IDs of the roles to delete |

### Retrieves the details of a code source configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-code-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| CodeSourceId | string | yes | The code source configuration ID. To obtain the code source configuration ID, call https://help.aliyun.com/document_detail/459922.html |

### Retrieves the workspace configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| CategoryName | string | no | The category of the configuration item. The following categories are supported: CommonResourceConfig: common resource configuration… |
| ConfigKey | string | no | The key of the configuration item. The following keys are supported: tempStoragePath: the temporary storage path. This key is valid only… |
| Verbose | string | no | The value of the configuration item |

### Retrieves the details of a connection
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ConnectionId | string | yes | The connection ID. For more information about how to obtain a connection ID, see [ListConnections](url) |
| EncryptOption | string | no | The encryption setting. Valid values: PlainText: The value is in plaintext. Secret: The value is in ciphertext |

### Retrieves a dataset
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |

### Retrieves the metadata record of a specified file in a dataset
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-dataset-file-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information, see https://help.aliyun.com/document_detail/457222.html |
| DatasetFileMetaId | string | yes | The ID of the dataset file metadata |
| DatasetVersion | string | no | The name of the dataset version |
| WorkspaceId | string | no | The workspace ID. For more information, see https://help.aliyun.com/document_detail/449124.html |

### Retrieves statistics for metadata in a dataset
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-dataset-file-metas-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain a dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetVersion | string | yes | The name of the dataset version |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| AggregateBy | string | no | The metadata field used for statistical aggregation. The value is not case-sensitive. If you do not specify this parameter, the total… |
| MaxResults | integer | no | The maximum number of results to return for each query that uses the NextToken parameter. Valid values: 1 to 100. Default value: 10 |

### Retrieves a dataset job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-dataset-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetJobId | string | yes | The dataset job ID |
| DatasetVersion | string | no | The dataset version name |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Retrieves the configuration of a dataset task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-dataset-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID |
| DatasetJobConfigId | string | yes | The configuration ID |
| WorkspaceId | string | no | The workspace ID |

### Retrieves the details of a specified dataset version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-dataset-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| VersionName | string | yes | The version name |

### Retrieves the details of the default workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-default-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Verbose | string | no | Specifies whether to return detailed information about the default workspace. The detailed information includes the Conditions list. Valid… |

### Retrieves an experiment
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ExperimentId | string | yes | The experiment ID |
| Verbose | string | no | Specifies whether to retrieve the latest run information for the experiment |

### Retrieves the details of an image
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The image ID. For information about how to obtain the image ID, see https://help.aliyun.com/document_detail/449118.html |
| Verbose | string | no | Specifies whether to display optional information. Optional information currently includes Labels. Valid values: false (default): Optional… |

### Gets the details of a job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-instance-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| InstanceJobId | string | yes | The job ID |

### Retrieves the members of a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| UserId | string | no | The user UID. For information about how to view the user UID, see https://help.aliyun.com/document_detail/449133.html. You must specify… |
| MemberId | string | no | The member UID. You must specify either UserId or MemberId. You cannot specify both at the same time |

### Retrieves the details of a specified model
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The model ID. To obtain the model ID, call https://help.aliyun.com/document_detail/461944.html |

### Retrieves a model version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The model ID. For more information about how to obtain the model ID, see https://help.aliyun.com/document_detail/461944.html |
| VersionName | string | yes | The model version |

### Retrieves the permissions of a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| PermissionCode | string | yes | The name of the permission. The name must be unique within a region. For more information about permissions, see… |
| Accessibility | string | no | The access type. Valid values: PUBLIC: All members of the current workspace can access the instance. PRIVATE: Only the creator can access… |
| Creator | string | no | The Alibaba Cloud account UID of the creator of the workspace permission |
| Resource | string | no | The resource |
| Option | string | no | The optional configurations. Separate multiple configurations with commas (,). Valid values: ResourceEmpty: The resource is empty. If… |
| Labels | string | no | The labels (JSON-encoded) |
| CallerUid | string | no | The CallerUid |
| CallerType | string | no | The CallerType |
| CallerAccessKeyId | string | no | The CallerAccessKeyId |
| CallerSecurityToken | string | no | The CallerSecurityToken |

### Retrieves a prompt
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-prompt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| PromptId | string | yes | The unique identifier of the prompt |
| WorkspaceId | string | yes | The workspace ID. To obtain the workspace ID, refer to https://help.aliyun.com/document_detail/449124.html |

### Retrieves run details
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| RunId | string | yes | The run ID |
| Verbose | string | no | Specifies whether to get information about metrics, parameters, and labels. This parameter is optional. The default value is false |

### Retrieves the details of a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| Verbose | string | no | Specifies whether to return additional information, such as the workspace owner. Valid values: false (default): Does not return additional… |

### Gets information about a specific role within a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/get-workspace-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. You can obtain this ID by calling the https://help.aliyun.com/document_detail/449124.html operation |
| RoleId | string | yes | The custom role ID |

### Queries a list of code configurations. This operation supports pagination, sorting, and conditional filtering
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-code-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DisplayName | string | no | The display name of the code configuration. Fuzzy match is supported |
| PageNumber | integer | no | The page number of the code configuration list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 20 |
| SortBy | string | no | The field used for sorting. Valid values: GmtModifyTime: the time when the code source was last modified. DisplayName: the display name.… |
| Order | string | no | The sort order for the specified field in a paged query. Valid values: ASC (default): ascending order. DESC: descending order |
| WorkspaceId | string | no | The workspace ID. This parameter is required. For information about how to obtain the workspace ID, see… |

### Retrieves the list of workspace configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| CategoryName | string | no | The categorization of the configuration item. Valid values: CommonResourceConfig: general resource configuration DLCAutoRecycle: automatic… |
| ConfigKeys | string | no | The keys of the configuration items. Valid values: tempStoragePath: Temporary storage path. This key is allowed only when CategoryName is… |
| Labels | string | no | The labels used as filter conditions. Separate multiple conditions with commas. These conditions are combined by using the AND operator |
| Verbose | string | no | Specifies whether to display label information. Valid values: true: Displays label information. false: Does not display label information |
| Options | string | no | The additional options. Currently, only ThrowExceptionOnError is supported, which indicates that an error is thrown when an exception occurs |

### Queries a list of connections
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | Workspace ID. You can call https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID |
| NextToken | string | no | The token that marks the starting position for the next page of results |
| MaxResults | integer | no | Maximum number of entries per page |
| SortBy | string | no | Field by which to sort results. Default value: GmtCreateTime. Valid values: GmtCreateTime (default): sorts by creation time |
| Order | string | no | Sort order. Use with the SortBy parameter. Valid values: ASC: ascending order. DESC (default): descending order |
| ConnectionIds | string | no | List of connection IDs to filter by (JSON-encoded) |
| ConnectionName | string | no | Connection name. Supports fuzzy matching |
| ConnectionTypes | string | no | List of connection types to filter by (JSON-encoded) |
| EncryptOption | string | no | Encryption option for sensitive fields in the response. Valid values: PlainText: returns values in plaintext. Secret: returns values in… |
| Model | string | no | Model identifier. Filters connections associated with this model |
| ModelTypes | string | no | List of model types to filter by (JSON-encoded) |
| ToolCall | string | no | Whether tool calling is supported. Valid values: true: supported. false: not supported |
| Creator | string | no | Alibaba Cloud account ID of the creator |
| Accessibility | string | no | Visibility of the connection. Valid values: PUBLIC: visible to all workspace members. PRIVATE: visible only to the creator |

### Queries the list of dataset files
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-dataset-file-metas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetVersion | string | yes | The dataset version name |
| WorkspaceId | string | yes | The workspace ID of the dataset. For information about how to obtain the workspace ID, see… |
| QueryType | string | no | The retrieve type. Valid values: MIX: hybrid retrieve (default). TAG: label-only retrieve. VECTOR: AISearch-only retrieve |
| QueryText | string | no | The text content to search for |
| TopK | integer | no | The maximum number of results to return. Only the top K results are returned. This parameter takes effect only when QueryType is set to… |
| ScoreThreshold | number | no | The similarity score threshold. Only results with a score greater than ScoreThreshold are returned. This parameter takes effect only when… |
| PageSize | integer | no | The number of entries per page. If MaxResults is also specified, MaxResults takes precedence. This parameter will be offline soon. Use… |
| NextToken | string | no | The pagination token. If this parameter is not specified, the first page of data is returned. If a value is returned for this parameter,… |
| SortBy | string | no | The sorting field for paging queries. By default, results are sorted by retrieve relevance in descending order. Other valid values:… |
| Order | string | no | The sorting order for the specified sorting field in paging queries. Used together with SortBy. Default value: DESC. Valid values: ASC:… |
| EndFileUpdateTime | string | no | The start time of the file update time range for the query. The value is a UTC timestamp in ISO 8601 format |
| StartFileUpdateTime | string | no | The end time of the file update time range for the query. The value is a UTC timestamp in ISO 8601 format |
| QueryImage | string | no | The image information for image-to-image search. An OSS URL with public network access is supported. Format:… |
| ThumbnailMode | string | no | The thumbnail mode for images. Currently, only OSS files support thumbnails: Proportional scaling: p_{percentage}, where percentage… |
| DatasetFileMetaIds | string | no | The list of metadata IDs to query (JSON-encoded) |
| QueryTagsIncludeAll | string | no | The search condition for "include all of the following tags". You can select multiple tags, and the query results must match all of them.… |
| QueryTagsIncludeAny | string | no | The search condition for "include any of the following tags". You can select multiple tags, and the query results need to match only one… |
| QueryTagsExclude | string | no | The search condition for "exclude the following tags". You can select multiple tags, and the query results must not contain any of them.… |
| QueryFileName | string | no | The file name search condition. Fuzzy match is supported |
| QueryFileDir | string | no | The file directory search condition. Fuzzy match is supported |
| QueryFileTypeIncludeAny | string | no | The search condition for "include any of the following file types". You can select multiple file types, and the query results need to… |
| QueryContentTypeIncludeAny | string | no | The search condition for "include any of the following content types". You can select multiple content types, and the query results need… |
| StartTagUpdateTime | string | no | The start time of the tag last update time range for the query. The value is a UTC timestamp in ISO 8601 format |
| EndTagUpdateTime | string | no | The end time of the tag last update time range for the query. The value is a UTC timestamp in ISO 8601 format |
| MaxResults | integer | no | The maximum number of results to return per request when using NextToken-based pagination. Valid values: 1 to 100. Default value: 10 |
| QueryExpression | string | no | The query statement (DSL) is a realm-specific language for expressing complex retrieve conditions. It supports grouping, Boolean logic… |
| Status | string | no | The metadata status to query. Valid values: ACTIVE: queries only non-deleted data (default). ALL: queries all data. DELETED: queries only… |
| QueryVideo | string | no | The video file information for video-based search. A video OSS URL with public network access is supported. Format:… |

### Lists dataset job configurations in batches
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-dataset-job-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID |
| WorkspaceId | string | no | The workspace ID |
| ConfigType | string | no | The configuration type. MultimodalIntelligentTag MultimodalSemanticIndex |
| PageNumber | string | no | The page number. The value starts from 1. The default value is 1 |
| PageSize | string | no | The number of entries per page. The default value is 10 |
| DatasetVersion | string | no | The name of the dataset version |

### Retrieves a list of dataset tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-dataset-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset version ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetVersion | string | no | The dataset version name |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| JobAction | string | no | The task action |
| PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The page size |
| Status | string | no | The task status |
| Order | string | no | The sorting order for the specified sorting field in a paged query. Used together with SortBy. Default value: DESC. Valid values: ASC:… |
| SortBy | string | no | The sort field. By default, results are sorted by creation time in descending order |
| WithLogs | string | no | Specifies whether to return task logs |

### Retrieves a list of dataset versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-dataset-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| PageNumber | integer | yes | The page number of the dataset list. Minimum value: 1. Default value: 1 |
| PageSize | integer | yes | The number of entries per page for a paged query. Default value: 10 |
| Order | string | no | The order in which entries are sorted by the specified field in a paged query. Default value: ASC. ASC: ascending order. DESC: descending… |
| LabelKeys | string | no | The dataset label used to filter the dataset list. Datasets whose label key or value contains the specified string are returned |
| LabelValues | string | no | The dataset label used to filter the dataset list. Datasets whose label key or value contains the specified string are returned |
| Properties | string | no | The dataset property. Valid values: DIRECTORY: folder. FILE: file |
| SourceTypes | string | no | The source type. Valid values: PAI-PUBLIC-DATASET: PAI public dataset. ITAG: dataset generated from iTAG labeling results. USER: dataset… |
| SourceId | string | no | The data source ID. If SourceTypes is set to USER, SourceId can be customized. If SourceTypes is set to ITAG, which indicates a dataset… |
| SortBy | string | no | The field by which entries are sorted in a paged query. Default value: GmtCreateTime. Valid values: GmtCreateTime (default): sort by… |

### Retrieves the list of datasets in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number of the dataset list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page settings for paging queries. Default value: 10 |
| Order | string | no | The sorting order for the specified sort field in paging queries. Default value: ASC. ASC: ascending order. DESC: descending order |
| Name | string | no | The dataset name. Fuzzy match is supported based on the dataset name |
| Properties | string | no | The dataset properties. Separate multiple values with commas (,). Valid values: DIRECTORY: folder. FILE: file |
| DataSourceTypes | string | no | The data source types. Separate multiple values with commas (,). Valid values: NAS: Alibaba Cloud Network Attached Storage (NAS). OSS:… |
| DataTypes | string | no | The data types of the dataset. Separate multiple values with commas (,). Valid values: VIDEO: video. COMMON: common. TEXT: text. PIC:… |
| SourceId | string | no | The data source ID. If SourceTypes is set to USER, you can customize the SourceId value. If SourceTypes is set to ITAG, which indicates a… |
| SourceTypes | string | no | The source types. Separate multiple values with commas (,) |
| WorkspaceId | string | no | The ID of the workspace where the dataset resides. For information about how to obtain the workspace ID, see… |
| Label | string | no | The dataset label used to filter the dataset list. Datasets whose label key or value contains the specified string are returned |
| Provider | string | no | The dataset provider. A value of "pai" indicates that the dataset is a PAI platform public dataset |
| SourceDatasetId | string | no | The source dataset ID of the iTAG annotation set |
| SortBy | string | no | The field by which to sort the results |
| ShareScope | string | no | The sharing filter for datasets: TO_ME: returns only datasets shared with you. BY_ME: returns only datasets you shared with others, with… |
| Edition | string | no | The dataset edition. Valid values: BASIC: Basic Edition. Does not support dataset file metadata management. ADVANCED: Advanced Edition.… |
| Accessibility | string | no | The visibility of the dataset. PUBLIC: public. PRIVATE: private |
| DatasetIds | string | no | The dataset IDs. You can specify multiple dataset IDs separated by commas (,) |

### Retrieves a list of experiments
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Name | string | no | The name of the experiment |
| WorkspaceId | string | no | The ID of the workspace where the experiment resides. For more information about how to obtain a workspace ID, see… |
| Labels | string | no | The filter conditions for labels. Separate multiple conditions with commas (,). A single filter condition must be in the `Key=Value` format |
| SortBy | string | no | The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is supported for sorting |
| Order | string | no | The order in which to sort the results of a paged query. Valid values: ASC: ascending order. DESC (default): descending order |
| PageNumber | integer | no | The page number. Pages start from 1 |
| PageSize | integer | no | The number of entries per page |
| OrderBy | string | no | A list of sorting methods as strings. You can sort by the following fields: GmtCreateTime, Name, GmtModifiedTime, or ExperimentId. The… |
| PageToken | integer | no | The paging token. It starts from 0. The default is 0 |
| MaxResults | integer | no | The maximum number of results to return. The default is 10 |
| Verbose | string | no | Specifies whether to retrieve the LatestRun information related to the experiment |
| Options | string | no | Optional parameters (JSON-encoded) |

### Retrieves a list of features
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-features` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Names | string | no | Feature names, separated by commas |

### Queries a list of image labels
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-image-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| LabelKeys | string | no | The list of tag keys. Separate multiple keys with commas (,). System tags start with "system". This parameter works independently of the… |
| LabelFilter | string | no | The filter conditions for labels. Separate multiple conditions with commas. The format for a single condition is `key=value`. This… |
| ImageId | string | no | The image ID. For more information about how to obtain an image ID, see https://help.aliyun.com/document_detail/449118.html |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| Region | string | no | The region where the image resides |

### Retrieves a list of images
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Name | string | no | The image name. Fuzzy match is supported |
| PageNumber | integer | no | The page number of the image list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page for a paged query. Default value: 20 |
| SortBy | string | no | The sort field for a paged query. Currently, the GmtCreateTime field is used for sorting |
| Order | string | no | The sort order for the specified sort field in a paged query. Used together with SortBy. Default value: ASC. ASC: Ascending order. DESC:… |
| Labels | string | no | The label filter conditions. Separate multiple conditions with commas (,). The format of a single filter condition is `Key=Value`. Valid… |
| Verbose | string | no | Specifies whether to display non-essential information. Non-essential information currently includes Labels. Valid values: true: Includes… |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| Query | string | no | Fuzzy searches by image name and description |
| Accessibility | string | no | The visibility of the image. Currently only takes effect for custom images. PUBLIC: Public. PRIVATE: Private |
| ImageUri | string | no | The image URI |
| Options | string | no | The options. Currently supports ExactMatchName for exact match search on Name |

### Lists the members of a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| PageNumber | integer | no | The page number of the workspace list. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Default value: 20 |
| Roles | string | no | Filters members by role. Separate multiple roles with commas (,). Valid values: PAI.AlgoDeveloper: Algorithm developer. PAI.AlgoOperator:… |
| MemberName | string | no | The member name. Fuzzy match is supported |
| UserId | string | no | The ID of the user to query |

### Retrieves a list of model versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-model-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number of the model version list. The value starts from 1. The default value is 1 |
| PageSize | integer | no | The number of entries to return on each page for a paged query. The default value is 10 |
| Order | string | no | The order in which to sort the entries in the paged query. The default value is ASC. ASC: ascending order. DESC: descending order |
| SortBy | string | no | The field to use for sorting in the paged query. Currently, the GmtCreateTime field is used for sorting |
| VersionName | string | no | The model version name. This parameter is used to filter the model version list |
| FormatType | string | no | The model format. This parameter is used to filter the model version list. Valid values: OfflineModel SavedModel Keras H5 Frozen Pb Caffe… |
| FrameworkType | string | no | The model framework. This parameter is used to filter the model version list. Valid values: Pytorch -XGBoost Keras Caffe Alink Xflow… |
| ModelId | string | yes | The model ID. For more information, see https://help.aliyun.com/document_detail/461944.html |
| SourceType | string | no | The source type of the model. This parameter is used to filter the model version list. Valid values: Custom (default): a custom model.… |
| SourceId | string | no | The source ID. If the source type is Custom, this parameter is not restricted. If the source is PAIFlow or TrainingService, the format is… |
| Label | string | no | The label string. This parameter is used to filter the list. Model versions that have the specified string in the key or value of their… |
| ApprovalStatus | string | no | The approval status. This parameter is used to filter the model version list. Valid values: Pending: The model version is pending… |

### Retrieves a list of models
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number of the model list. The value starts from 1. The default value is 1 |
| PageSize | integer | no | The number of models to display on each page in a paged query. The default value is 10 |
| Order | string | no | The order in which to sort the results of a paged query. The default value is ASC. ASC: ascending order. DESC: descending order |
| SortBy | string | no | The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is supported |
| WorkspaceId | string | no | The workspace ID. The returned list contains only the models in the specified workspace. For more information about how to obtain a… |
| ModelName | string | no | The model name. This parameter is used to filter the model list |
| Label | string | no | The label string. This parameter is used to filter the list. Models are returned if their label keys or values contain the specified string |
| Provider | string | no | The provider. If you specify a provider, only the public models from that provider are returned. If you leave this parameter empty, your… |
| Domain | string | no | The domain. This parameter is used to filter the model list by domain. Examples: nlp (natural language processing) and cv (computer vision) |
| Task | string | no | The task. This parameter is used to filter the model list by task type. Example: text-classification |
| Origin | string | no | The model source. This parameter is used to filter the model list by community or organization. Examples: ModelScope and HuggingFace |
| Query | string | no | The query condition. This parameter performs a fuzzy match on ModelName, Domain, Task, LabelKey, and LabelValue. For example, if you enter… |
| ModelType | string | no | The model type |
| Collections | string | no | The collections to which the model belongs. You can specify multiple collections. Separate them with commas (,) |
| Tag | string | no | The list of tags (JSON-encoded) |
| Conditions | string | no | The conditions (JSON-encoded) |

### Retrieves a list of user permissions in a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Lists products
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ProductCodes | string | no | The product codes, separated by commas |
| ServiceCodes | string | no | The service codes, separated by commas |
| Verbose | string | no | The Verbose |

### Retrieves a list of prompts
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-prompts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| PageNumber | string | no | The page number, starting from 1. Default value: 1 |
| PageSize | string | no | The page size. Default value: 20 |
| SortBy | string | no | The field used for sorting. Valid values: Name: the run name. GmtCreateTime (default): the run creation time |
| Order | string | no | The sorting order for the specified field during paging. Default value: ASC. ASC: ascending order. DESC: descending order |
| FrameworkType | string | no | The prompt template framework type |

### Retrieves a list of resource quotas
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-quotas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Name | string | no | The name of the resource quota. Fuzzy search is supported |

### Lists resources associated with a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The ID of the workspace. To get the workspace ID, see https://help.aliyun.com/document_detail/449124.html. This parameter is required if… |
| PageNumber | integer | no | The page number. The value must be greater than or equal to 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| ProductTypes | string | no | Deprecated. This parameter is deprecated. Use the `ResourceType` parameter instead |
| GroupName | string | no | The name of the resource group. To get the resource group name, see https://help.aliyun.com/document_detail/449143.html |
| ResourceName | string | no | The resource name. The name must meet the following requirements: The name must be 3 to 28 characters in length. The name must be unique… |
| Option | string | no | The option to query resources. Valid values: `ListResourceByWorkspace` (Default): lists the resources in a workspace. `ListResource`:… |
| Verbose | string | no | Specifies whether to return detailed information. The detailed information includes the `Quotas` field. Valid values: `true` (Default):… |
| ResourceTypes | string | no | The resource types. Valid values: `MaxCompute`: MaxCompute resources. `ECS`: ECS resources. `Lingjun`: Lingjun computing resources. `ACS`:… |
| QuotaIds | string | no | A comma-separated list of quota IDs. This operation returns only the resources that are associated with all the specified quota IDs. This… |
| Labels | string | no | A comma-separated list of labels. This operation returns only the resources that have all the specified labels. This parameter is… |
| VerboseFields | string | no | A comma-separated list of fields that you want to return. Valid values: `Quota` `Label` `IsDefault` |

### Retrieves a list of metric records for a run
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-run-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| RunId | string | yes | The run ID |
| Key | string | yes | The key of the metric for the run |
| PageToken | integer | no | The paging token. The token starts from 0. The default value is 0 |
| MaxResults | integer | no | The maximum number of results to return. The default value is 10 |

### Retrieves a list of runs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Name | string | no | The run name |
| WorkspaceId | string | no | The ID of the workspace where the experiment resides. For information about how to obtain the workspace ID, see… |
| ExperimentId | string | no | The ID of the experiment to which the run belongs |
| SourceType | string | no | The type of the PAI workload associated with the run |
| SourceId | string | no | The ID of the PAI workload associated with the run |
| Labels | string | no | The labels of the task for exact match. Supported formats: Single-label query: "is_evaluation:true" Multi-label scenario (not recommended… |
| Verbose | string | no | Specifies whether to display detailed information, including Metrics, Params, and Labels. Valid values: true: Detailed information is… |
| GmtCreateTime | string | no | The time when the instance was created. The time follows the ISO 8601 standard in UTC. Format: YYYY-MM-DDTHH:mm:ss.sssZ |
| OrderBy | string | no | A comma-separated list of sorting strings. Supported fields: GmtCreateTime and Name. Supported sorting orders: DESC and ASC. Default: ASC.… |
| PageToken | integer | no | The pagination token. Starts from 0. Default value: 0 |
| MaxResults | integer | no | The maximum number of results to return. Default value: 10 |
| PageNumber | integer | no | The page number. Valid values: greater than 0. Default value: 1 |
| PageSize | integer | no | The number of records per page |
| SortBy | string | no | The field used for sorting. Valid values: Name: The run name. GmtCreateTime (default): The run creation time |
| Order | string | no | The sorting order for the specified field in a paging query. Used together with SortBy. Valid values: ASC: Ascending order. DESC… |

### Retrieves user configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-user-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ConfigKeys | string | no | A collection of configuration keys. Only customizePAIAssumedRole is supported |
| CategoryNames | string | no | The category. Only DataPrivacyConfig is supported |

### Lists the roles in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-workspace-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. Call the https://help.aliyun.com/document_detail/449124.html operation to get it |
| PageNumber | integer | no | The page number. Pages start from 1. The default value is 1 |
| PageSize | integer | no | The number of entries per page. The default value is 20 |
| RoleIds | string | no | A comma-separated list of role IDs |
| RoleName | string | no | The role name |
| RoleType | string | no | The role type. `custom`: A custom role |
| VerboseFields | string | no | A comma-separated list of fields to return. Currently, only `ModulePermissions` is supported, which returns the permission configuration… |
| SortBy | string | no | The sort field for paginated queries. Valid values: `GmtCreateTime` (default): Sorts by creation time. `GmtModifiedTime`: Sorts by… |
| Order | string | no | The sort order for the specified sort field. Valid values: `ASC` (default): Ascending order. `DESC`: Descending order |
| Status | string | no | The status. Valid values: `Creating` `Updating` `Deleting` `Succeeded`: A terminal state. `Failed`: A terminal state |

### Lists users who have not joined a workspace and can be added as workspace members
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-workspace-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| UserName | string | no | The display name of the user who can be added as a workspace member |
| UserId | string | no | The user ID |

### Retrieves the list of workspaces in a region
`GET https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/list-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number of the workspace list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page for a paged query. Default value: 20 |
| SortBy | string | no | The sort field for a paged query. Default value: GmtCreateTime. Valid values: GmtCreateTime (default): sorts by creation time.… |
| Order | string | no | The sort order applied to the specified sort field in a paged query. Valid values: ASC (default): ascending order. DESC: descending order |
| WorkspaceName | string | no | The workspace name |
| ModuleList | string | no | The comma-separated module list. Default value: PAI |
| Status | string | no | The workspace status. Valid values: ENABLED: normal. INITIALIZING: initializing. FAILURE: failed. DISABLED: manually disabled. FROZEN:… |
| Option | string | no | The query options. Valid values: GetWorkspaces (default): retrieves the workspace list and returns Workspaces. GetResourceLimits:… |
| Verbose | string | no | Specifies whether to display workspace details. Valid values: false (default): does not display details. true: displays details |
| Fields | string | no | The list of fields to return in the workspace details. Use this parameter to limit the workspace properties included in the response.… |
| WorkspaceIds | string | no | The list of workspace IDs. Separate multiple workspace IDs with commas (,) |
| ResourceGroupId | string | no | The resource group ID. For information about how to view the resource group ID, see https://help.aliyun.com/document_detail/151181.html |
| UserId | string | no | The user ID |

### Records the metrics of a run in a batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/log-run-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| RunId | string | yes | The ID of the run |
| Metrics | array | no | The list of metrics |

### Publishes a private code source, making it public in a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/publish-code-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| CodeSourceId | string | yes | The ID of the code source to publish. For more information, see https://help.aliyun.com/document_detail/459922.html |

### Publishes a private dataset in a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/publish-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information, see https://help.aliyun.com/document_detail/457222.html |

### Publishes an image and changes its visibility from PRIVATE to PUBLIC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/publish-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The image ID. For more information, see https://help.aliyun.com/document_detail/449118.html |

### Deletes an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/remove-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The ID of the image. To obtain the image ID, see https://help.aliyun.com/document_detail/449118.html |

### Removes a label from an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/remove-image-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The ID of the image. For more information, see https://help.aliyun.com/document_detail/449118.html |
| LabelKey | string | yes | The key of the label |

### Removes a role from a member
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/remove-member-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace. To get this ID, call the https://help.aliyun.com/document_detail/449124.html operation |
| MemberId | string | yes | The ID of the member. To get this ID, see https://help.aliyun.com/document_detail/449135.html |
| RoleName | string | yes | The role to remove. Both official roles and custom roles are supported: Official roles: Valid values include the following. See… |

### Updates the labels of an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/set-experiment-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Labels | array | no | A list of labels |
| ExperimentId | string | yes | The ID of the experiment |

### Updates user configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/set-user-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Configs | array | no | The list of configurations |

### Stops a dataset Job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/stop-dataset-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain a dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetJobId | string | yes | The dataset job ID |
| DatasetVersion | string | no | The name of the dataset version |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Updates a code source configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-code-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| CodeSourceId | string | yes | The ID of the code source configuration. You can obtain the ID by calling the CreateCodeSource, GetCodeSource, or ListCodeSources operation |
| CloneType | integer | no | The clone mode. Valid values: 0 (default): creates a new subdirectory. 1: tiles to the current directory |
| CodeBranch | string | no | The branch name of the code |
| CodeCommit | string | no | The commit ID of the code |
| CodeRepo | string | no | The URL of the code repository |
| CodeRepoAccessToken | string | no | The access token associated with the username |
| CodeRepoUserName | string | no | The username used to access the access code repository |
| Description | string | no | The description of the code source configuration |
| DisplayName | string | no | The name of the code source configuration |
| MountPath | string | no | The default mount path |

### Updates or creates workspace configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace |
| CategoryName | string | no | The classification of the configuration item. The following classifications are supported: CommonResourceConfig: The common resource… |
| ConfigKey | string | no | The key of the configuration item. The following keys are supported: tempStoragePath: The path for temporary storage. This key is valid… |
| ConfigValue | string | no | The value of the configuration item |
| Labels | array | no | The list of labels for the configuration item |

### Updates or creates workspace configurations in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| Configs | array | no | The list of workspace configurations to update or create |

### Updates a connection configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ConnectionId | string | yes | The connection ID. For information about how to obtain a connection ID, see [ListConnections](url) |
| Configs | object | no | The configuration of the connection, specified as key-value pairs. The keys in the Configs parameter vary based on the connection type.… |
| Description | string | no | The description of the connection |
| Models | array | no | A list of model information |
| Secrets | object | no | Key-value pairs that require encryption, such as database logon passwords and keys for model connections |

### Updates the properties of a dataset, such as its name and description
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| Accessibility | string | no | The visibility of the dataset in the workspace. Valid values: `PRIVATE` (default): The dataset is visible only to its owner and… |
| AccessibleRoleIdList | array | no | This parameter takes effect only when `Accessibility` is set to `ROLE_PUBLIC`. It specifies the list of workspace roles that can view the… |
| Description | string | no | The description of the dataset |
| Edition | string | no | The dataset edition. You can upgrade a dataset from `BASIC` to `ADVANCED` |
| MountAccessReadWriteRoleIdList | array | no | A list of workspace roles that have read and write permissions on the mounted dataset. Role IDs that start with `PAI` are basic role IDs,… |
| Name | string | no | The dataset name. For information about how to obtain the dataset name, see https://help.aliyun.com/document_detail/457222.html |
| Options | string | no | An extended field in a JSON string format. When you use the dataset with Data Lake Compute (DLC), you can configure the `mountPath` field… |
| SharingConfig | object | no | The sharing configuration of the dataset |

### Updates multiple file metadata records in a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-dataset-file-metas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset. For more information, see https://help.aliyun.com/document_detail/457222.html |
| DatasetFileMetas | array | yes | A list of dataset file metadata to update |
| DatasetVersion | string | no | The name of the dataset version |
| TagJobId | string | no | The ID of the tagging job for updating metadata tags |
| WorkspaceId | string | no | The ID of the workspace that contains the dataset. For more information, see https://help.aliyun.com/document_detail/449124.html |

### Updates a dataset job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-dataset-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For more information about how to obtain a dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| DatasetJobId | string | yes | The ID of the dataset job |
| DatasetVersion | string | no | The name of the dataset version |
| Description | string | no | The description of the dataset job |
| WorkspaceId | string | no | The ID of the workspace. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Updates a dataset job configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-dataset-job-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset |
| DatasetJobConfigId | string | yes | The ID of the configuration |
| Config | string | no | The configuration content. The format is as follows: MultimodalIntelligentTag { "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }… |
| ConfigType | string | no | The configuration type. MultimodalIntelligentTag MultimodalSemanticIndex |
| WorkspaceId | string | no | The ID of the workspace |

### Updates the information of a specified dataset version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-dataset-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID. For information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html |
| VersionName | string | yes | The dataset version name |
| DataCount | integer | no | The number of dataset files |
| DataSize | integer | no | The size of the space occupied by dataset files. Unit: bytes |
| DatasetTaskRamRole | string | no | DatasetTaskRamRole |
| Description | string | no | The custom description of the dataset, which is used to distinguish different datasets |
| Options | string | no | The extended field in JsonString format. When Deep Learning Containers (DLC) uses the dataset, you can specify the default mount path of… |
| UserMetricsEndpoints | array | no | The list of user metric collection endpoints |

### Sets a workspace as the default
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-default-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The ID of the workspace. For more information, see https://help.aliyun.com/document_detail/449124.html |

### Updates an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the workspace. Valid values: PRIVATE: The experiment is visible only to you and the administrator in the workspace.… |
| Name | string | no | The name of the experiment. The name must meet the following rules: The name must start with a lowercase or uppercase letter. The name can… |
| ExperimentId | string | yes | The experiment ID |

### Updates the basic configuration of a model
`POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/update-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://aiworkspace.ap-southeast-1.aliyuncs.com |
| ModelId | string | yes | The model ID. For more information about how to obtain the model ID, see https://help.aliyun.com/document_detail/461944.html |
| Accessibility | string | no | The visibility of the model in the workspace. Valid values: PRIVATE: The model is visible only to you and administrators in the workspace.… |
| Domain | string | no | The domain of the model. This parameter specifies the field where the model is applied. Examples: nlp (natural language processing) and cv… |
| ExtraInfo | object | no | Other information about the model |
| ModelDescription | string | no | The model description |
| ModelDoc | string | no | The model document |
| ModelName | string | no | The name of the model. The name must be 1 to 127 characters in length |
| ModelType | string | no | The model type, such as Checkpoint or LoRA |
| OrderNumber | integer | no | The ordinal number of the model. You can use this parameter for custom sorting |
| Origin | string | no | The source of the model. This parameter describes the community or organization to which the source model belongs, such as ModelScope and… |
| ParameterSize | integer | no | The number of parameters, in millions |
| Task | string | no | The task of the model. This parameter describes the specific problem that the model solves. For example, text-classification |

…and 8 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/accept-dataworks-event" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-aiworkspace/accept-dataworks-event with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-aiworkspace.

### What is the status of the Alibaba Cloud Platform for Artificial Intelligence PAI - AIWorkspace API?
Needs your own provider key (bring your own key)