# Alibaba Cloud SearchPlat API

> Alibaba Cloud SearchPlat API on Apizie: 56 endpoints (Stops a service, Creates an asynchronous task, Creates knowledge base-related configurations, Creates a configuration item in a specified workspace. The prompt and lark types are supported, …) 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-searchplat/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for SearchPlat (searchplat, version 2024-04-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Stops a service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/cease-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The name of the OpenSearch application |
| functionName | string | yes | The function name |
| instanceName | string | yes | The instance name |

### Creates an asynchronous task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-async-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to perform a dry run request |
| workspaceName | string | yes | The workspace name |
| dataId | integer | no | The playground data ID |
| id | string | no | The asynchronous task ID |
| name | string | no | The task name |
| serviceId | string | no | The service ID |
| serviceType | string | no | The service type |

### Creates knowledge base-related configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| itemCategory | string | yes | The configuration category. ai_search_agent |
| dryRun | string | no | Specifies whether to validate the legality of the request parameters. Default value: false. Valid values: true false |
| regionId | string | no | The region ID |
| itemDesc | string | no | The configuration description |
| itemName | string | no | The configuration name |
| itemValue | object | no | The configuration item |

### Creates a configuration item in a specified workspace. The prompt and lark types are supported
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| configType | string | yes | The configuration type. Valid values: prompt and lark |
| dryRun | string | no | Specifies whether the request is a dry run |
| configData | object | no | The configuration content |

### Creates access credentials
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to only validate the request parameters. Default value: false. Valid values: true: Only validates the request… |
| type | string | no | The credential type. Valid types: api-token |
| workspaceName | string | yes | The workspace name |

### Creates experience data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-experience-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to perform a dry run request |
| contentType | string | no | The data content type. Valid values: pdf text html doc |
| dataSize | integer | no | The data size |
| dataType | string | no | The data type. Valid values: file: file url: URL |
| dataValue | string | no | The data content. If dataType is set to file, this field specifies the OSS address of the file. If dataType is set to url, this field… |
| name | string | no | The data name. This parameter is required when dataType is set to file |
| serviceType | string | no | The service type |
| workspaceName | string | yes | The workspace name |

### Creates a service configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The service or model type. Valid values: nl2sql: service embedding-tuning: model |
| createParameters | array | no | The creation parameters |
| description | string | no | The instance description |
| functionType | string | no | The configuration type. Valid values: PAAS SAAS |
| instanceName | string | yes | The configuration or model name |
| modelType | string | yes | The service ID. Valid values: ops-query-analyze-nl2sql-001 ops-embedding-dim-reduction-001: vector dimension reduction |

### Creates a service configuration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-function-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The service configuration |
| instanceName | string | yes | The configuration name |

### Creates an offline processing task for video retrieval. You can configure the data source, processing…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-offline-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The task type |
| draft | string | no | Specifies whether the task is a draft |
| dryRun | string | no | Specifies whether to validate the parameters without creating the task |
| regionId | string | no | The region ID |
| meta | object | no | The task metadata |
| parameters | object | no | The task processing parameters |
| processors | array | no | The processing pipeline operators |
| sink | array | no | The data sink information |
| source | array | no | The data source information |
| status | object | no | The task status |

### Creates an evaluation task for the RAG edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-rag-evaluator-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| app_name | string | no | app_name |
| data | array | no | The list of evaluation data |
| data_source_config | string | no | The datasource config |
| emails | array | no | emails |
| evaluate_config | object | no | The evaluation configuration |
| has_data_source | string | no | has_data_source |
| metrics | array | no | The metric values. Valid values: context_recall context_precision faithfulness satisfaction comprehensive_score |
| task_name | string | no | The evaluation task name |

### Create Workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| chargeType | string | no | Billing type POSTPAY: Pay-as-you-go |
| engineType | string | no | Engine type rag |
| name | string | no | Workspace name |
| quota | object | no | Quota |
| type | string | no | Type standard |

### Deletes a specific configuration item of a specified category from a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/delete-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| itemCategory | string | yes | The configuration category ai_search_agent |
| itemName | string | yes | The configuration name |
| regionId | string | no | The region ID |

### Deletes a specific type of configuration from a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/delete-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| configType | string | yes | The configuration type promptlark |
| id | string | yes | The unique ID of the configuration item |

### Deletes an access credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| token | string | yes | The access credential token |
| workspaceName | string | yes | The workspace name |

### Delete experience data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/delete-experience-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Whether this is a dry run request |
| id | string | yes | Data ID |
| workspaceName | string | yes | The workspace name |

### Deletes a service configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/delete-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The service or model configuration |
| instanceName | string | yes | The configuration name |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The type |
| taskName | string | yes | The node name |
| regionId | string | no | The region ID |

### Deletes a RAG evaluation task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/delete-rag-evaluator-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| task_id | string | yes | The task ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |

### Queries the details of a configuration item of a specific category in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/describe-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| itemCategory | string | yes | The configuration category. Set this parameter to ai_search_agent |
| itemName | string | yes | The configuration item name |
| regionId | string | no | The region ID |

### DescribeRegions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |

### Retrieves the details of an asynchronous task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-async-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to perform a dry run request |
| workspaceName | string | yes | The workspace name |
| id | string | yes | The asynchronous task ID |

### Queries a specific type of configuration from a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| configType | string | yes | The configuration type. prompt lark |
| id | string | yes | The unique ID of the configuration item |

### Retrieves the details of an access credential
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| token | string | yes | The access credential token |
| workspaceName | string | yes | The workspace name |

### Retrieves the details of experience data
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-experience-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to validate the request parameters without performing the actual operation. Default value: false. Valid values: true false |
| workspaceName | string | yes | The workspace name |
| id | string | yes | The experience data ID |

### Queries the details of a specific feature instance in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The service type. Valid values: nl2sql: NL2SQL model type. embedding-tuning: Embedding tuning. deployment: Custom model deployment.… |
| instanceName | string | yes | The configuration name, model name, custom model deployment configuration name, or notebook instance name |
| output | string | no | Controls the richness of the returned information. Valid values: simple: displays only basic information. normal: displays information… |

### Retrieves information about an offline node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-offline-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The type |
| taskName | string | yes | The node name |
| regionId | string | no | The region ID |

### Queries the details of offline task logs in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-offline-task-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The task type |
| taskName | string | yes | The task name |
| regionId | string | no | The region ID |

### Retrieves a RAG evaluation task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-rag-evaluator-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| task_id | string | yes | The task ID |

### Retrieves data table field information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-table-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| dataSourceType | string | yes | The data source type. Valid values: rds odps |
| params | string | yes | The configuration parameters for accessing the data source |
| regionId | string | no | The region ID |

### GetTableFields
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-table-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| dataSourceType | string | yes | The data source type. Valid values: odps |
| params | string | yes | The data source parameters |
| rawType | string | no | Specifies whether to return the original field types of the data source |
| regionId | string | no | The region ID |

### Retrieves data tables
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/get-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| dataSourceType | string | yes | The data source type. Valid values: rds odps |
| params | string | yes | The data source parameters |
| regionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |

### Retrieves a list of asynchronous tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-async-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to validate the request parameters without performing the actual operation. Default value: false. Valid values: true false |
| workspaceName | string | yes | The workspace name |
| serviceType | string | no | The service type. document-analyze |
| dataId | integer | no | The trial data ID |

### Queries the list of configuration items of a specific category in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-capabilities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| itemCategory | string | yes | The configuration category |
| pageNumber | string | no | The page number |
| pageSize | string | no | The number of entries per page |
| nextToken | string | no | The pagination token |
| maxResults | integer | no | The maximum number of entries per page for a paged query |
| regionId | string | no | The region ID |

### Queries the list of configurations of a specific type in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| configType | string | yes | The configuration type promptlark |
| filter | string | no | The field-level equality filter condition. The value is a URL-encoded JSON string (which decodes to a {"fieldName": value} object).… |
| pageSize | integer | no | pageSize |
| page | integer | no | page |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| pageSize | integer | no | The number of entries per page. Default value: 10 |
| pageNumber | integer | no | The page number. Default value: 1 |
| keyword | string | no | The keyword used to search for credential values |
| workspaceName | string | yes | The workspace name |

### Retrieves all experience data in a specified workspace, with support for filtering by service type and data…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-experience-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| dryRun | string | no | true false |
| serviceType | string | no | The service type |
| workspaceName | string | yes | The workspace name |
| dataType | string | no | The data type |

### Retrieves a list of service configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-function-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The feature name |
| modelType | string | no | The model type |
| functionType | string | no | The feature type |
| source | string | no | The instance source. Valid values: builtin: system instance user: user instance (default) all: all instances |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The number of entries per page |
| output | string | no | The level of detail in the response. Valid values: simple: displays only basic information normal: displays information such as… |

### Retrieves the restriction items of a feature
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-function-restrictions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The configuration type. deployment |
| restrictionName | string | yes | The restriction name. Valid values: model: model names supported by the platform instance_type: resource types supported by the platform |
| modelType | string | no | The model type |
| region | string | no | The region ID |
| source | string | no | The source |

### Get Offline Task Information List
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-offline-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The task type |
| taskName | string | no | The task name |
| taskStatus | string | no | The task status (JSON-encoded) |
| labels | string | no | The list of task labels (JSON-encoded) |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page |
| regionId | string | no | The region ID |

### Queries the error log list of batch tasks in a specified workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-offline-task-error-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The task type |
| taskName | string | yes | The task name |
| regionId | string | no | The region ID |
| startTime | integer | no | The start timestamp in seconds. If not specified, the time one hour before the current time is used by default |
| endTime | integer | no | The end timestamp in seconds. If not specified, the current time is used by default |
| pageNum | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 10 |

### Retrieves the list of RAG evaluation tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-rag-evaluator-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| pageNumber | string | no | The page number. Default value: 1 |
| pageSize | string | no | The number of entries per page |

### Retrieves the list of services
`GET https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/list-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| modelType | string | no | The model type. Valid values: system: built-in model deployment: custom deployment model |
| serviceType | string | no | The service type |
| serviceId | string | no | The service ID |
| name | string | no | The service name |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page |
| instanceId | string | no | The instance ID |
| name | string | no | The workspace name |
| type | string | no | The type |
| sortBy | integer | no | The sort order. Valid values: 0: Sort by creation time in descending order. 1: Sort by modification time in descending order. Default… |
| resourceGroupId | string | no | The resource group ID |
| knowledgeEngineId | string | no | The ID of the associated knowledge engine |

### Updates a batch task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/modify-offline-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The task type |
| taskName | string | yes | The task name |
| dryRun | string | no | Specifies whether to validate the request parameters without performing the actual operation. Default value: false. Valid values: true false |
| regionId | string | no | The region ID |
| meta | object | no | The task metadata |
| parameters | object | no | The task processing parameters |
| processors | array | no | The processing flow operators |
| sink | array | no | The data sink information |
| source | array | no | The data source information |
| status | object | no | The task status |

### Modifies the network configuration for batch task log scenarios, including enabling or disabling public and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/modify-offline-task-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The node type |
| taskName | string | yes | The node name |
| regionId | string | no | The region ID |
| network | object | no | The network configuration for enabling or disabling network access |

### Restarts the service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/resume-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The service type |
| instanceName | string | yes | The notebook name |

### Starts a batch task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/start-offline-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| type | string | yes | The type |
| taskName | string | yes | The task name |
| regionId | string | no | The region ID |
| parallelism | integer | no | The degree of task parallelism |
| timestamp | integer | no | The start offset |

### Stops a batch task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/stop-offline-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The name of the workspace |
| type | string | yes | The type of the node |
| taskName | string | yes | The name of the node |
| regionId | string | no | The region ID |
| parallelism | integer | no | The parallelism of the node |
| timestamp | integer | no | The start offset |

### Updates a specific configuration item in a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/update-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| itemCategory | string | yes | The configuration category |
| itemName | string | yes | The configuration name |
| dryRun | string | no | Specifies whether to validate the input parameters without actually executing the operation. Default value: false. Valid values: true false |
| regionId | string | no | The region ID |
| itemDesc | string | no | The configuration description |
| itemValue | object | no | The configuration item |

### Updates the configuration of a specific type in a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/update-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| configType | string | yes | The configuration category promptlark |
| dryRun | string | no | Specifies whether this is a dry run request |
| configData | object | no | The configuration content |

### Modifies an access credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/update-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| token | string | yes | The access credential token |
| dryRun | string | no | Specifies whether to perform a dry run |
| enabled | string | no | Specifies whether the credential is enabled. Valid values: true: Enabled. false: Disabled |
| workspaceName | string | yes | The workspace name |

### Updates the service configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/update-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| functionName | string | yes | The function name |
| instanceName | string | yes | The instance name |
| createParameters | array | no | The creation parameters |
| description | string | no | The description |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |
| workspaceName | string | yes | The workspace name |
| description | string | no | The description |
| resourceGroupId | string | no | The resource group ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://searchplat.eu-central-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/cease-function-instance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud SearchPlat API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-searchplat/cease-function-instance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud SearchPlat 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-searchplat.

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