# Alibaba Cloud Platform for Artificial Intelligence PAI - LangStudio API

> Alibaba Cloud Platform for Artificial Intelligence PAI - LangStudio API on Apizie: 29 endpoints (Creates a deployment task, Creates a knowledge base, Creates a knowledge base task, Creates a runtime, …) 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-pailangstudio/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Platform for Artificial Intelligence PAI - LangStudio (pailangstudio, version 2024-07-10). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The visibility of the workspace. Valid values: PRIVATE: The workspace is visible only to you and administrators. PUBLIC: The workspace is… |
| AutoApproval | string | no | Specifies whether to automatically skip the deployment confirmation step |
| ChatHistoryConfig | object | no | The chat history configuration |
| ContentModerationConfig | object | no | The content moderation configuration |
| DeploymentConfig | string | no | The deployment configuration. For more information, see Deployment configuration… |
| Description | string | no | The description of the service |
| EnableTrace | string | no | Specifies whether Tracing Analysis is enabled |
| ResourceId | string | no | The ID of the resource to be deployed |
| ResourceSnapshotId | string | no | The snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys the resource directly based on the… |
| ResourceType | string | no | The type of the resource to be deployed. Valid values: Flow: workflow project Code: code-mode project |
| ServiceName | string | no | The name of the service. Format requirements: Only lowercase letters, digits, and underscores (_) are supported. Must start with a letter.… |
| WorkDir | string | no | The OSS working directory of the service. It is used to store runtime logs and chat history of the service |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in this workspace. PUBLIC: Visible to all users in… |
| ChunkConfig | object | yes | The file chunking configuration |
| DataSources | array | yes | The data sources |
| Description | string | no | The custom description of the knowledge base |
| EmbeddingConfig | object | yes | The vector index configuration |
| IndexColumnConfig | object | no | The field column configuration of the structured knowledge base |
| KnowledgeBaseType | string | yes | The type of the knowledge base. Valid values: TEXT: Document. STRUCTURED: Structured data. IMAGE: Image. VIDEO: Video |
| MetaDataConfig | object | no | The metadata configuration |
| Name | string | yes | The name of the knowledge base. The name must meet the following naming rules: Can contain letters, digits, or underscores (_). Must start… |
| OutputDir | string | yes | The storage path of the output data |
| RuntimeId | string | no | The runtime ID |
| VectorDBConfig | object | yes | The vector database configuration |
| 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 knowledge base task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/create-knowledge-base-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| KnowledgeBaseId | string | yes | The knowledge base ID |
| Accessibility | string | no | The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in the workspace. PUBLIC: Visible to all users in… |
| Description | string | no | The description of the knowledge base task |
| EcsSpecs | array | no | The list of resource configurations for task execution. A document or structured knowledge base contains only one element with Type set to… |
| EmbeddingConfig | object | no | The index configuration |
| JobAction | string | no | The task operation type. Valid values: SyncIndex: Updates the knowledge base index |
| MaxRunningTimeInSeconds | integer | no | The maximum running time of the task, in seconds |
| ResourceId | string | no | The resource group ID. If this parameter is left empty or set to public-cluster, public resources are used |
| UserVpc | object | no | The VPC information for task execution |
| 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 runtime
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/create-runtime` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in this workspace. PUBLIC: Visible to all users in… |
| AutoUpdateImage | string | no | The AutoUpdateImage |
| CredentialConfig | object | no | The credential configuration |
| DataSources | array | no | The mounted data sources |
| EcsSpec | object | no | The ECS resource configuration |
| Envs | array | no | The environment variables |
| Labels | array | no | The labels |
| ResourceId | string | no | The resource quota ID |
| RunTimeout | integer | no | The timeout for a single test executed on the runtime. Unit: seconds |
| RuntimeName | string | no | The name of the runtime. Format requirements: The name can contain only letters, digits, and underscores (_). The name must start with a… |
| RuntimeType | string | no | The runtime type. Valid values: DSW: A PAI-DSW instance |
| UserVpc | object | no | The user VPC configuration |
| WorkDir | string | no | The OSS path of the working directory |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in this workspace. PUBLIC: Visible to all users in… |
| CreationType | string | no | The creation type of the snapshot. Valid values: ManualCreated: Manually created. DeploymentAutoCreated: Automatic creation by the… |
| Description | string | no | The description of the snapshot |
| SnapshotName | string | no | The name of the snapshot. Format requirements: It can contain only letters, digits, and underscores (_). It must start with a letter. It… |
| SnapshotResourceId | string | no | The ID of the snapshot resource |
| SnapshotResourceType | string | no | The resource type of the snapshot. Valid values: Flow: Workflow |
| SourceStoragePath | string | no | The source storage path used to create a snapshot from source files in a specified OSS directory |
| WorkDir | string | no | The OSS working directory where the snapshot is stored |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

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

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

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The workspace ID |
| KnowledgeBaseId | string | yes | The knowledge base ID |

### Deletes a knowledge base task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/delete-knowledge-base-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace to which the knowledge base belongs |
| KnowledgeBaseId | string | yes | The ID of the knowledge base |
| KnowledgeBaseJobId | string | yes | The ID of the knowledge base task |

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

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

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

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

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

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

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.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 |
| KnowledgeBaseId | string | yes | The knowledge base ID |
| VersionName | string | no | The knowledge base version. Default value: v1 |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | yes | The ID of the workspace to which the knowledge base belongs |
| KnowledgeBaseId | string | yes | The ID of the knowledge base |
| KnowledgeBaseJobId | string | yes | The ID of the knowledge base job |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| 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 |
| RuntimeId | string | yes | The runtime ID |

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

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

### Retrieves a list of deployment tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/list-deployments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| 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 |
| NextToken | string | no | The pagination cursor used to retrieve the next page of results. * Leave this parameter empty for the first request. * For subsequent… |
| MaxResults | integer | no | The maximum number of records to return in the current request |
| SortBy | string | no | The field by which to sort the results in a paged query. Default value: GmtCreateTime. Valid values: * GmtCreateTime: sorts the results by… |
| Order | string | no | The sort order. Valid values: - ASC: ascending order. - DESC: descending order |
| DeploymentId | string | no | The ID of the deployment task |
| ResourceType | string | no | The type of the resource to deploy. Valid values: * Flow: a workflow project. * Code: a code-mode project |
| ResourceId | string | no | The ID of the resource to deploy |
| PageNumber | integer | no | The page number of the current page in a paged query |
| PageSize | integer | no | The number of items to display on each page. Default value: 10 |
| Creator | string | no | The ID of the creator |
| ResourceSnapshotId | string | no | The ID of the snapshot for the resource to deploy. If this parameter is specified, the system deploys the resource directly based on this… |
| ServiceName | string | no | The name of the service. Fuzzy match by service name is supported |
| DeploymentStatus | string | no | The status of the deployment task. To query multiple statuses at the same time, separate them with commas |
| OperationType | string | no | The operation type. Valid values: * Create: creates a service. * Update: updates an existing service |
| Accessibility | string | no | The visibility |

### Retrieves a list of knowledge base chunks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/list-knowledge-base-chunks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| KnowledgeBaseId | string | yes | The ID of the knowledge base |
| VersionName | string | no | The version of the knowledge base. Default value: v1 |
| MetaData | string | no | The original file information. If this parameter is left empty, the entire knowledge base version is traversed (JSON-encoded) |
| ChunkStatus | string | no | The chunk status. Valid values: Enable: Valid. Disable: Invalid |
| PageNumber | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |

### Get the Knowledge Base task list
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/list-knowledge-base-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | 知识库所在工作空间ID |
| KnowledgeBaseId | string | yes | 知识库ID |
| KnowledgeBaseJobId | string | no | 知识库任务ID |
| Status | string | no | 知识库任务状态。 Running: 运行中。 Success: 运行成功。 Failed: 运行失败 |
| JobAction | string | no | 任务操作类型。 SyncIndex：更新知识库索引 |
| NextToken | string | no | 用来标记当前开始读取的位置，置空表示从头开始 |
| MaxResults | integer | no | 使用 NextToken 方式查询时，每次最多返回的结果数 |
| SortBy | string | no | 排序字段。目前只支持GmtCreateTime |
| Order | string | no | 排序方式。 ASC：升序。 DESC：降序 |
| PageNumber | integer | no | 当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值 |
| PageSize | integer | no | 每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准 |
| Accessibility | string | no | 可见性 |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| Name | string | no | The name of the knowledge base |
| KnowledgeBaseId | string | no | The ID of the knowledge base |
| NextToken | string | no | The token that marks the position from which to start reading. If this parameter is left empty, the query starts from the beginning |
| MaxResults | integer | no | The maximum number of results to return per query when the NextToken parameter is used |
| SortBy | string | no | The field by which to sort the results. Only GmtCreateTime is supported |
| Order | string | no | The sort order. Valid values: ASC: ascending order DESC: descending order |
| PageNumber | integer | no | The page number. Valid values: integers greater than 0. Default value: 1. If the MaxResults parameter is also specified, the… |
| PageSize | integer | no | The number of entries to return per page. If the MaxResults parameter is also specified, the value of MaxResults prevails |
| Creator | string | no | The ID of the user who created the knowledge base |
| KnowledgeBaseType | string | no | The type of the knowledge base. Valid values: TEXT: document STRUCTURED: structured data IMAGE: image VIDEO: video |
| Accessibility | string | no | The visibility of the knowledge base |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| 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 |
| NextToken | string | no | The pagination token used to retrieve the next page of results. Leave this parameter empty for the first request. For subsequent requests,… |
| MaxResults | integer | no | The maximum number of records to return for the current request |
| PageNumber | integer | no | The page number of the current page in a paged query |
| PageSize | integer | no | The number of items to display on each page. Default value: 10 |
| RuntimeName | string | no | The name of the runtime. Fuzzy match by name is supported |
| RuntimeId | string | no | The runtime ID. Exact match by runtime ID is supported |
| WorkDir | string | no | The OSS path of the working directory |
| RuntimeStatus | string | no | The runtime status |
| Creator | string | no | The ID of the creator |
| SortBy | string | no | The field used for sorting in a paged query. Default value: GmtCreateTime |
| Order | string | no | The sort order |
| Version | string | no | The version |
| Accessibility | string | no | The visibility |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| NextToken | string | no | The pagination cursor used to retrieve the next page of results. Leave this parameter empty for the first request. For subsequent… |
| MaxResults | integer | no | The maximum number of entries to return for the current request |
| SortBy | string | no | The field used to sort the results of a paged query. Default value: GmtCreateTime. Valid values: GmtCreateTime: Sort by creation time.… |
| Order | string | no | The sort order. Valid values: ASC: ascending order DESC: descending order |
| SnapshotId | string | no | The snapshot ID |
| PageNumber | integer | no | The page number of the current page in a paged query |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| SnapshotResourceType | string | no | The snapshot resource type. Valid values: Flow: workflow |
| SnapshotResourceId | string | no | The snapshot resource ID |
| Creator | string | no | The ID of the creator |
| CreationType | string | no | The creation type of the snapshot. To query multiple types at the same time, separate them with commas |
| SnapshotStatus | string | no | The snapshot status |
| Accessibility | string | no | The visibility |

### Searches a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/retrieve-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| KnowledgeBaseId | string | yes | The knowledge base ID |
| HybridStrategyConfig | string | no | Optional. The hybrid search strategy configuration. The value is a JSON string. The JSON fields are defined as follows: Strategy: the… |
| MetaDataFilterConditions | string | no | Optional. The metadata filtering conditions for the search. The value is a JSON string. The JSON fields are defined as follows:… |
| Query | string | yes | The search query |
| QueryMode | string | no | The search mode. Valid values: dense: semantic search. hybrid: hybrid search |
| RerankConfig | string | no | Optional. The rerank configuration. The value is a JSON string. The JSON fields are defined as follows: ConnectionId: the ID of the model… |
| RewriteConfig | string | no | Optional. The rewrite configuration. The value is a JSON string. The JSON fields are defined as follows: ConnectionId: the ID of the model… |
| ScoreThreshold | number | no | The similarity score threshold. The value is a floating-point number ranging from 0 to 1 |
| TopK | integer | no | The number of top-ranked results to return |
| VersionName | string | no | The knowledge base version. Default value: v1 |
| WorkspaceId | string | yes | The ID of the workspace to which the knowledge base belongs |

### Updates a deployment task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/update-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| DeploymentId | string | yes | The ID of the deployment task |
| AutoApproval | string | no | Specifies whether to automatically skip the deployment confirmation step |
| DeploymentConfig | string | no | The service configuration for the deployment. For more information, see Deployment configuration… |
| Description | string | no | The description of the deployment |
| StageAction | string | no | The operation information of the deployment stage. The JSON format is as follows: {"Stage":3,"Action":"Confirm"}. Valid values for Action:… |
| WorkspaceId | string | no | The ID of the workspace. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### Updates a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/update-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| KnowledgeBaseId | string | yes | The ID of the knowledge base |
| AutoUpdateConfig | object | no | The automatic update configuration of the knowledge base |
| BindRuntime | string | no | Specifies whether to bind the runtime |
| Description | string | no | The description of the knowledge base |
| MetaDataConfig | object | no | The metadata configuration |
| RuntimeId | string | no | The ID of the runtime |
| WorkspaceId | string | yes | The ID of the workspace |

### Updates a knowledge base chunk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/update-knowledge-base-chunk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| KnowledgeBaseId | string | yes | The knowledge base ID |
| KnowledgeBaseChunkId | string | yes | The knowledge base chunk ID |
| ChunkContent | string | no | The chunk content |
| ChunkStatus | string | no | The chunk status. Valid values: Enable: Enabled. Disable: Disabled |

### Updates a knowledge base task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/update-knowledge-base-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| KnowledgeBaseId | string | yes | The knowledge base ID |
| KnowledgeBaseJobId | string | yes | The knowledge base task ID |
| Description | string | no | The description of the knowledge base task |
| WorkspaceId | string | yes | The ID of the workspace to which the knowledge base belongs |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| Action | string | no | The runtime action. Valid values: Start: Starts the runtime. Stop: Stops the runtime |
| AutoUpdateImage | string | no | Specifies whether to automatically update the image. When a new image version is available, the system automatically updates the runtime… |
| RunTimeout | integer | no | The timeout period for a single test run executed on the runtime, in seconds |
| Version | string | no | The runtime image version |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |
| RuntimeId | string | yes | The runtime ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |
| SnapshotId | string | yes | The snapshot ID |
| Description | string | no | The snapshot description |
| SnapshotName | string | no | The snapshot name. The name must meet the following format requirements: It can contain only letters, digits, and underscores (_). It must… |
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/create-deployment" \
  -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 - LangStudio API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-pailangstudio/create-deployment with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Platform for Artificial Intelligence PAI - LangStudio 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 - LangStudio itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Platform for Artificial Intelligence PAI - LangStudio 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-pailangstudio.

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