# Alibaba Cloud AppFlow API

> Alibaba Cloud AppFlow API on Apizie: 17 endpoints (Creates a flow, Creates a user authentication credential, Deletes a connection flow, Deletes a user authentication credential, …) 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://apizie.tech/v1/cloud:aliyun-appflow/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-appflow`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/appflow
- Page: https://apizie.tech/api/cloud/aliyun-appflow
- OpenAPI: https://apizie.tech/api/cloud/aliyun-appflow/openapi.json

Alibaba Cloud OpenAPI for AppFlow (appflow, version 2023-09-04). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/create-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | no | The ID of the flow. This parameter is required when you update a flow or create a new flow version |
| FlowName | string | yes | The name of the flow |
| FlowDesc | string | no | The description of the flow |
| FlowTemplate | string | no | The content of the template |
| TemplateId | string | no | The ID of the template. Specify this parameter when you create a flow from a template in the Template Center |
| Parameters | string | no | The parameters for the template. You can specify up to 200 parameters. This parameter is optional. If you use this parameter, you must… |
| Tag | string | no | The object tags to which the rule applies. You can specify multiple tags (JSON-encoded) |
| LaunchStatus | string | no | The publication status of the flow: True for published, False for unpublished |

### Creates a user authentication credential
`POST https://apizie.tech/v1/cloud:aliyun-appflow/create-user-auth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| ConnectorId | string | yes | The connector ID |
| ConnectorVersion | string | no | The connector version |
| AuthConfigName | string | yes | The credential name |
| AuthType | string | no | The credential type |
| AuthConfig | string | yes | The authentication information |
| Tag | string | no | The tag used for categorization or identification (JSON-encoded) |

### Deletes a connection flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/delete-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The ID of the connection flow |
| FlowVersion | integer | no | The version of the connection flow |

### Deletes a user authentication credential
`POST https://apizie.tech/v1/cloud:aliyun-appflow/delete-user-auth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| ConnectorId | string | yes | The connector ID |
| ConnectorVersion | string | no | The connector name |
| AuthConfigId | string | yes | The credential ID |

### Disables a flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/disable-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The flow ID |
| FlowVersion | integer | no | The flow version |

### Enables a flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/enable-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The ID of the flow |
| FlowVersion | integer | no | The version of the flow |

### Generates a logon session token
`POST https://apizie.tech/v1/cloud:aliyun-appflow/generate-user-session-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| ChatbotId | string | no | The ID of the AI assistant |
| IntegrateId | string | no | The integration ID |
| UserId | string | yes | The user ID |
| UserName | string | no | The nickname of the user |
| UserAvatar | string | no | The profile picture of the user (URL) |
| ExpireSecond | integer | no | The expiration time. Unit: seconds. Default value: 86400 (24 hours) |
| ExtraInfo | string | no | The extra information in JSON string format. Example: { "phone": "phone number", "dept":["Department 1","Department 2"]} |

### Retrieves the details of a connection flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/get-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The connection flow ID |
| FlowVersion | string | no | The connection flow version |

### Retrieves the details of a user authentication credential
`POST https://apizie.tech/v1/cloud:aliyun-appflow/get-user-auth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| ConnectorId | string | yes | The connection flow ID |
| ConnectorVersion | string | no | The connection flow version |
| AuthConfigId | string | yes | The credential ID |

### Invokes a connector action
`POST https://apizie.tech/v1/cloud:aliyun-appflow/invoke-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| ConnectorId | string | yes | The connector ID |
| ConnectorVersion | string | no | The connector version |
| ActionId | string | yes | The action ID |
| ActionVersion | string | no | The action version |
| Body | string | no | The request body for the action (JSON-encoded) |
| Headers | string | no | The request header parameters for the action (JSON-encoded) |
| Query | string | no | The query parameters for the action (JSON-encoded) |
| Path | string | no | The path parameters for the action (JSON-encoded) |
| AuthConfig | string | no | The authentication information for the action (JSON-encoded) |
| Stream | string | no | Specifies whether to use streaming output |

### Publishes a connection flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/launch-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The ID of the connection flow |
| FlowVersion | integer | no | The version of the connection flow |
| FlowName | string | no | The name of the connection flow |
| FlowDesc | string | no | The description of the connection flow |
| FlowTemplate | string | no | The template of the connection flow |

### Queries the list of connector flows
`POST https://apizie.tech/v1/cloud:aliyun-appflow/list-flows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| MaxResults | string | no | The maximum number of results |
| NextToken | string | no | The pagination token |
| Filter | string | no | The filter conditions (JSON-encoded) |
| Tag | string | no | Specifies the tags of the objects to which the rule applies. You can specify multiple tags (JSON-encoded) |

### Retrieves a list of user authentication credentials
`POST https://apizie.tech/v1/cloud:aliyun-appflow/list-user-auth-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| MaxResults | string | no | The maximum number of entries |
| NextToken | string | no | The pagination token |
| ConnectorId | string | yes | The connector ID |
| ConnectorVersion | string | no | The connector version |
| AuthType | string | no | The authentication type |
| Filter | string | no | The query conditions (JSON-encoded) |
| Tag | string | no | 标签，用于分类或标识 (JSON-encoded) |

### Updates a connection flow
`POST https://apizie.tech/v1/cloud:aliyun-appflow/update-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The ID of the connection flow |
| FlowVersion | string | no | The version of the connection flow |
| FlowName | string | no | The name of the connection flow |
| FlowDesc | string | no | The description of the connection flow |
| FlowTemplate | string | no | The template of the connection flow |
| Enabled | string | no | Specifies whether the connection flow is enabled |

### Updates user authentication credentials
`POST https://apizie.tech/v1/cloud:aliyun-appflow/update-user-auth-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| ConnectorId | string | yes | The connector ID |
| ConnectorVersion | string | no | The connector name |
| AuthConfigId | string | yes | The credential ID |
| AuthConfigName | string | no | The credential name |
| AuthConfig | string | no | The authentication information for action invocation |

### Takes a connection flow offline
`POST https://apizie.tech/v1/cloud:aliyun-appflow/withdraw-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The ID of the connection flow |
| FlowVersion | integer | no | The version of the connection flow |

### version
`POST https://apizie.tech/v1/cloud:aliyun-appflow/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://appflow.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-appflow/create-flow" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud AppFlow API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-appflow/create-flow with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud AppFlow API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-appflow.

### What is the status of the Alibaba Cloud AppFlow API?
Needs your own provider key (bring your own key)