opensource/dify
3
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-09-24 23:22:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor(api): migrate workspace tool endpoints to BaseModel (#37959)

Browse Source
This commit is contained in:
chariri
2026-07-08 09:56:04 +00:00
committed by GitHub
parent af5b08ac5c
commit 74f177efe6
14 changed files with 2632 additions and 1176 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/openapi/markdown/console-openapi.md
+327 -117
View File
@@ -7460,9 +7460,9 @@ Get instruction generation template
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 302 | Redirect to console OAuth callback page | **application/json**: [RedirectResponse](#redirectresponse)<br> |
| Code | Description |
| ---- | ----------- |
| 302 | Redirect to OAuth callback page |
### [GET] /notification
Return the active in-product notification for the current user in their interface language (falls back to English if unavailable). The notification is NOT marked as seen here; call POST /notification/dismiss when the user explicitly closes the modal.
@@ -7667,7 +7667,7 @@ Initiate OAuth login process
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Authorization URL retrieved successfully | **application/json**: [PluginOAuthAuthorizationUrlResponse](#pluginoauthauthorizationurlresponse)<br> |
| 200 | Tool OAuth authorization URL generated successfully | **application/json**: [PluginOAuthAuthorizationUrlResponse](#pluginoauthauthorizationurlresponse)<br> |
### [GET] /oauth/plugin/{provider}/tool/callback
#### Parameters
@@ -7678,9 +7678,9 @@ Initiate OAuth login process
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 302 | Redirect to console OAuth callback page | **application/json**: [RedirectResponse](#redirectresponse)<br> |
| Code | Description |
| ---- | ----------- |
| 302 | Redirect to OAuth callback page |
### [GET] /oauth/plugin/{provider}/trigger/callback
**Handle OAuth callback for trigger provider**
@@ -7693,9 +7693,9 @@ Initiate OAuth login process
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 302 | Redirect to console OAuth callback page | **application/json**: [RedirectResponse](#redirectresponse)<br> |
| Code | Description |
| ---- | ----------- |
| 302 | Redirect to OAuth callback page |
### [POST] /oauth/provider
#### Request Body
@@ -11660,7 +11660,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Tool labels retrieved successfully | **application/json**: [ToolLabelListResponse](#toollabellistresponse)<br> |
### [POST] /workspaces/current/tool-provider/api/add
#### Request Body
@@ -11673,7 +11673,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API provider added successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/tool-provider/api/delete
#### Request Body
@@ -11686,7 +11686,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API provider deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-provider/api/get
#### Parameters
@@ -11699,7 +11699,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API provider retrieved successfully | **application/json**: [ApiProviderDetailResponse](#apiproviderdetailresponse)<br> |
### [GET] /workspaces/current/tool-provider/api/remote
#### Parameters
@@ -11712,7 +11712,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Remote API provider schema retrieved successfully | **application/json**: [ApiProviderRemoteSchemaResponse](#apiproviderremoteschemaresponse)<br> |
### [POST] /workspaces/current/tool-provider/api/schema
#### Request Body
@@ -11725,7 +11725,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API schema parsed successfully | **application/json**: [ApiSchemaParseResponse](#apischemaparseresponse)<br> |
### [POST] /workspaces/current/tool-provider/api/test/pre
#### Request Body
@@ -11738,7 +11738,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API tool test preview completed successfully | **application/json**: [ApiToolPreviewResponse](#apitoolpreviewresponse)<br> |
### [GET] /workspaces/current/tool-provider/api/tools
#### Parameters
@@ -11751,7 +11751,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API provider tools retrieved successfully | **application/json**: [ToolApiListResponse](#toolapilistresponse)<br> |
### [POST] /workspaces/current/tool-provider/api/update
#### Request Body
@@ -11764,7 +11764,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API provider updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/tool-provider/builtin/{provider}/add
#### Parameters
@@ -11783,7 +11783,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider added successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/credential/info
#### Parameters
@@ -11797,7 +11797,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider credential info retrieved successfully | **application/json**: [ToolProviderCredentialInfoApiEntity](#toolprovidercredentialinfoapientity)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/credential/schema/{credential_type}
#### Parameters
@@ -11811,7 +11811,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider credential schema retrieved successfully | **application/json**: [ProviderConfigListResponse](#providerconfiglistresponse)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/credentials
#### Parameters
@@ -11825,7 +11825,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider credentials retrieved successfully | **application/json**: [ToolProviderCredentialListResponse](#toolprovidercredentiallistresponse)<br> |
### [POST] /workspaces/current/tool-provider/builtin/{provider}/default-credential
#### Parameters
@@ -11844,7 +11844,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Default credential set successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/tool-provider/builtin/{provider}/delete
#### Parameters
@@ -11863,7 +11863,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider credential deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/icon
#### Parameters
@@ -11874,9 +11874,9 @@ Returns permission flags that control workspace features like member invitations
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [BinaryFileResponse](#binaryfileresponse)<br> |
| Code | Description |
| ---- | ----------- |
| 200 | Builtin provider icon |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/info
#### Parameters
@@ -11889,7 +11889,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider info retrieved successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/client-schema
#### Parameters
@@ -11902,7 +11902,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolOAuthClientSchemaResponse](#tooloauthclientschemaresponse)<br> |
| 200 | Builtin provider OAuth client schema retrieved successfully | **application/json**: [BuiltinProviderOAuthClientSchemaResponse](#builtinprovideroauthclientschemaresponse)<br> |
### [DELETE] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
#### Parameters
@@ -11915,7 +11915,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 200 | Custom OAuth client deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
#### Parameters
@@ -11926,9 +11926,9 @@ Returns permission flags that control workspace features like member invitations
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolOAuthCustomClientResponse](#tooloauthcustomclientresponse)<br> |
| Code | Description |
| ---- | ----------- |
| 200 | Custom OAuth client retrieved successfully |
### [POST] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
#### Parameters
@@ -11947,7 +11947,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 200 | Custom OAuth client saved successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-provider/builtin/{provider}/tools
#### Parameters
@@ -11960,7 +11960,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider tools retrieved successfully | **application/json**: [ToolApiListResponse](#toolapilistresponse)<br> |
### [POST] /workspaces/current/tool-provider/builtin/{provider}/update
#### Parameters
@@ -11979,7 +11979,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin provider updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [DELETE] /workspaces/current/tool-provider/mcp
#### Request Body
@@ -12005,7 +12005,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | MCP provider created successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
### [PUT] /workspaces/current/tool-provider/mcp
#### Request Body
@@ -12018,7 +12018,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 200 | MCP provider updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/tool-provider/mcp/auth
#### Request Body
@@ -12031,7 +12031,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | MCP provider authorized successfully | **application/json**: [MCPAuthResponse](#mcpauthresponse)<br> |
### [GET] /workspaces/current/tool-provider/mcp/tools/{provider_id}
#### Parameters
@@ -12044,7 +12044,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | MCP provider retrieved successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
### [GET] /workspaces/current/tool-provider/mcp/update/{provider_id}
#### Parameters
@@ -12057,7 +12057,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | MCP provider tools refreshed successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
### [POST] /workspaces/current/tool-provider/workflow/create
#### Request Body
@@ -12070,7 +12070,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Workflow tool created successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/tool-provider/workflow/delete
#### Request Body
@@ -12083,7 +12083,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Workflow tool deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-provider/workflow/get
#### Parameters
@@ -12097,7 +12097,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Workflow tool retrieved successfully | **application/json**: [WorkflowToolDetailResponse](#workflowtooldetailresponse)<br> |
### [GET] /workspaces/current/tool-provider/workflow/tools
#### Parameters
@@ -12110,7 +12110,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Workflow provider tools retrieved successfully | **application/json**: [ToolApiListResponse](#toolapilistresponse)<br> |
### [POST] /workspaces/current/tool-provider/workflow/update
#### Request Body
@@ -12123,7 +12123,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Workflow tool updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/tool-providers
#### Parameters
@@ -12136,35 +12136,35 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Tool providers retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
### [GET] /workspaces/current/tools/api
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | API tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
### [GET] /workspaces/current/tools/builtin
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Builtin tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
### [GET] /workspaces/current/tools/mcp
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | MCP tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
### [GET] /workspaces/current/tools/workflow
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ToolProviderOpaqueResponse](#toolprovideropaqueresponse)<br> |
| 200 | Workflow tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
### [GET] /workspaces/current/trigger-provider/{provider}/icon
#### Parameters
@@ -12175,9 +12175,9 @@ Returns permission flags that control workspace features like member invitations
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [BinaryFileResponse](#binaryfileresponse)<br> |
| Code | Description |
| ---- | ----------- |
| 200 | Trigger provider icon |
### [GET] /workspaces/current/trigger-provider/{provider}/info
**Get info for a trigger provider**
@@ -12192,7 +12192,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerProviderApiEntity](#triggerproviderapientity)<br> |
| 200 | Trigger provider retrieved successfully | **application/json**: [TriggerProviderApiEntity](#triggerproviderapientity)<br> |
### [DELETE] /workspaces/current/trigger-provider/{provider}/oauth/client
**Remove custom OAuth client configuration**
@@ -12207,7 +12207,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 200 | Trigger OAuth client deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/trigger-provider/{provider}/oauth/client
**Get OAuth client configuration for a provider**
@@ -12222,7 +12222,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerOAuthClientResponse](#triggeroauthclientresponse)<br> |
| 200 | Trigger OAuth client retrieved successfully | **application/json**: [TriggerOAuthClientResponse](#triggeroauthclientresponse)<br> |
### [POST] /workspaces/current/trigger-provider/{provider}/oauth/client
**Configure custom OAuth client for a provider**
@@ -12243,7 +12243,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 200 | Trigger OAuth client saved successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/build/{subscription_builder_id}
**Build a subscription instance for a trigger provider**
@@ -12265,7 +12265,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerProviderOpaqueResponse](#triggerprovideropaqueresponse)<br> |
| 200 | Trigger subscription builder built successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/create
**Add a new subscription instance for a trigger provider**
@@ -12286,7 +12286,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerSubscriptionBuilderCreateResponse](#triggersubscriptionbuildercreateresponse)<br> |
| 200 | Trigger subscription builder created successfully | **application/json**: [TriggerSubscriptionBuilderCreateResponse](#triggersubscriptionbuildercreateresponse)<br> |
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/logs/{subscription_builder_id}
**Get the request logs for a subscription instance for a trigger provider**
@@ -12302,7 +12302,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerSubscriptionBuilderLogsResponse](#triggersubscriptionbuilderlogsresponse)<br> |
| 200 | Trigger subscription builder logs retrieved successfully | **application/json**: [TriggerSubscriptionBuilderLogsResponse](#triggersubscriptionbuilderlogsresponse)<br> |
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/update/{subscription_builder_id}
**Update a subscription instance for a trigger provider**
@@ -12324,7 +12324,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity)<br> |
| 200 | Trigger subscription builder updated successfully | **application/json**: [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity)<br> |
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/verify-and-update/{subscription_builder_id}
**Verify and update a subscription instance for a trigger provider**
@@ -12346,7 +12346,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerSubscriptionBuilderVerifyResponse](#triggersubscriptionbuilderverifyresponse)<br> |
| 200 | Trigger subscription builder verified successfully | **application/json**: [TriggerVerificationResponse](#triggerverificationresponse)<br> |
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/{subscription_builder_id}
**Get a subscription instance for a trigger provider**
@@ -12362,7 +12362,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity)<br> |
| 200 | Trigger subscription builder retrieved successfully | **application/json**: [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity)<br> |
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/list
**List all trigger subscriptions for the current tenant's provider**
@@ -12377,7 +12377,8 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerSubscriptionListResponse](#triggersubscriptionlistresponse)<br> |
| 200 | Trigger subscriptions retrieved successfully | **application/json**: [TriggerProviderSubscriptionListResponse](#triggerprovidersubscriptionlistresponse)<br> |
| 404 | Trigger provider not found | **application/json**: [TriggerProviderErrorResponse](#triggerprovidererrorresponse)<br> |
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/oauth/authorize
**Initiate OAuth authorization flow for a trigger provider**
@@ -12392,7 +12393,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Authorization URL retrieved successfully | **application/json**: [TriggerOAuthAuthorizeResponse](#triggeroauthauthorizeresponse)<br> |
| 200 | Trigger OAuth authorization URL generated successfully | **application/json**: [TriggerOAuthAuthorizeResponse](#triggeroauthauthorizeresponse)<br> |
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/verify/{subscription_id}
**Verify credentials for an existing subscription (edit mode only)**
@@ -12414,7 +12415,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerSubscriptionBuilderVerifyResponse](#triggersubscriptionbuilderverifyresponse)<br> |
| 200 | Trigger subscription verified successfully | **application/json**: [TriggerVerificationResponse](#triggerverificationresponse)<br> |
### [POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/delete
**Delete a subscription instance**
@@ -12450,7 +12451,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerProviderOpaqueResponse](#triggerprovideropaqueresponse)<br> |
| 200 | Trigger subscription updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/triggers
**List all trigger providers for the current tenant**
@@ -12459,7 +12460,7 @@ Returns permission flags that control workspace features like member invitations
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TriggerProviderListResponse](#triggerproviderlistresponse)<br> |
| 200 | Trigger providers retrieved successfully | **application/json**: [TriggerProviderListResponse](#triggerproviderlistresponse)<br> |
### [POST] /workspaces/custom-config
#### Request Body
@@ -14872,6 +14873,26 @@ Legacy Chat App model config used only for follow-up question generation.
| ---- | ---- | ----------- | -------- |
| data | [ [ApiKeyItem](#apikeyitem) ] | | Yes |
#### ApiProviderDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object | | No |
| custom_disclaimer | string | | No |
| description | string | | No |
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
| labels | [ string ] | | No |
| privacy_policy | string | | No |
| schema | string | | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
| tools | [ [ApiToolBundle](#apitoolbundle) ] | | Yes |
#### ApiProviderRemoteSchemaResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| schema | string | | Yes |
#### ApiProviderSchemaType
Enum class for api provider schema type.
@@ -14880,13 +14901,52 @@ Enum class for api provider schema type.
| ---- | ---- | ----------- | -------- |
| ApiProviderSchemaType | string | Enum class for api provider schema type. | |
#### ApiSchemaParseResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
| parameters_schema | [ [ApiToolBundle](#apitoolbundle) ] | | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
| warning | object | | Yes |
#### ApiToolBundle
This class is used to store the schema information of an api based tool.
such as the url, the method, the parameters, etc.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| author | string | | Yes |
| icon | string | | No |
| method | string | | Yes |
| openapi | object | | Yes |
| operation_id | string | | No |
| output_schema | object | | No |
| parameters | [ [ToolParameter](#toolparameter) ] | | No |
| server_url | string | | Yes |
| summary | string | | No |
#### ApiToolPreviewResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ApiToolPreviewResponse | | | |
#### ApiToolPreviewResult
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| error | string | | No |
| result | string | | No |
#### ApiToolProviderAddPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
| custom_disclaimer | string | | No |
| icon | object | | Yes |
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
| labels | [ string ] | | No |
| privacy_policy | string | | No |
| provider | string | | Yes |
@@ -14905,7 +14965,7 @@ Enum class for api provider schema type.
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
| custom_disclaimer | string | | No |
| icon | object | | Yes |
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
| labels | [ string ] | | No |
| original_provider | string | | Yes |
| privacy_policy | string | | No |
@@ -15381,6 +15441,16 @@ Retrieval settings for Amazon Bedrock knowledge base queries.
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
#### BuiltinProviderOAuthClientSchemaResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| client_params | object | | No |
| is_oauth_custom_client_enabled | boolean | | Yes |
| is_system_oauth_params_exists | boolean | | Yes |
| redirect_uri | string | | Yes |
| schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
#### BuiltinToolAddPayload
| Name | Type | Description | Required |
@@ -18350,6 +18420,20 @@ Enum class for large language model mode.
| authorization_code | string | | No |
| provider_id | string | | Yes |
#### MCPAuthResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authorization_url | string | | No |
| result | string | | No |
#### MCPAuthentication
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| client_id | string | | Yes |
| client_secret | string | | No |
#### MCPCallbackQuery
| Name | Type | Description | Required |
@@ -18357,12 +18441,19 @@ Enum class for large language model mode.
| code | string | | Yes |
| state | string | | Yes |
#### MCPConfiguration
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| sse_read_timeout | number, <br>**Default:** 300 | | No |
| timeout | number, <br>**Default:** 30 | | No |
#### MCPProviderCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authentication | object | | No |
| configuration | object | | No |
| authentication | [MCPAuthentication](#mcpauthentication) | | No |
| configuration | [MCPConfiguration](#mcpconfiguration) | | No |
| headers | object | | No |
| icon | string | | Yes |
| icon_background | string | | No |
@@ -18382,8 +18473,8 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authentication | object | | No |
| configuration | object | | No |
| authentication | [MCPAuthentication](#mcpauthentication) | | No |
| configuration | [MCPConfiguration](#mcpconfiguration) | | No |
| headers | object | | No |
| icon | string | | Yes |
| icon_background | string | | No |
@@ -19945,6 +20036,12 @@ Model class for common provider settings like credentials
| type | [ProviderConfigType](#providerconfigtype) | The type of the credentials | Yes |
| url | string | | No |
#### ProviderConfigListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProviderConfigListResponse | array | | |
#### ProviderConfigType
| Name | Type | Description | Required |
@@ -21455,11 +21552,46 @@ Available voices
| ---- | ---- | ----------- | -------- |
| data | [ [TokensPerSecondStatisticItem](#tokenspersecondstatisticitem) ] | | Yes |
#### ToolOAuthClientSchemaResponse
#### ToolApiEntity
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolOAuthClientSchemaResponse | array | | |
| author | string | | Yes |
| description | [I18nObject](#i18nobject) | | Yes |
| label | [I18nObject](#i18nobject) | | Yes |
| labels | [ string ] | | No |
| name | string | | Yes |
| output_schema | object | | No |
| parameters | [ [ToolParameter](#toolparameter) ] | | No |
#### ToolApiListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolApiListResponse | array | | |
#### ToolEmojiIcon
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| background | string | | Yes |
| content | string | | Yes |
#### ToolLabel
Tool label
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string | The icon of the tool | Yes |
| label | [I18nObject](#i18nobject) | The label of the tool | Yes |
| name | string | The name of the tool | Yes |
#### ToolLabelListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolLabelListResponse | array | | |
#### ToolOAuthCustomClientPayload
@@ -21468,11 +21600,29 @@ Available voices
| client_params | object | | No |
| enable_oauth_custom_client | boolean | | No |
#### ToolOAuthCustomClientResponse
#### ToolParameter
Overrides type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolOAuthCustomClientResponse | object | | |
| auto_generate | [PluginParameterAutoGenerate](#pluginparameterautogenerate) | | No |
| default | number<br>integer<br>string<br>boolean<br>[ object ]<br>object | | No |
| form | [ToolParameterForm](#toolparameterform) | The form of the parameter, schema/form/llm | Yes |
| human_description | [I18nObject](#i18nobject) | The description presented to the user | No |
| input_schema | object | | No |
| label | [I18nObject](#i18nobject) | The label presented to the user | Yes |
| llm_description | string | | No |
| max | number<br>integer | | No |
| min | number<br>integer | | No |
| name | string | The name of the parameter | Yes |
| options | [ [PluginParameterOption](#pluginparameteroption) ] | | No |
| placeholder | [I18nObject](#i18nobject) | The placeholder presented to the user | No |
| precision | integer | | No |
| required | boolean | | No |
| scope | string | | No |
| template | [PluginParameterTemplate](#pluginparametertemplate) | | No |
| type | [ToolParameterType](#toolparametertype) | The type of the parameter | Yes |
#### ToolParameterForm
@@ -21480,17 +21630,84 @@ Available voices
| ---- | ---- | ----------- | -------- |
| ToolParameterForm | string | | |
#### ToolParameterType
removes TOOLS_SELECTOR from PluginParameterType
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolParameterType | string | removes TOOLS_SELECTOR from PluginParameterType | |
#### ToolProviderApiEntityResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_delete | boolean, <br>**Default:** true | | No |
| authentication | [MCPAuthentication](#mcpauthentication) | The OAuth config of the MCP tool | No |
| author | string | | Yes |
| configuration | [MCPConfiguration](#mcpconfiguration) | The timeout and sse_read_timeout of the MCP tool | No |
| description | [I18nObject](#i18nobject) | | Yes |
| icon | string<br>object | | Yes |
| icon_dark | string<br>object | | No |
| id | string | | Yes |
| identity_mode | string, <br>**Default:** off | Identity-forwarding mechanism: 'off' or 'idp_token' | No |
| is_dynamic_registration | boolean, <br>**Default:** true | Whether the MCP tool is dynamically registered | No |
| is_team_authorization | boolean | | No |
| label | [I18nObject](#i18nobject) | | Yes |
| labels | [ string ] | | No |
| masked_headers | object | The masked headers of the MCP tool | No |
| name | string | | Yes |
| original_headers | object | The original headers of the MCP tool | No |
| plugin_id | string | The plugin id of the tool | No |
| plugin_unique_identifier | string | The unique identifier of the tool | No |
| server_identifier | string | The server identifier of the MCP tool | No |
| server_url | string | The server url of the tool | No |
| team_credentials | object | | No |
| tools | [ [ToolApiEntity](#toolapientity) ] | | No |
| type | [ToolProviderType](#toolprovidertype) | | Yes |
| updated_at | integer | | No |
| workflow_app_id | string | The app id of the workflow tool | No |
#### ToolProviderCredentialApiEntity
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_by | string | User ID of the credential creator | No |
| credential_type | [CredentialType](#credentialtype) | The type of the credential | Yes |
| credentials | object | The credentials of the provider | No |
| from_other_member | boolean | True when this credential is being returned only because a workflow/agent node still references it but it would normally be hidden from this user by the visibility filter (another member's only_me credential). The frontend renders it as 'borrowed' — selectable until the node switches away, but not editable/deletable. | No |
| id | string | The unique id of the credential | Yes |
| is_default | boolean | Whether the credential is the default credential for the provider in the workspace | No |
| name | string | The name of the credential | Yes |
| partial_member_list | [ string ] | List of user IDs allowed when visibility is partial_members | No |
| provider | string | The provider of the credential | Yes |
| visibility | string, <br>**Default:** all_team_members | Credential visibility: only_me, all_team_members, or partial_members | No |
#### ToolProviderCredentialInfoApiEntity
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | [ [ToolProviderCredentialApiEntity](#toolprovidercredentialapientity) ] | The credentials of the provider | Yes |
| is_oauth_custom_client_enabled | boolean | Whether the OAuth custom client is enabled for the provider | No |
| supported_credential_types | [ [CredentialType](#credentialtype) ] | The supported credential types of the provider | Yes |
#### ToolProviderCredentialListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolProviderCredentialListResponse | array | | |
#### ToolProviderListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string | | No |
#### ToolProviderOpaqueResponse
#### ToolProviderListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolProviderOpaqueResponse | | | |
| ToolProviderListResponse | array | | |
#### ToolProviderType
@@ -21771,7 +21988,7 @@ Enum class for tool provider
| configured | boolean | | Yes |
| custom_configured | boolean | | Yes |
| custom_enabled | boolean | | Yes |
| oauth_client_schema | [ [TriggerProviderConfigResponse](#triggerproviderconfigresponse) ] | | Yes |
| oauth_client_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
| params | object | | Yes |
| redirect_uri | string | | Yes |
| system_configured | boolean | | Yes |
@@ -21794,28 +22011,11 @@ Enum class for tool provider
| supported_creation_methods | [ [TriggerCreationMethod](#triggercreationmethod) ] | Supported creation methods for the trigger provider. like 'OAUTH', 'APIKEY', 'MANUAL'. | No |
| tags | [ string ] | The tags of the trigger provider | No |
#### TriggerProviderConfigOptionResponse
#### TriggerProviderErrorResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| label | [I18nObject](#i18nobject) | The label of the option | Yes |
| value | string | The value of the option | Yes |
#### TriggerProviderConfigResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default | integer<br>string<br>number<br>boolean | | No |
| help | [I18nObject](#i18nobject) | | No |
| label | [I18nObject](#i18nobject) | | No |
| multiple | boolean | | No |
| name | string | The name of the credentials | Yes |
| options | [ [TriggerProviderConfigOptionResponse](#triggerproviderconfigoptionresponse) ] | | No |
| placeholder | [I18nObject](#i18nobject) | | No |
| required | boolean | | No |
| scope | [AppSelectorScope](#appselectorscope)<br>[ModelSelectorScope](#modelselectorscope)<br>[ToolSelectorScope](#toolselectorscope) | | No |
| type | string, <br>**Available values:** "app-selector", "array[tools]", "boolean", "model-selector", "secret-input", "select", "text-input" | The type of the credentials<br>*Enum:* `"app-selector"`, `"array[tools]"`, `"boolean"`, `"model-selector"`, `"secret-input"`, `"select"`, `"text-input"` | Yes |
| url | string | | No |
| error | string | | Yes |
#### TriggerProviderListResponse
@@ -21823,12 +22023,6 @@ Enum class for tool provider
| ---- | ---- | ----------- | -------- |
| TriggerProviderListResponse | array | | |
#### TriggerProviderOpaqueResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TriggerProviderOpaqueResponse | | | |
#### TriggerProviderSubscriptionApiEntity
| Name | Type | Description | Required |
@@ -21843,6 +22037,12 @@ Enum class for tool provider
| provider | string | The provider id of the subscription | Yes |
| workflows_in_use | integer | The number of workflows using this subscription | Yes |
#### TriggerProviderSubscriptionListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TriggerProviderSubscriptionListResponse | array | | |
#### TriggerSubscriptionBuilderCreatePayload
| Name | Type | Description | Required |
@@ -21876,18 +22076,12 @@ Enum class for tool provider
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
#### TriggerSubscriptionBuilderVerifyResponse
#### TriggerVerificationResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| verified | boolean | | Yes |
#### TriggerSubscriptionListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TriggerSubscriptionListResponse | array | | |
#### UnaddedModelConfiguration
Model class for provider unadded model configuration.
@@ -22938,7 +23132,7 @@ Query parameters for workflow runs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | Yes |
| icon | object | | Yes |
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
| label | string | | Yes |
| labels | [ string ] | | No |
| name | string | | Yes |
@@ -22952,6 +23146,22 @@ Query parameters for workflow runs.
| ---- | ---- | ----------- | -------- |
| workflow_tool_id | string | | Yes |
#### WorkflowToolDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | Yes |
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
| label | string | | Yes |
| name | string | | Yes |
| output_schema | object | | No |
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] | | Yes |
| privacy_policy | string | | No |
| synced | boolean | | Yes |
| tool | [ToolApiEntity](#toolapientity) | | Yes |
| workflow_app_id | string | | Yes |
| workflow_tool_id | string | | Yes |
#### WorkflowToolGetQuery
| Name | Type | Description | Required |
@@ -22980,7 +23190,7 @@ Workflow tool configuration
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | Yes |
| icon | object | | Yes |
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
| label | string | | Yes |
| labels | [ string ] | | No |
| name | string | | Yes |