# Alibaba Cloud Platform for Artificial Intelligence PAI - PAIFlow API

> Alibaba Cloud Platform for Artificial Intelligence PAI - PAIFlow API on Apizie: 19 endpoints (Creates a pipeline, Creates a pipeline job, Deletes a pipeline, Deletes a pipeline job, …) 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-paiflow/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

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

## Endpoints

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| Manifest | string | yes | The workflow definition. For examples, see the supplementary description of request parameters below |
| 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 pipeline job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/create-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| Accessibility | string | no | The pipeline accessibility. PUBLIC (default) PRIVATE |
| Arguments | string | no | The parameters |
| Name | string | no | The name of the pipeline job. If you leave this parameter empty, the system automatically generates a name |
| NoConfirmRequired | string | no | Specifies whether to start the pipeline job. Valid values: true (default): starts the pipeline job. false: creates the pipeline job and… |
| Options | string | no | The options used to create the pipeline job, which are in the JSON format |
| PipelineId | string | no | The pipeline ID. You must configure PipelineId or PipelineManifest |
| PipelineManifest | string | no | The pipeline definition. For more information, see the sample pipeline definition. You must configure PipelineId or PipelineManifest |
| SourceId | string | no | The source ID |
| SourceType | string | no | The type of the pipeline job source. Valid values: UNKNOWN (default) SDK DESIGNER M6 |
| WorkspaceId | string | yes | The workspace ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineId | string | yes | The pipeline ID. You can call https://help.aliyun.com/document_detail/438051.html to obtain the ID of the pipeline |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |

### Queries the information about a pipeline
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/get-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineId | string | yes | The pipeline ID. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |

### Queries the information about a pipeline job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/get-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |
| Verbose | string | no | Specifies whether to return detailed information. Valid values: false: does not return detailed information. true: returns detailed… |
| ManifestType | string | no | The type of the manifest to be returned. Valid values: Raw (default): the original manifest submitted by the user. Frozen: generates a… |
| TokenId | string | no | The ID of the shared pipeline job |

### Queries information about a node. A pipeline job contains a variety of nodes
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/get-pipeline-run-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |
| NodeId | string | yes | The ID of a node in the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the node ID |
| Depth | integer | no | The depth at which information about the node is queried. If you set Depth to 2, the information about the node and all its child nodes at… |
| Type | string | no | The node type. Valid values: Logical (default): the logical node. The nodes submitted by users are logical nodes. Physical: the physical… |
| TokenId | string | no | The ID of the shared pipeline job |

### Obtains the node logs of a pipeline job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/list-pipeline-run-node-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |
| NodeId | string | yes | The ID of the node on which the pipeline job is executed. You can call https://help.aliyun.com/document_detail/438042.html to obtain the… |
| Offset | integer | no | The offset from which the data is returned. Default value: 0 |
| PageSize | integer | no | The number of logs returned per page |
| FromTimeInSeconds | integer | no | The beginning of the time range to query. This value is a timestamp. Unit: seconds |
| Keyword | string | no | The search keyword. Fuzzy match is supported |
| Reverse | string | no | Specifies whether the logs are sorted in descending order. Valid values: false: The logs are sorted in ascending order. This is the… |
| ToTimeInSeconds | integer | no | The end of the time range to query. This value is a timestamp. Unit: seconds |
| TokenId | string | no | The ID of the shared pipeline job |

### Retrieves the outputs of a node in a pipeline run
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/list-pipeline-run-node-outputs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline run. For information about how to obtain a pipeline run ID, see https://help.aliyun.com/document_detail/438042.html |
| NodeId | string | yes | The ID of the node in the pipeline run. For information about how to obtain a node ID, see… |
| Depth | integer | yes | The depth of the node details to query. If Depth is set to 2, the information about the node and all its child nodes at the next level is… |
| Name | string | no | The name of the node in the pipeline run to query |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1 |
| PageSize | integer | no | The number of outputs to return on each page |
| SortBy | string | no | The field used to sort the returned results. Valid values: Name Type GmtCreateTime |
| Order | string | no | The sort order. This parameter is used together with SortBy. Valid values: DESC: descending order. This is the default value. ASC:… |
| Type | string | no | The type of the artifact generated by the node in the pipeline run. Valid values: Model: model DataSet: dataset Metrics: metrics… |
| TokenId | string | no | The ID of the shared pipeline run |

### Queries the running status of a pipeline node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/list-pipeline-run-node-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |
| NodeId | string | yes | The ID of the pipeline node. You can call https://help.aliyun.com/document_detail/438042.html to obtain the node ID |
| Depth | integer | no | The depth at which information about the node is queried. If you set Depth to N, the information about the node and all its child nodes at… |
| Type | string | no | The node type. Valid values: Logical (default): the logical node. The nodes submitted by users are logical nodes. Physical: the physical… |
| TokenId | string | no | The ID of the shared pipeline job |

### Queries a list of pipeline jobs. Filtering, sorting, and pagination are supported for this API operation
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/list-pipeline-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| SourceId | string | no | The ID of the pipeline job source. You can view the ID of the pipeline job source on the pipeline details page. For more information, see… |
| Name | string | no | The name of the pipeline job |
| Order | string | no | The sorting order. You must specify this parameter together with the SortBy parameter. Valid values: ASC: ascending order. DESC:… |
| SourceType | string | no | The type of the pipeline job source. Valid values: UNKNOWN: If you do not specify this parameter, UNKNOWN is used as the default value.… |
| Status | string | no | The status of the pipeline jobs to be filtered. Valid values: Initialized Running Succeeded Failed Terminated Unknown Skipped Terminating |
| WorkspaceId | string | no | The workspace ID. You can call https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID |
| UserId | string | no | The user ID |
| PipelineIds | string | no | The IDs of the pipelines. Multiple pipeline IDs are separated by commas (,). You can call… |
| SortBy | string | no | The field for sorting. Valid values: PipelineId UserId ParentUserId StartedAt FinishedAt WorkflowServiceId Duration GmtCreateTime… |
| PipelineRunId | string | no | The pipeline job ID. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |

### Queries the status of workflow tasks or nodes in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/list-pipeline-runs-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| Nodes | array | no | The list of nodes to query. You must specify either the Nodes parameter or the PipelineRuns parameter. The Nodes parameter takes precedence |
| OutputType | string | no | The type of the artifact generated by the workflow task node. Valid values: Model: model. DataSet: dataset. Metrics: metrics.… |
| PipelineRuns | array | no | The list of workflow tasks to query. You must specify either the PipelineRuns parameter or the Nodes parameter. The Nodes parameter takes… |
| 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 |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| PipelineIdentifier | string | no | The pipeline identifier. You can call ListPipelines to obtain the identifier |
| PipelineProvider | string | no | The pipeline provider. The value is pai if the pipeline is provided by PAI. The value is the ID of the Alibaba Cloud account if the… |
| PipelineVersion | string | no | The pipeline version |
| WorkspaceId | string | no | The workspace ID. You can call https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID |
| FuzzyMatching | string | no | Specifies whether to support fuzzy match. Valid values: false true |

### Re-runs a pipeline job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/rerun-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The pipeline job ID. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |

### Starts a pipeline job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/start-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |

### Terminates a pipeline job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/terminate-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |

### Updates the definition of a pipeline
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/update-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineId | string | yes | The pipeline ID. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |
| Manifest | string | yes | The pipeline definition. For more information, see the sample pipeline definition |

### Updates a pipeline job. You can update only the name of a pipeline job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paiflow/update-pipeline-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://paiflow.ap-southeast-1.aliyuncs.com |
| PipelineRunId | string | yes | The ID of the pipeline job. You can call https://help.aliyun.com/document_detail/438042.html to obtain the ID of the pipeline job |
| Name | string | yes | The name of the updated pipeline job |

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

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

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

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

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

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