# Alibaba Cloud WinNexo API > Alibaba Cloud WinNexo API on Apizie: 214 endpoints (Adds multiple tenant members to a specified user group in a single request, Cancels to-do items in batches, Performs batch operations to schedule, pause, resume, or delete work items for valid members. A failure in a…, Batch cancels digital employee precise object type subscriptions, …) 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-winnexo/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-winnexo` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/winnexo - Page: https://zieapi.vercel.app/api/cloud/aliyun-winnexo - OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-winnexo/openapi.json Alibaba Cloud OpenAPI for WinNexo (winnexo, version 2026-05-12). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Adds multiple tenant members to a specified user group in a single request `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/add-user-group-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this parameter explicitly by using `--tenant-id` | | userGroupId | string | yes | The ID of the target user group | | userIds | string | yes | The list of platform user IDs to add. Supports single or batch input. Duplicate relationships are idempotent (JSON-encoded) | ### Cancels to-do items in batches `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/batch-cancel-todos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | todoIds | string | yes | The list of to-do IDs. You can specify 1 to 100 IDs (JSON-encoded) | ### Performs batch operations to schedule, pause, resume, or delete work items for valid members. A failure in a… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/batch-operate-work-items` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | workItemIds | string | yes | The IDs of the target work items. You can specify 1 to 100 IDs (JSON-encoded) | | action | string | yes | The batch action | | idempotencyKey | string | yes | The idempotency key | ### Batch cancels digital employee precise object type subscriptions `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/batch-remove-operating-object-favorites` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this value explicitly by using --tenant-id | | graphName | string | yes | The graph name | | operatingObjectName | string | yes | The operating object name | | objectType | string | yes | The object type, such as customer. This parameter has a value when type is set to mention | | objectIds | string | yes | The list of primary object business IDs (JSON-encoded) | ### Cancels a to-do item `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/cancel-todo` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | todoId | string | no | The ID of the to-do item. You must specify either this parameter or workItemId | | workItemId | string | no | The ID of the work item. You can use this parameter to cancel to-do items in batches by source. You must specify either this parameter or… | ### Checks resource permissions within an application `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/check-app-resource-permission` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | resourceType | string | yes | The resource type. Set the value to APP_RESOURCE | | resourceKey | string | yes | The dot-separated resource key. The first segment is the APP application key | | resourceTenantId | string | no | The ID of the tenant to which the resource belongs. If not specified, the current tenant of the caller is used | | targetUserId | integer | no | The ID of the target platform user | | targetUserTenantId | string | no | The ID of the tenant to which the target user belongs. This parameter is required for cross-tenant targets | | permission | string | yes | The permission to check | ### Checks resource permissions within applications in batches `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/check-app-resource-permissions-batch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | resourceTenantId | string | no | The ID of the tenant to which the resource belongs. If not specified, the current tenant of the caller is used | | targetUserId | integer | no | The ID of the target platform user | | targetUserTenantId | string | no | The tenant to which the target user belongs. This parameter is required for cross-tenant targets | | checks | string | yes | The check items (JSON-encoded) | ### Performs a service health check `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/check-health` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | ### Clears automatic memory `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/clear-auto-memory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | ownerType | string | no | The owner type. Valid values: user: the personal memory of the authenticated user. group: the memory of a specified workspace | | groupId | string | no | The workspace ID. This parameter is required when ownerType is set to group | | type | string | yes | The memory type. Valid values: user, feedback, reference, project, and all. A value of all does not clear manual memory | ### Clears all follows of a specific object type for a digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/clear-operating-object-favorites` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID to take effect | | graphName | string | yes | The graph name. You can call listGraphs to obtain the value | | operatingObjectName | string | yes | The operating object name, such as customer_1 | | objectType | string | yes | The object type, such as customer. This parameter has a value when type is set to mention | ### Closes workflow to-do items in batches `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/close-workflow-todos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaborative workspace. The match scope is limited to this workspace | | sourceWorkflowId | string | yes | The workflow ID at the run level | ### Retrieves the to-do badge statistics `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/count-todos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | no | The collaboration workspace ID. This parameter is optional and used for filtering. If this parameter is not specified, all workspaces are… | ### Creates a service notice `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-announcement` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant for which the notice takes effect | | title | string | yes | The title of the notice | | content | string | yes | The content of the notice | | priority | string | yes | The priority. Valid values: | | displayType | string | no | The display type and group label | | targetTenantMode | string | no | The target tenant scope. Valid values: ALL and SPECIFIED | | targetTenantIds | string | no | The list of target tenant IDs. This parameter is used when targetTenantMode is set to SPECIFIED (JSON-encoded) | | targetRoleMode | string | no | The target role scope. Valid values: ALL and SPECIFIED | | targetRoleCodes | string | no | The list of system role codes. This parameter is used when targetRoleMode is set to SPECIFIED (JSON-encoded) | | displayPage | string | no | The display page. Valid values: ALL, FRONTEND, and BACKEND | | effectiveStart | string | no | The effective start time in ISO 8601 format with time zone. If this parameter is not specified, the notice takes effect immediately | | effectiveEnd | string | no | The effective end time | | publishNow | string | no | Specifies whether to publish the notice immediately after creation | ### Creates a session `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-conversation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The operating object name (JSON-encoded) | | objectId | string | no | The primary key ID of the associated variable | | metadata | string | no | A reserved field | ### Registers a custom-only organization `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-custom-org` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | corpId | string | yes | The corpId of the activated enterprise | | corpName | string | no | The organization name | ### Creates a semantic graph and associates a data source `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-graph` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | graphName | string | yes | The graph name | | dataSourceId | integer | yes | The data source ID | | displayName | string | no | The cluster name | | businessProfile | string | no | The business description of the graph. If not configured, it is an empty string | ### Creates a DingTalk group chat knowledge resource in a group `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-ali-ding-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | chatId | string | yes | The session ID, typically used for JSSDK | | chatName | string | no | The group chat name | | directoryId | string | no | The directory ID | | historyStartTime | string | yes | The start time for collecting chat history | | updateFrequency | string | no | The feature update frequency (JSON-encoded) | | description | string | no | The description of the AI assistant | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | notes | string | no | The meeting notes content (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | The resource tags (optional, a JSON string list, such as ["tagA","tagB"]) | | groupId | string | yes | The group ID | ### Collects an Alibaba DingTalk online document to a collaborative share `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-ali-ding-doc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | groupId | string | yes | The project group ID | | name | string | yes | The image name | | directoryId | string | no | The folder ID | | description | string | no | The description of the AI assistant | | sourceTags | string | no | The resource tags. This parameter is optional. Specify a JSON string list, such as ["tagA","tagB"] | | filePublicUrl | string | yes | The publicly accessible URL of the Alibaba DingTalk online document | ### Creates knowledge from a standard DingTalk group chat for a group `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-dingtalk-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this explicitly with --tenant-id | | chatId | string | yes | The session ID, typically used for JSSDK | | chatName | string | no | The group chat name | | directoryId | string | no | The directory ID | | historyStartTime | string | yes | The start time for collecting chat history | | updateFrequency | string | no | The feature update frequency (JSON-encoded) | | description | string | no | The description of the AI assistant | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | notes | string | no | The meeting notes content (optional). This participates in auxiliary analysis | | sourceTags | string | no | The source tags | | groupId | string | yes | The project group ID | ### Creates a folder in the collaborative share resource directory `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-directory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | groupId | string | yes | The project group ID | | name | string | yes | The updated name of the filter view | | description | string | no | The workspace description | | parentDirectoryId | string | no | The folder ID | ### Collects Lark group chat data into a collaboration workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-feishu-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. You can pass it explicitly by using --tenant-id in winnexo-cli | | groupId | string | yes | The project group ID | | chatId | string | yes | The DingTalk group chat session ID | | directoryId | string | no | The folder ID | | description | string | no | The pipeline description | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | historyStartTime | string | no | The start time for historical messages. The value must be in the YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format. If this parameter is not… | | updateFrequency | string | no | The feature update frequency (JSON-encoded) | | notes | string | no | The meeting notes content (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | The source tags | ### Creates a group knowledge resource from a single Lark online document using the current user's Lark… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-feishu-doc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass it explicitly with --tenant-id | | docUrl | string | yes | The document URL | | name | string | no | The image name | | directoryId | string | no | The directory ID | | description | string | no | The description of the AI assistant | | operatingObjectName | string | no | The name of the operating object | | notes | string | no | The meeting notes content (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | The resource tags (optional, a JSON string list, such as ["tagA","tagB"]) | | objectBindings | string | no | The object bindings (JSON-encoded) | | syncConfig | string | no | The synchronization settings (JSON-encoded) | | groupId | string | yes | The project group ID | ### Uploads a local file to a collaborative share `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | groupId | string | yes | The project group ID | | name | string | yes | The name | | directoryId | string | no | The folder ID | | description | string | no | The description of the AI assistant | | sourceTags | string | no | The source tags | | fileRecordId | string | yes | The file record ID. This parameter is optional and corresponds to settings.file_record_id | ### Collects public web pages to a collaborative share `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-public-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID that takes effect | | groupId | string | yes | The project group ID | | originalUrl | string | yes | The URL of the web page | | name | string | no | The name | | directoryId | string | no | The folder ID | | description | string | no | The description of the AI assistant | | sourceTags | string | no | The resource labels. This parameter is optional. Specify a JSON string list, such as ["tagA","tagB"] | | operatingObjectName | string | no | The name of the digital employee (monitored object name). This parameter is optional | | notes | string | no | The meeting notes content. This parameter is optional. The notes participate in auxiliary analysis | ### Uploads plain text to a collaboration workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-group-text` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | groupId | string | yes | The project group ID | | name | string | yes | The image name | | directoryId | string | no | The folder ID | | description | string | no | The description of the AI assistant | | sourceTags | string | no | The source tags | | textContent | string | yes | The message content for text messages | ### Uploads an AliDing online document to the enterprise knowledge base. Management permissions are required `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-knowledge-base-ali-ding-doc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | name | string | yes | The name | | filePublicUrl | string | yes | The publicly accessible URL of the AliDing online document | | directoryId | string | no | The directory ID | | description | string | no | The description of the alias | | knowledgeId | string | no | Not supported. This parameter is ignored | | sourceTags | string | no | The resource tags (optional, a JSON string list, such as ["tagA","tagB"]) | ### Creates a category directory in the enterprise knowledge base `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-knowledge-base-directory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | name | string | yes | The image name | | parentDirectoryId | string | no | The directory ID | | description | string | no | The description of the AI assistant | ### Creates a single Lark online document in the enterprise knowledge base using the current user's Lark… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-knowledge-base-feishu-doc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | docUrl | string | yes | The document URL | | name | string | no | The mirror name | | directoryId | string | yes | The folder ID | | description | string | no | The description of the alias | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | notes | string | no | The meeting notes content (optional). Used for auxiliary analysis | | sourceTags | string | no | The resource tags (optional, a JSON string list such as ["tagA","tagB"]) | | objectBindings | string | no | The object bindings (JSON-encoded) | | syncConfig | string | no | The synchronization settings (JSON-encoded) | ### Uploads a specified file to the enterprise knowledge base. Management permissions are required `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-knowledge-base-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name). This parameter is optional | | name | string | yes | The name of the AI assistant | | filePath | string | yes | The file path | | filePublicUrl | string | no | The publicly accessible URL of the DingTalk online document | | fileName | string | no | The file name | | fileExt | string | no | The file name extension. This parameter is optional. Examples: pdf and docx | | fileRecordId | string | no | The file record ID. This parameter is optional and corresponds to settings.file_record_id | | directoryId | string | no | The directory ID | | description | string | no | The description of the alias | | knowledgeId | string | no | Not supported. Ignore this parameter | | sourceTags | string | no | The resource labels. This parameter is optional. Specify a JSON string list, such as ["tagA","tagB"] | ### Collects a single public web page into the enterprise knowledge base of the current user `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-knowledge-base-public-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | originalUrl | string | yes | The URL of the public HTTP/HTTPS web page | | name | string | no | The resource name. If not specified, the URL is used | | directoryId | string | yes | The ID of the destination folder in the enterprise knowledge base. This parameter is required. You must have knowledge base management… | | description | string | no | The resource description | | operatingObjectName | string | no | The name of the operating object | | notes | string | no | The analysis instruction | | sourceTags | string | no | The list of resource tags as JSON strings | ### Adds plain text content to a specified enterprise knowledge base `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-knowledge-base-text` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the operating object | | name | string | yes | The image name | | textContent | string | yes | The message content for text messages | | directoryId | string | no | The folder ID | | description | string | no | The description of the alias | | knowledgeId | string | no | Not supported. Ignore this parameter | | sourceTags | string | no | The source tags | ### Creates a personal AliDing group chat knowledge resource `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-ali-ding-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. The winnexo-cli passes this value explicitly by using --tenant-id | | chatId | string | yes | The DingTalk group chat session ID | | chatName | string | no | The group chat name | | directoryId | string | no | The folder ID | | historyStartTime | string | yes | The start time for collecting chat history | | updateFrequency | string | no | The feature update frequency (JSON-encoded) | | description | string | no | The pipeline description | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | notes | string | no | The meeting notes content (optional). This participates in auxiliary analysis | | sourceTags | string | no | The resource tags (optional, a JSON string list such as ["tagA","tagB"]) | ### Uploads an AliDing meeting file to the personal resource library of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-ali-ding-meeting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The name of the image-trained digital human | | shanjiUrl | string | yes | The original Shanji link (required) | | directoryId | string | no | The directory ID | | description | string | no | The description of the AI assistant | | notes | string | no | The meeting notes (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | A list of resource tag JSON strings | ### Uploads an AliDing online document to the personal resources of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-aliding-doc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The customer group name | | filePublicUrl | string | yes | The publicly accessible URL of the AliDing online document | | directoryId | string | no | The folder ID | | description | string | no | The pipeline description | | sourceTags | string | no | The list of resource tag JSON strings | ### Adds the entire AliDing knowledge base to the personal resources of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-aliding-knowledge-base` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | kbUrl | string | yes | The publicly accessible URL of the AliDing knowledge base | | kbName | string | no | The display name of the knowledge base. If not provided, the name is populated from the root node name pulled from the remote source | | directoryId | string | no | The directory ID | | objectBindings | string | no | The object bindings (JSON-encoded) | | syncConfig | string | no | The synchronization settings (JSON-encoded) | | sourceTags | string | no | The list of resource tag JSON strings applied to all child sources created during knowledge base synchronization | ### Creates a personal DingTalk group chat knowledge source `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-dingtalk-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | chatId | string | yes | The DingTalk group chat session ID | | chatName | string | no | The group chat name | | directoryId | string | no | The directory ID | | historyStartTime | string | yes | The start time for collecting chat history | | updateFrequency | string | no | The feature update frequency (JSON-encoded) | | description | string | no | The pipeline description | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | notes | string | no | The meeting notes content (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | The resource tags (optional, a JSON string list, such as ["tagA","tagB"]) | ### Uploads a meeting to the current user's personal knowledge base by using the URL of a standard DingTalk… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-dingtalk-minutes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The name of the worksheet | | shanjiUrl | string | yes | The original Shanji note link (required) | | directoryId | string | no | The directory ID | | description | string | no | The pipeline description | | notes | string | no | The meeting notes content (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | A list of resource tag JSON strings | ### Creates a personal folder (category) under My Resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-directory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The name of the digital employee | | parentDirectoryId | string | no | The folder ID | | description | string | no | The workspace description | ### Creates a personal knowledge resource from a single Lark group chat using the current user's Lark… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-feishu-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID to take effect | | chatId | string | yes | The group chat session ID | | directoryId | string | no | The directory ID | | description | string | no | The description of the source | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | historyStartTime | string | no | The start time for historical messages. Supports YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. If not specified, all visible history is pulled | | updateFrequency | string | no | The update frequency (JSON-encoded) | | notes | string | no | The meeting notes content (optional). Used for auxiliary analysis | | sourceTags | string | no | The source tags | ### Creates a personal knowledge resource from a single Lark online document using the current user's Lark… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-feishu-doc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | docUrl | string | yes | The document URL | | name | string | no | The updated name of the filter view | | directoryId | string | no | The folder ID | | description | string | no | The pipeline description | | operatingObjectName | string | no | The digital employee name (operating object name, optional) | | notes | string | no | The meeting notes content (optional). The notes are used for auxiliary analysis | | sourceTags | string | no | The resource tags (optional, a JSON string list, such as ["tagA","tagB"]) | | objectBindings | string | no | The object bindings (JSON-encoded) | | syncConfig | string | no | The synchronization settings (JSON-encoded) | ### Uploads a Lark Minutes meeting file to the personal resource library of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-feishu-minute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The image name | | minuteToken | string | yes | The Lark Minutes token (unique identifier of the minutes record, required) | | credentialId | string | yes | The credential ID | | directoryId | string | no | The directory ID | | description | string | no | The schedule description | | sourceTags | string | no | The list of resource tag JSON strings | ### Uploads a file to the personal resource library of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The pipeline name | | filePath | string | yes | The file path | | filePublicUrl | string | no | The publicly accessible URL of the DingTalk online document | | fileName | string | no | The file name | | fileExt | string | no | The file name extension (optional, such as pdf or docx) | | fileRecordId | string | no | The file record ID (optional, corresponding to settings.file_record_id) | | directoryId | string | no | The folder ID | | description | string | no | The pipeline description | | sourceTags | string | no | The list of resource tag JSON strings | ### Collects a single public web page into the current user's personal knowledge base `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-public-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | originalUrl | string | yes | The URL of the public HTTP/HTTPS web page | | name | string | no | The resource name. If omitted, the URL is used | | directoryId | string | no | The ID of the target personal directory. If not specified, the current user's default personal root directory is used | | description | string | no | The resource description | | operatingObjectName | string | no | The name of the operating object | | notes | string | no | The analysis instruction | | sourceTags | string | no | The list of resource tag JSON strings | ### Uploads plain text content to the personal resource library of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-text` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The image name | | textContent | string | yes | The message content for text messages | | directoryId | string | no | The directory ID | | description | string | no | The pipeline description | | sourceTags | string | no | The list of resource tag JSON strings | ### Uploads an offline meeting audio file to the personal resources of the current digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-personal-voice-meeting` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | requestId | string | yes | Id of the request | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | name | string | yes | The image name | | fileUrl | string | yes | The Yida attachment URL | | directoryId | string | no | The directory ID | | description | string | no | The pipeline description | | sourceTags | string | no | The list of resource tag JSON strings | ### Creates a scheduled task `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the effective tenant | | digitalEmployeeName | string | no | The name of the current effective digital employee. This parameter is empty if not configured (JSON-encoded) | | triggerConfig | string | no | The trigger configuration. The configuration varies depending on the trigger type. For the specific format, refer to the following data… | | description | string | no | The description of the to-do card type (JSON-encoded) | | segments | string | no | The site ID (JSON-encoded) | | taskDetail | string | no | The task details (JSON-encoded) | | isOpen | string | no | Specifies whether public access is enabled | | name | string | yes | The name | | model | string | no | The large model used by the assistant. An empty value indicates that DingTalk automatically selects the model | | collaborationGroupId | string | no | The ID of the collaboration group (such as cg_101). If specified, a group space task is created (the caller must be a valid group member).… | | visibility | string | no | The visibility scope of the group task. Valid values: PRIVATE (visible only to the creator and group owner), COLLABORATIVE (visible to… | | visibleMemberUserIds | string | no | The list of collaborator user IDs. This parameter takes effect only when visibility is set to COLLABORATIVE. It is ignored for other… | ### Adds a knowledge base and knowledge base categories `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-tenant-directory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant for which the operation takes effect | | name | string | yes | The name | | description | string | no | The description of the to-do card type | | parentId | integer | no | The ID of the parent node | | path | string | no | The path of the node | ### Creates a to-do item `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-todo` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | title | string | yes | The title of the to-do item. The maximum length is 200 characters | | questions | string | yes | The list of questions (JSON-encoded) | | priority | string | no | The priority | | sourceType | string | yes | The source of the to-do item. Only OPEN_API is supported | | sourceContext | string | yes | The source context. The value is passed through and stored in the database as-is without validation (JSON-encoded) | | assigneeUserIds | string | yes | The list of platform user IDs of the assignees. You can specify 1 to 100 IDs. Duplicate IDs are automatically removed (JSON-encoded) | | collaborationGroupId | string | no | The ID of the collaboration workspace. This parameter is optional | ### Creates a user and adds the user to a tenant `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant on which the operation takes effect | | wnAccountId | string | yes | The WINNEXO logon account (unique identifier, required) | | displayName | string | yes | The cluster name | | roleCodes | string | no | The list of new system role codes (full replacement, must contain at least one role). Valid values: SUPER_ADMIN, SYSTEM_ADMIN,… | | passwordEncrypted | string | yes | The base64-encoded password ciphertext encrypted by using RSA-OAEP-SHA256 (required) | | ssoProvider | string | no | The SSO provider type. This parameter is optional if the tenant has only one external logon method. This parameter is required if the… | ### Creates a user group under the tenant to which the authenticated identity belongs `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-user-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | userGroupName | string | yes | The name of the user group. The name must be unique under the same parent node | | parentId | string | no | The ID of the parent user group. If this parameter is not specified, a root node is created | | description | string | no | The description of the user group | ### Creates a WINNEXO user in the current tenant and assigns roles and user groups to the user `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-user-with-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this parameter explicitly by using `--tenant-id` | | wnAccountId | string | yes | The WINNEXO logon account. This parameter is a unique identifier and cannot be empty | | displayName | string | yes | The display name of the user. The name must be unique within the tenant and cannot exceed 100 characters in length | | roleCodes | string | no | The list of initial system role codes. If this parameter is not specified, the `APPLICATION_USER` role is assigned by default (JSON-encoded) | | userGroupIds | string | no | The list of initial user group IDs. A maximum of 100 user group IDs can be specified. All user groups must belong to the current tenant… | | passwordEncrypted | string | yes | The Base64-encoded password ciphertext encrypted by using the RSA-OAEP-SHA256 algorithm | ### Creates a workflow work item for a valid member and copies the template execution snapshot. Only the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-work-item` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | itemType | string | yes | The type of the work item. Only WORKFLOW is supported | | title | string | yes | The title of the work item | | description | string | no | The description of the work item | | acceptanceCriteria | string | no | The acceptance criteria | | priority | string | no | The scheduling priority | | ownerUserId | integer | no | The user ID of the owner. If this parameter is not specified, the ID of the caller is used | | collaboratorUserIds | string | no | The list of user IDs of the collaborators (JSON-encoded) | | attachments | string | no | The stable references of the input attachments (JSON-encoded) | | conversationId | string | no | The ID of the associated conversation | | workflowTemplateIds | string | no | The list of IDs of the bound workflow templates (JSON-encoded) | ### Creates a work item idempotently by business ID in a specified collaboration workspace, starts an actual run… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-workflow-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter explicitly passed by using --tenant-id in winnexo-cli | | collaborationGroupId | string | yes | The collaboration workspace ID | | templateId | string | yes | The workflow template ID. Maximum length: 64 characters | | title | string | yes | The requirement title | | businessId | string | yes | The unique requirement ID in the workspace. Repeated requests are idempotent | | acceptanceCriteria | string | yes | The required acceptance criteria for the workflow | | priority | string | no | The work item priority | | initiator | string | no | The display label of the external initiator | | variables | string | no | The business variable object. The tags field can be a list of string tags (JSON-encoded) | ### Creates a new workflow template. Templates with the same name are not overwritten `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-workflow-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | definition | string | yes | The complete JSON definition of the template, including name, description, and steps (JSON-encoded) | | action | string | no | The write action. Valid values: SAVE: Saves the template as a draft without taking effect. SUBMIT: Saves and submits the template and sets… | ### Creates a draft of a workflow template `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/create-workflow-template-draft-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | templateId | string | yes | The ID of the template | | version | string | yes | The version number of the template on which the edit is based. The format is a lowercase v followed by a positive integer, such as v1. A… | ### Deletes multiple resource permissions within an application `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-app-resource-permissions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | resourceTenantId | string | no | The ID of the tenant to which the resource belongs. If not specified, the current tenant of the caller is used | | items | string | yes | The scope of the permissions to be revoked (JSON-encoded) | ### Deletes a session `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-chat-session` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID that takes effect | | sessionId | string | yes | The ID of the session to be deleted | ### Deletes a specified source `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | sourceId | string | yes | The unique identifier on the business system side, that is, the business ID | ### Deletes an enterprise knowledge base and its subdirectories `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-tenant-directory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID that takes effect | | directoryId | string | no | The directory ID | | deleteMode | string | no | The deletion mode: reject / recursive / move_to_root | ### Deletes a non-processing work item by a valid member and cascades the cleanup of to-do items, node topics,… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-work-item` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | workItemId | string | yes | The ID of the work item | ### Physically deletes a workflow template and its steps for valid members without performing work item… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-workflow-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | templateId | string | yes | The ID of the template | ### Deletes a specified version of a workflow template `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/delete-workflow-template-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | templateId | string | yes | The ID of the template | | version | string | yes | The version number of the template to be deleted. The format is a lowercase v followed by a positive integer, such as v1. The version… | ### Disables an API token `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/disable-token` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the effective tenant | | wnUserId | string | no | The ID of the target user (WINNEXO platform user ID). If left empty, the operation is performed on the caller. Administrators can specify… | ### Enables an API token `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/enable-token` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the effective tenant | | wnUserId | string | no | The ID of the target user (WINNEXO platform user ID). If this parameter is left empty, the operation is performed on the caller.… | ### Exports a simplified template definition that can be re-imported by valid members `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/export-workflow-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The collaboration workspace ID | | templateId | string | yes | The template ID | | version | string | no | The version number of the template to export. The format is a lowercase v followed by a positive integer, such as v1. If not specified,… | ### Generates a non-persistent template draft by calling a large language model (LLM) and consumes the LLM quota… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/generate-workflow-template-draft` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration space | | requirement | string | yes | The description of the template requirement | | previousDraft | string | no | The draft from the previous round. If this parameter is provided, the new draft is generated by iteratively modifying the previous draft… | ### Queries the operation logs of a workflow agent `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-agent-work-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. If not specified, the default tenant of the caller is used | | workItemId | string | yes | The work item ID | | nodeId | string | no | The optional node key | | page | integer | no | The page number. Pages start from 1 | | pageSize | integer | no | The number of entries per page. Maximum value: 100 | ### Retrieves DingTalk meeting minutes content for the Winnexo Lite Workbench `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-ali-ding-minutes-content` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the effective tenant | | minutesId | string | yes | The DingTalk minutes ID | ### Retrieves session details `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-chat-session` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The effective tenant ID | | sessionId | string | yes | The SessionId value to filter by. If specified, all Active/Expired status information associated with this session is returned | | limit | integer | no | The maximum number of resources to return. If not specified, the default value is 20. The maximum value is 100. The number of returned… | ### Retrieves the full schema after merging the active schema with personal drafts `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-graph-draft-assembled` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The effective tenant ID | | graphName | string | yes | The knowledge graph name | ### Retrieves the active Graph Schema readable by the current user `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-graph-schema` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | yes | The effective tenant ID | | graphName | string | yes | The graph name. Call listGraphs first to obtain this value | ### Retrieves the complete schema of a semantic graph from the management perspective `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-graph-schema-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. You can pass this parameter explicitly by using `--tenant-id` in winnexo-cli | | graphName | string | yes | The name of the graph | ### Retrieves the details of a resource in a collaboration space `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-group-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | groupId | string | yes | The project group ID | | sourceId | string | yes | The ID of the personal FILE data source to be replaced. The ID is unique within the tenant | ### Queries the expiration time of the most recently created standard package instance for a tenant `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-instance-expire-time` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The effective tenant ID | ### Queries the details of a specified knowledge item in the enterprise knowledge base `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-knowledge-base-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | sourceId | string | yes | The unique identifier on the business system side, that is, the business ID | ### Queries the automatic memory collection switch `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-memory-auto-extraction-switch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | ownerType | string | no | The owner type. A value of user indicates the personal memory of the authenticated user, and a value of group indicates the memory of the… | | groupId | string | no | The collaboration workspace ID. This parameter is required when ownerType is set to group | ### Queries the details of a memory `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-memory-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | ownerType | string | no | The owner type. A value of user indicates the personal memory of the authenticated user. A value of group indicates the memory of a… | | groupId | string | no | The workspace ID. This parameter is required when ownerType is set to group | ### Queries the details of an instance node `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-node-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | instanceId | string | yes | The physical workflow instance ID (planId) | | nodeId | string | yes | The ID of the node (nodeKey) | ### Retrieves the execution details of a scheduled task `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-scheduled-task-execution-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the effective tenant | | executionId | string | yes | The execution record ID | ### Retrieves execution records of scheduled tasks `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-scheduled-task-execution-records` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the effective tenant | | page | integer | no | The page number. Default value: 1. Minimum value: 1. Maximum value: 200 | | pageSize | integer | no | The number of records per page | | collaborationGroupId | string | no | The ID of the collaboration group to which the task belongs, such as cg_101. If this parameter is specified, a group workspace task is… | | taskId | string | no | The ID of a single task for pre-filtering. If this parameter is not specified, execution records of all visible tasks are returned | | status | string | no | The execution status filter (lowercase). Valid values: pending: Queued. running: Running. success: Succeeded. failed: Failed. timeout:… | | initiatorUserId | string | no | The platform user ID of the initiator for filtering. The scope is the executor of the record. For manual execution, this is the user who… | ### Retrieves the push configuration options for scheduled tasks `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-scheduled-task-push-options` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this value explicitly by using --tenant-id | | digitalEmployeeName | string | no | The name of the currently active digital employee. This value is empty if not configured | | collaborationGroupId | string | no | The ID of the collaboration group, such as cg_101. If specified, a group workspace task is created and the caller must be a valid group… | ### Retrieves the details of a skill `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-skill` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the task belongs | | skillCode | string | no | The skill code. This parameter has a value when type is set to skill | | skillName | string | no | The skill name | | viewMode | string | no | The view mode. Valid values: draft (draft/editing view) and published (published view, default) | | includeSkillFiles | string | no | Specifies whether to return the complete file tree. Default value: False. This avoids large responses | ### Queries the execution result of a skill `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-skill-run` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID to which the task belongs | | runId | string | yes | The evaluation run ID | | includeLogs | string | no | Specifies whether to include execution logs. Default value: false. Enable this parameter only for troubleshooting | ### Queries the details of a specified resource (knowledge), with support for returning large detail fields on… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-source` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the task belongs | | sourceId | string | yes | The primary ID of the resource | | includeDetails | string | no | Specifies whether to return large detail fields (settings / notes / structuredTables / unstructuredDocs). Default value: False. When set… | ### Generates a signed URL for directly uploading files to OSS `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-source-upload-signature` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID to which the task belongs | | filename | string | yes | The file name | | operatingObjectName | string | no | The name of the digital employee (operating object name, optional) | | expires | integer | no | The expiration time of the signed URL, in seconds. Default value: 3600 | | contentType | string | no | The content type. Valid values: Text Markdown | | scope | string | no | The permission scope | | groupId | string | no | The collaboration space ID passed from the frontend. This parameter is required when scope is set to group. The value must be a space… | ### Queries to-do items `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-todo` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | todoId | string | no | The ID of the to-do item (get) | | workItemId | string | no | The ID of the work item. This parameter is used to query multiple to-do items by source | | messageId | string | no | The ID of the assistant message. This parameter is used to query multiple to-do items by message | ### Queries the processing details of a to-do item `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-todo-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | todoId | string | yes | The ID of the to-do item | ### Retrieves an API token and ensures that it is active `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-token-ensure-enable` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the task belongs | | wnUserId | string | no | The WinNexo user ID | ### Queries the token status of a user `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-token-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the task belongs | | wnUserId | string | no | The ID of the target user (WINNEXO platform user ID). If left empty, the operation is performed on the caller. Administrators can specify… | ### Queries user details `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the task belongs | | wnUserId | string | no | The WINNEXO platform user ID. Specify either this parameter or accountId | | wnAccountId | string | no | The WINNEXO logon account. This parameter is a unique identifier and cannot be empty | ### Queries the real-time credit consumption, limit, and remaining balance of the current logged-on user `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-user-credit-usage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the task belongs | ### Queries the details of a specified user group, including its parent group, child groups, and members `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-user-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this parameter explicitly by using `--tenant-id` | | userGroupId | string | yes | The ID of the target user group | ### Retrieves the complete information of the authenticated user through OpenAPI, including basic information… `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-user-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The effective tenant ID | ### Retrieves the details of a work item visible to valid members in the current collaboration space `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-work-item` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration space | | workItemId | string | yes | The ID of the work item | ### Redirects to the short-term signed download URL of the artifact with an HTTP 302 status code after… `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-work-item-artifact-access` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | workItemId | string | yes | The ID of the work item | | artifactId | string | yes | The ID of the artifact | ### Redirects to the short-term preview URL of the specified attachment with a 302 status code after validating… `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-work-item-attachment-access` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The collaboration workspace ID | | workItemId | string | yes | The work item ID | | attachmentId | string | yes | The attachment ID | ### Queries the current running, review, and pause statuses of a work item, along with the actual active nodes… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-workflow-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If you use winnexo-cli, pass this parameter explicitly by using --tenant-id | | instanceId | string | yes | The stable logical instance ID | ### Retrieves the current configuration of a workflow template in a collaboration workspace `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/get-workflow-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The ID of the collaboration workspace | | templateId | string | yes | The ID of the template | | version | string | no | The version number of the template to read. The format is a lowercase v followed by a positive integer, such as v1. If not specified, the… | ### Grants authorization to authorized users or user groups to use a digital human `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/grant-agent-users` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID | | operatingObjectName | string | yes | The name of the digital human | | userIds | string | no | The list of user IDs to be authorized (JSON-encoded) | | userGroupIds | string | no | The list of user group IDs (JSON-encoded) | | expireDate | integer | no | The authorization expiration timestamp in milliseconds. If this parameter is not specified, the authorization never expires | | permissions | string | no | The permission items (JSON-encoded) | ### Imports a portable template JSON and creates a new template. A new template is created regardless of whether… `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/import-workflow-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If omitted, the default tenant of the caller is used | | collaborationGroupId | string | yes | The collaboration workspace ID | | template | string | yes | The portable template JSON. The stepId and sortOrder fields can be omitted (JSON-encoded) | ### Queries currently effective service notices `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-active-announcements` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | pageNumber | integer | no | The page number for paginated queries | | pageSize | integer | no | The number of entries per page. Default value: 100. Maximum value: 500 | ### Queries or drills down into the enterprise knowledge base list of a tenant `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-admin-knowledge-bases` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID to which the task belongs | | directoryId | string | no | The directory ID | | page | integer | no | The page number. Default value: 1. Pages start from page 1 | | pageSize | integer | no | The number of entries per page | | sortField | string | no | The field by which the results are sorted. Valid values: event_time: the event creation time. event_execute_start_time: the event… | | sortOrder | string | no | The sort order. This parameter takes effect only when sortBy is specified. Valid values: ASC, DESC (case-insensitive) | | keyword | string | no | The keyword for fuzzy search on form component data | | sourceTypes | string | no | The list of source types (JSON-encoded) | ### Queries the full list of digital employees for a tenant `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-agents` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | ### Retrieves DingTalk group chat records for the Winnexo lightweight workbench `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-ali-ding-group-messages` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. Pass it explicitly through `--tenant-id` in winnexo-cli | | chatId | string | yes | The session ID, typically used for JSSDK | | time | string | yes | The relationship information | | direction | string | no | The traffic direction. Valid values: OutBound: outbound. InBound: inbound. Both: bidirectional | | pageSize | integer | no | The number of entries per page | ### Retrieves the list of DingTalk meeting minutes for the Winnexo lightweight workbench `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-ali-ding-minutes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. Pass it explicitly through the winnexo-cli --tenant-id option | | startTime | string | yes | The query start time. This value is a UNIX timestamp in seconds | | endTime | string | yes | The actual end timestamp of the live session, in milliseconds | | pageSize | integer | no | The number of entries per page | | cursor | string | no | The cursor for the paged query. Set this parameter to 0 for the first request. For subsequent requests, set this parameter to the… | ### Queries the resource authorization records within an application `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-app-resource-permission-records` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | resourceTenantId | string | no | The ID of the tenant to which the resource belongs. If not specified, the current tenant of the caller is used | | resourceType | string | yes | The resource type. Set this parameter to APP_RESOURCE | | resourceKeyPrefix | string | yes | The application key or its subpath | | page | integer | no | The page number | | pageSize | integer | no | The number of entries per page | | granteeType | string | no | The grantee type filter | | granteeId | string | no | The grantee ID filter | | granteeTenantId | string | no | The tenant ID filter for cross-tenant users | | permissions | string | no | The permission filter (JSON-encoded) | ### Queries the valid resource permissions of a user within an application `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-app-resource-user-permissions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If you do not specify this parameter, the default tenant of the caller is used | | resourceTenantId | string | no | The ID of the tenant to which the resource belongs. If you do not specify this parameter, the current tenant of the caller is used | | targetUserId | integer | no | The ID of the target platform user | | targetUserTenantId | string | no | The tenant to which the target user belongs. This parameter is required for cross-tenant targets | | resourceType | string | yes | The resource type. Set the value to APP_RESOURCE | | resourceKeyPrefix | string | yes | The application key or its subpath | | page | integer | no | The page number | | pageSize | integer | no | The number of entries per page | | permissions | string | no | The permission points to filter (JSON-encoded) | ### Queries the list of digital human names for which the caller has the specified permission `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-authorized-agents` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | permission | string | no | The userId of the responsible user | | targetUserId | integer | no | The target user ID | ### Queries the list of authorized users or user groups for a digital employee `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-authorized-users` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | operatingObjectName | string | yes | The name of the digital employee | | keyword | string | no | The search keyword | | granteeType | string | no | The filter type. Valid values: USER USER_GROUP If this parameter is not specified, all types are returned | | permission | string | no | Permission | ### Enumerates available organization synchronization configurations `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-available-configs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. The winnexo-cli passes this parameter explicitly by using --tenant-id | ### Queries and filters a bill list by using OpenAPI. Multiple filter conditions are supported `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-billing` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. In winnexo-cli, pass this parameter explicitly by using --tenant-id | | wnUserId | string | no | The user ID (WINNEXO platform user ID, optional filter) | | operation | string | no | The operation type. Valid values: start: indicates node creation. This is the default value. In most cases, you do not need to explicitly… | | status | string | no | The node status. Running is returned upon submission | | startTime | string | no | The query start time. The value is a UNIX timestamp in seconds | | endTime | string | no | The actual end timestamp of the live stream, in milliseconds | | bizType | string | no | The business type. Currently supported values: model Q&A (LlmChat) and document library Q&A (LibraryChat) | | bizId | string | no | The unique business identifier. When bizType is set to LibraryChat, bizId specifies the document library ID | | ignoreZero | string | no | Specifies whether to filter out bills with zero credit consumption. Default value: true (filter out) | | page | integer | no | The current page number | | pageSize | integer | no | The number of entries per page. Default value: 20. Minimum value: 1. Maximum value: 50 | ### Lists chat sessions of the current user in reverse chronological order by creation time `GET https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-chat-sessions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The ID of the tenant to which the node belongs | | pageSize | integer | no | The maximum number of data records to read in this request | | keyword | string | no | The rule name keyword for fuzzy match | | digitalEmployeeName | string | no | The list of digital employee names. A single string can be passed for backward compatibility with the legacy format | | page | integer | no | The page number. Default value: 1. Pages start from page 1 | ### Lists personal draft changes for a semantic graph `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-graph-draft-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | graphName | string | yes | The graph name | ### Queries the list of semantic graphs from the management perspective `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-graph-schemas` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If this parameter is not specified, the default tenant of the caller is used | | keyword | string | no | The keyword for fuzzy match of component data in the form | | semanticTags | string | no | The semantic tags used for filtering. A graph is retained if any tag matches (JSON-encoded) | ### Queries the list of knowledge graphs available for semantic queries under a tenant `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-graphs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | yes | The ID of the tenant to which the node belongs | ### Lists the resource directories of a collaborative share `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-group-directories` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | groupId | string | yes | The ID of the collaborative share | | directoryId | string | no | The ID of a visible directory in the current space. If this parameter is omitted or set to root, the space root is queried. The first… | | sortField | string | no | The sort field. Valid values: name, gmt_create, and gmt_modified | | sortOrder | string | no | The sort order. Valid values: asc and desc | ### Performs a paged query on the contents of a collaboration space folder `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-group-directory` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. If not specified, the default tenant of the caller is used | | groupId | string | yes | The collaboration space ID | | directoryId | string | no | The ID of a visible directory within the space. If omitted or set to root, the internal root is queried. On the first query, the existing… | | page | integer | no | The page number, starting from 1 | | pageSize | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 | | sortField | string | no | The sort field within the group. Valid values: name, gmt_create, and gmt_modified. Directories are listed first | | sortOrder | string | no | The sort order within the group. Valid values: asc and desc. Directories are always listed first | | sourceTypes | string | no | The array of resource types. If values are specified, only resources are returned. If the array is empty or omitted, no type-based… | | sourceStatus | string | no | The resource status filter. Physical subdirectories are retained. Immediate reference directories are not returned when a status filter is… | ### Queries the node list of an instance `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-instance-nodes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. If not specified, the default tenant of the caller is used | | collaborationGroupId | string | yes | The collaboration workspace ID | | instanceId | string | yes | The physical workflow instance ID (planId) | ### Queries the category directory tree of an enterprise knowledge base. Sorting by a specified field is supported `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-knowledge-base-directories` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID. This is a common parameter. You can pass this parameter explicitly by using --tenant-id in winnexo-cli | | directoryId | string | no | The directory ID | | sortField | string | no | The field by which the results are sorted. Valid values: event_time: the event creation time. event_execute_start_time: the event… | | sortOrder | string | no | The sort order. This parameter takes effect only when sortBy is specified. Valid values: ASC and DESC (case-insensitive) | ### Queries the precise object type follows of a digital employee by page `POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/list-operating-object-favorites` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://winnexo.cn-hangzhou.aliyuncs.com | | tenantId | string | no | The tenant ID to take effect | | graphName | string | yes | The graph name. Call listGraphs to retrieve available graphs | | operatingObjectName | string | yes | The digital employee name (operating object name). Optional | | objectType | string | yes | The object type, such as customer. This parameter has a value when type is set to mention | | pageSize | integer | no | The page size | | nextToken | string | no | The pagination cursor | …and 94 more. See the OpenAPI spec. ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/add-user-group-members" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud WinNexo API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-winnexo/add-user-group-members with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud WinNexo API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud WinNexo itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud WinNexo 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-winnexo. ### What is the status of the Alibaba Cloud WinNexo API? Needs your own provider key (bring your own key)