dify/api/openapi/markdown/console-openapi.md

# Console API
Console management APIs for app configuration, monitoring, and administration

## Version: 1.0

### Available authorizations
#### Bearer (API Key Authentication)
Type: Bearer {your-api-key}  
**Name:** Authorization  
**In:** header  

---
## console
Console management API operations

### [GET] /account/avatar
Get account avatar url

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| avatar | query | Avatar file ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AvatarUrlResponse](#avatarurlresponse)<br> |

### [POST] /account/avatar
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountAvatarPayload](#accountavatarpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /account/change-email
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChangeEmailSendPayload](#changeemailsendpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |

### [POST] /account/change-email/check-email-unique
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CheckEmailUniquePayload](#checkemailuniquepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /account/change-email/reset
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChangeEmailResetPayload](#changeemailresetpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /account/change-email/validity
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChangeEmailValidityPayload](#changeemailvaliditypayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [VerificationTokenResponse](#verificationtokenresponse)<br> |

### [POST] /account/delete
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountDeletePayload](#accountdeletepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /account/delete/feedback
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountDeletionFeedbackPayload](#accountdeletionfeedbackpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /account/delete/verify
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |

### [GET] /account/education
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [EducationStatusResponse](#educationstatusresponse)<br> |

### [POST] /account/education
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EducationActivatePayload](#educationactivatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /account/education/autocomplete
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| keywords | query |  | Yes | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [EducationAutocompleteResponse](#educationautocompleteresponse)<br> |

### [GET] /account/education/verify
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [EducationVerifyResponse](#educationverifyresponse)<br> |

### [POST] /account/init
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountInitPayload](#accountinitpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /account/integrates
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AccountIntegrateListResponse](#accountintegratelistresponse)<br> |

### [POST] /account/interface-language
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountInterfaceLanguagePayload](#accountinterfacelanguagepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /account/interface-theme
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountInterfaceThemePayload](#accountinterfacethemepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /account/name
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountNamePayload](#accountnamepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /account/password
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountPasswordPayload](#accountpasswordpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [GET] /account/profile
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /account/timezone
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AccountTimezonePayload](#accounttimezonepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [Account](#account)<br> |

### [POST] /activate
Activate account with invitation token

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ActivatePayload](#activatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Account activated successfully | **application/json**: [ActivationResponse](#activationresponse)<br> |
| 400 | Already activated or invalid token |  |

### [GET] /activate/check
Check if activation token is valid

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| email | query |  | No | string |
| token | query |  | Yes | string |
| workspace_id | query |  | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ActivationCheckResponse](#activationcheckresponse)<br> |

### [GET] /agents
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| keyword | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent roster list | **application/json**: [AgentRosterListResponse](#agentrosterlistresponse)<br> |

### [POST] /agents
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RosterAgentCreatePayload](#rosteragentcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Agent created | **application/json**: [AgentRosterResponse](#agentrosterresponse)<br> |

### [GET] /agents/invite-options
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | query | Workflow app id for in-current-workflow markers | No | string |
| keyword | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent invite options | **application/json**: [AgentInviteOptionsResponse](#agentinviteoptionsresponse)<br> |

### [DELETE] /agents/{agent_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| agent_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Agent archived |

### [GET] /agents/{agent_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| agent_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent detail | **application/json**: [AgentRosterResponse](#agentrosterresponse)<br> |

### [PATCH] /agents/{agent_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| agent_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RosterAgentUpdatePayload](#rosteragentupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent updated | **application/json**: [AgentRosterResponse](#agentrosterresponse)<br> |

### [GET] /agents/{agent_id}/versions
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| agent_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent versions | **application/json**: [AgentConfigSnapshotListResponse](#agentconfigsnapshotlistresponse)<br> |

### [GET] /agents/{agent_id}/versions/{version_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| agent_id | path |  | Yes | string |
| version_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent version detail | **application/json**: [AgentConfigSnapshotDetailResponse](#agentconfigsnapshotdetailresponse)<br> |

### [GET] /all-workspaces
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /api-based-extension
Get all API-based extensions for current tenant

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [APIBasedExtensionListResponse](#apibasedextensionlistresponse)<br> |

### [POST] /api-based-extension
Create a new API-based extension

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [APIBasedExtensionPayload](#apibasedextensionpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Extension created successfully | **application/json**: [APIBasedExtensionResponse](#apibasedextensionresponse)<br> |

### [DELETE] /api-based-extension/{id}
Delete API-based extension

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| id | path | Extension ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Extension deleted successfully |

### [GET] /api-based-extension/{id}
Get API-based extension by ID

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| id | path | Extension ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [APIBasedExtensionResponse](#apibasedextensionresponse)<br> |

### [POST] /api-based-extension/{id}
Update API-based extension

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| id | path | Extension ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [APIBasedExtensionPayload](#apibasedextensionpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Extension updated successfully | **application/json**: [APIBasedExtensionResponse](#apibasedextensionresponse)<br> |

### [GET] /api-key-auth/data-source
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ApiKeyAuthDataSourceListResponse](#apikeyauthdatasourcelistresponse)<br> |

### [POST] /api-key-auth/data-source/binding
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ApiKeyAuthBindingPayload](#apikeyauthbindingpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /api-key-auth/data-source/{binding_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| binding_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Binding deleted successfully |

### [GET] /app-dsl-version
**Get current app DSL version for workflow clipboard compatibility**

Get current app DSL version

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AppDslVersionResponse](#appdslversionresponse)<br> |

### [GET] /app/prompt-templates
Get advanced prompt templates based on app mode and model configuration

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_mode | query | Application mode | Yes | string |
| has_context | query | Whether has context | No | string, <br>**Default:** true |
| model_mode | query | Model mode | Yes | string |
| model_name | query | Model name | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Prompt templates retrieved successfully | **application/json**: [ object ]<br> |
| 400 | Invalid request parameters |  |

### [GET] /apps
**Get app list**

Get list of applications with pagination and filtering

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| creator_ids | query | Filter by creator account IDs | No | [ string ] |
| is_created_by_me | query | Filter by creator | No | boolean |
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
| mode | query | App mode filter | No | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all |
| name | query | Filter by app name | No | string |
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
| tag_ids | query | Filter by tag IDs | No | [ string ] |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AppPagination](#apppagination)<br> |

### [POST] /apps
**Create app**

Create a new application

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CreateAppPayload](#createapppayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | App created successfully | **application/json**: [AppDetail](#appdetail)<br> |
| 400 | Invalid request parameters |  |
| 403 | Insufficient permissions |  |

### [POST] /apps/imports
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppImportPayload](#appimportpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import completed | **application/json**: [Import](#import)<br> |
| 202 | Import pending confirmation | **application/json**: [Import](#import)<br> |
| 400 | Import failed | **application/json**: [Import](#import)<br> |

### [GET] /apps/imports/{app_id}/check-dependencies
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dependencies checked | **application/json**: [CheckDependenciesResult](#checkdependenciesresult)<br> |

### [POST] /apps/imports/{import_id}/confirm
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| import_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import confirmed | **application/json**: [Import](#import)<br> |
| 400 | Import failed | **application/json**: [Import](#import)<br> |

### [POST] /apps/workflows/online-users
Get workflow online users

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowOnlineUsersPayload](#workflowonlineuserspayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow online users retrieved successfully | **application/json**: [WorkflowOnlineUsersResponse](#workflowonlineusersresponse)<br> |

### [DELETE] /apps/{app_id}
**Delete app**

Delete application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | App deleted successfully |
| 403 | Insufficient permissions |

### [GET] /apps/{app_id}
**Get app detail**

Get application details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |

### [PUT] /apps/{app_id}
**Update app**

Update application details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [UpdateAppPayload](#updateapppayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | App updated successfully | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
| 400 | Invalid request parameters |  |
| 403 | Insufficient permissions |  |

### [GET] /apps/{app_id}/advanced-chat/workflow-runs
**Get advanced chat app workflow run list**

Get advanced chat workflow run list

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| last_id | query | Last run ID for pagination | No | string |
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs retrieved successfully | **application/json**: [AdvancedChatWorkflowRunPaginationResponse](#advancedchatworkflowrunpaginationresponse)<br> |

### [GET] /apps/{app_id}/advanced-chat/workflow-runs/count
**Get advanced chat workflow runs count statistics**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| time_range | query | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No | string |
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs count retrieved successfully | **application/json**: [WorkflowRunCountResponse](#workflowruncountresponse)<br> |

### [POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/preview
**Preview human input form content and placeholders**

Get human input form preview for advanced chat workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HumanInputFormPreviewPayload](#humaninputformpreviewpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/run
**Submit human input form preview**

Submit human input form preview for advanced chat workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HumanInputFormSubmitPayload](#humaninputformsubmitpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /apps/{app_id}/advanced-chat/workflows/draft/iteration/nodes/{node_id}/run
**Run draft workflow iteration node**

Run draft workflow iteration node for advanced chat

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [IterationNodeRunPayload](#iterationnoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Iteration node run started successfully |
| 403 | Permission denied |
| 404 | Node not found |

### [POST] /apps/{app_id}/advanced-chat/workflows/draft/loop/nodes/{node_id}/run
**Run draft workflow loop node**

Run draft workflow loop node for advanced chat

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [LoopNodeRunPayload](#loopnoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Loop node run started successfully |
| 403 | Permission denied |
| 404 | Node not found |

### [POST] /apps/{app_id}/advanced-chat/workflows/draft/run
**Run draft workflow**

Run draft workflow for advanced chat application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AdvancedChatWorkflowRunPayload](#advancedchatworkflowrunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow run started successfully |
| 400 | Invalid request parameters |
| 403 | Permission denied |

### [GET] /apps/{app_id}/agent-composer
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer state | **application/json**: [AgentAppComposerResponse](#agentappcomposerresponse)<br> |

### [PUT] /apps/{app_id}/agent-composer
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer saved | **application/json**: [AgentAppComposerResponse](#agentappcomposerresponse)<br> |

### [GET] /apps/{app_id}/agent-composer/candidates
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer candidates | **application/json**: [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse)<br> |

### [POST] /apps/{app_id}/agent-composer/validate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer validation result | **application/json**: [AgentComposerValidateResponse](#agentcomposervalidateresponse)<br> |

### [POST] /apps/{app_id}/agent-features
Update an Agent App's presentation features (opener, follow-up, citations, ...)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AgentAppFeaturesPayload](#agentappfeaturespayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Features updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 400 | Invalid configuration |  |
| 404 | App not found |  |

### [GET] /apps/{app_id}/agent-referencing-workflows
List workflow apps that reference this Agent App's bound Agent (read-only)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Referencing workflows listed successfully | **application/json**: [AgentReferencingWorkflowsResponse](#agentreferencingworkflowsresponse)<br> |
| 404 | App not found |  |

### [GET] /apps/{app_id}/agent-sandbox/files
List a directory in an Agent App conversation sandbox

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | query | Agent App conversation ID | Yes | string |
| path | query | Directory path relative to the sandbox workspace | No | string, <br>**Default:** . |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Listing returned | **application/json**: [SandboxListResponse](#sandboxlistresponse)<br> |

### [GET] /apps/{app_id}/agent-sandbox/files/read
Read a text/binary preview file in an Agent App conversation sandbox

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | query | Agent App conversation ID | Yes | string |
| path | query | File path relative to the sandbox workspace | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Preview returned | **application/json**: [SandboxReadResponse](#sandboxreadresponse)<br> |

### [POST] /apps/{app_id}/agent-sandbox/files/upload
Upload one Agent App sandbox file as a Dify ToolFile mapping

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AgentSandboxUploadPayload](#agentsandboxuploadpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Uploaded | **application/json**: [SandboxUploadResponse](#sandboxuploadresponse)<br> |

### [GET] /apps/{app_id}/agent/logs
**Get agent logs**

Get agent execution logs for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | query | Conversation UUID | Yes | string |
| message_id | query | Message UUID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent logs retrieved successfully | **application/json**: [ object ]<br> |
| 400 | Invalid request parameters |  |

### [POST] /apps/{app_id}/agent/skills/standardize
**Upload a Skill, validate it, and standardize it into the app agent's drive**

Validate + standardize a Skill into the agent drive (ENG-594)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 201 | Skill standardized into drive |
| 400 | Invalid skill package or no bound agent |

### [POST] /apps/{app_id}/agent/skills/upload
**Validate an uploaded Skill package and persist the archive**

Upload + validate a Skill package (.zip/.skill) and extract its manifest
Returns a validated skill ref (to bind into the Agent soul config on save)
plus its manifest. Standardizing into the agent drive is ENG-594.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 201 | Skill validated |
| 400 | Invalid skill package |

### [POST] /apps/{app_id}/annotation-reply/{action}
Enable or disable annotation reply for an app

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path | Action to perform (enable/disable) | Yes | string |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AnnotationReplyPayload](#annotationreplypayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Action completed successfully |
| 403 | Insufficient permissions |

### [GET] /apps/{app_id}/annotation-reply/{action}/status/{job_id}
Get status of annotation reply action job

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path | Action type | Yes | string |
| app_id | path | Application ID | Yes | string |
| job_id | path | Job ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Job status retrieved successfully |
| 403 | Insufficient permissions |

### [GET] /apps/{app_id}/annotation-setting
Get annotation settings for an app

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Annotation settings retrieved successfully |
| 403 | Insufficient permissions |

### [POST] /apps/{app_id}/annotation-settings/{annotation_setting_id}
Update annotation settings for an app

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| annotation_setting_id | path | Annotation setting ID | Yes | string |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AnnotationSettingUpdatePayload](#annotationsettingupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Settings updated successfully |
| 403 | Insufficient permissions |

### [DELETE] /apps/{app_id}/annotations
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /apps/{app_id}/annotations
Get annotations for an app with pagination

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| keyword | query | Search keyword | No | string |
| limit | query | Page size | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Annotations retrieved successfully |
| 403 | Insufficient permissions |

### [POST] /apps/{app_id}/annotations
Create a new annotation for an app

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CreateAnnotationPayload](#createannotationpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Annotation created successfully | **application/json**: [Annotation](#annotation)<br> |
| 403 | Insufficient permissions |  |

### [POST] /apps/{app_id}/annotations/batch-import
Batch import annotations from CSV file with rate limiting and security checks

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Batch import started successfully |
| 400 | No file uploaded or too many files |
| 403 | Insufficient permissions |
| 413 | File too large |
| 429 | Too many requests or concurrent imports |

### [GET] /apps/{app_id}/annotations/batch-import-status/{job_id}
Get status of batch import job

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| job_id | path | Job ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Job status retrieved successfully |
| 403 | Insufficient permissions |

### [GET] /apps/{app_id}/annotations/count
Get count of message annotations for the app

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Annotation count retrieved successfully | **application/json**: [AnnotationCountResponse](#annotationcountresponse)<br> |

### [GET] /apps/{app_id}/annotations/export
Export all annotations for an app with CSV injection protection

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Annotations exported successfully | **application/json**: [AnnotationExportList](#annotationexportlist)<br> |
| 403 | Insufficient permissions |  |

### [DELETE] /apps/{app_id}/annotations/{annotation_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| annotation_id | path |  | Yes | string |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /apps/{app_id}/annotations/{annotation_id}
Update or delete an annotation

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| annotation_id | path | Annotation ID | Yes | string |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [UpdateAnnotationPayload](#updateannotationpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Annotation updated successfully | **application/json**: [Annotation](#annotation)<br> |
| 204 | Annotation deleted successfully |  |
| 403 | Insufficient permissions |  |

### [GET] /apps/{app_id}/annotations/{annotation_id}/hit-histories
Get hit histories for an annotation

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| annotation_id | path | Annotation ID | Yes | string |
| app_id | path | Application ID | Yes | string |
| limit | query | Page size | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Hit histories retrieved successfully | **application/json**: [AnnotationHitHistoryList](#annotationhithistorylist)<br> |
| 403 | Insufficient permissions |  |

### [POST] /apps/{app_id}/api-enable
Enable or disable app API

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppApiStatusPayload](#appapistatuspayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API status updated successfully | **application/json**: [AppDetail](#appdetail)<br> |
| 403 | Insufficient permissions |  |

### [POST] /apps/{app_id}/audio-to-text
Transcript audio to text for chat messages

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | App ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Audio transcription successful | **application/json**: [AudioTranscriptResponse](#audiotranscriptresponse)<br> |
| 400 | Bad request - No audio uploaded or unsupported type |  |
| 413 | Audio file too large |  |

### [GET] /apps/{app_id}/chat-conversations
Get chat conversations with pagination, filtering and summary

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| annotation_status | query | Annotation status filter | No | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| keyword | query | Search keyword | No | string |
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |
| sort_by | query | Sort field and direction | No | string, <br>**Available values:** "-created_at", "-updated_at", "created_at", "updated_at", <br>**Default:** -updated_at |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ConversationWithSummaryPagination](#conversationwithsummarypagination)<br> |
| 403 | Insufficient permissions |  |

### [DELETE] /apps/{app_id}/chat-conversations/{conversation_id}
Delete a chat conversation

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | path | Conversation ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Conversation deleted successfully |
| 403 | Insufficient permissions |
| 404 | Conversation not found |

### [GET] /apps/{app_id}/chat-conversations/{conversation_id}
Get chat conversation details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | path | Conversation ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ConversationDetail](#conversationdetail)<br> |
| 403 | Insufficient permissions |  |
| 404 | Conversation not found |  |

### [GET] /apps/{app_id}/chat-messages
Get chat messages for a conversation with pagination

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | query | Conversation ID | Yes | string |
| first_id | query | First message ID for pagination | No | string |
| limit | query | Number of messages to return (1-100) | No | integer, <br>**Default:** 20 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [MessageInfiniteScrollPaginationResponse](#messageinfinitescrollpaginationresponse)<br> |
| 404 | Conversation not found |  |

### [GET] /apps/{app_id}/chat-messages/{message_id}/suggested-questions
Get suggested questions for a message

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| message_id | path | Message ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Suggested questions retrieved successfully | **application/json**: [SuggestedQuestionsResponse](#suggestedquestionsresponse)<br> |
| 404 | Message or conversation not found |  |

### [POST] /apps/{app_id}/chat-messages/{task_id}/stop
Stop a running chat message generation

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| task_id | path | Task ID to stop | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /apps/{app_id}/completion-conversations
Get completion conversations with pagination and filtering

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| annotation_status | query | Annotation status filter | No | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| keyword | query | Search keyword | No | string |
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ConversationPagination](#conversationpagination)<br> |
| 403 | Insufficient permissions |  |

### [DELETE] /apps/{app_id}/completion-conversations/{conversation_id}
Delete a completion conversation

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | path | Conversation ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Conversation deleted successfully |
| 403 | Insufficient permissions |
| 404 | Conversation not found |

### [GET] /apps/{app_id}/completion-conversations/{conversation_id}
Get completion conversation details with messages

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | path | Conversation ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ConversationMessageDetail](#conversationmessagedetail)<br> |
| 403 | Insufficient permissions |  |
| 404 | Conversation not found |  |

### [POST] /apps/{app_id}/completion-messages
Generate completion message for debugging

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CompletionMessagePayload](#completionmessagepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Completion generated successfully |
| 400 | Invalid request parameters |
| 404 | App not found |

### [POST] /apps/{app_id}/completion-messages/{task_id}/stop
Stop a running completion message generation

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| task_id | path | Task ID to stop | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /apps/{app_id}/conversation-variables
Get conversation variables for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| conversation_id | query | Conversation ID to filter variables | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Conversation variables retrieved successfully | **application/json**: [PaginatedConversationVariableResponse](#paginatedconversationvariableresponse)<br> |

### [POST] /apps/{app_id}/convert-to-workflow
**Convert basic mode of chatbot app to workflow mode**

Convert application to workflow mode
Convert expert mode of chatbot app to workflow mode
Convert Completion App to Workflow App

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ConvertToWorkflowPayload](#converttoworkflowpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Application converted to workflow successfully | **application/json**: [NewAppResponse](#newappresponse)<br> |
| 400 | Application cannot be converted |  |
| 403 | Permission denied |  |

### [POST] /apps/{app_id}/copy
**Copy app**

Create a copy of an existing application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID to copy | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CopyAppPayload](#copyapppayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | App copied successfully | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
| 403 | Insufficient permissions |  |

### [GET] /apps/{app_id}/export
**Export app**

Export application configuration as DSL

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID to export | Yes | string |
| include_secret | query | Include secrets in export | No | boolean |
| workflow_id | query | Specific workflow ID to export | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | App exported successfully | **application/json**: [AppExportResponse](#appexportresponse)<br> |
| 403 | Insufficient permissions |  |

### [POST] /apps/{app_id}/feedbacks
Create or update message feedback (like/dislike)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MessageFeedbackPayload](#messagefeedbackpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Feedback updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 403 | Insufficient permissions |  |
| 404 | Message not found |  |

### [GET] /apps/{app_id}/feedbacks/export
Export user feedback data for Google Sheets

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end_date | query | End date (YYYY-MM-DD) | No | string |
| format | query | Export format | No | string, <br>**Available values:** "csv", "json", <br>**Default:** csv |
| from_source | query | Filter by feedback source | No | string, <br>**Available values:** "admin", "user" |
| has_comment | query | Only include feedback with comments | No | boolean |
| rating | query | Filter by rating | No | string, <br>**Available values:** "dislike", "like" |
| start_date | query | Start date (YYYY-MM-DD) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Feedback data exported successfully |
| 400 | Invalid parameters |
| 500 | Internal server error |

### [POST] /apps/{app_id}/icon
Update application icon

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppIconPayload](#appiconpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Icon updated successfully |
| 403 | Insufficient permissions |

### [GET] /apps/{app_id}/messages/{message_id}
Get message details by ID

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| message_id | path | Message ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Message retrieved successfully | **application/json**: [MessageDetailResponse](#messagedetailresponse)<br> |
| 404 | Message not found |  |

### [POST] /apps/{app_id}/model-config
**Modify app model config**

Update application model configuration

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ModelConfigRequest](#modelconfigrequest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Model configuration updated successfully |
| 400 | Invalid configuration |
| 404 | App not found |

### [POST] /apps/{app_id}/name
Check if app name is available

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppNamePayload](#appnamepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Name availability checked | **application/json**: [AppDetail](#appdetail)<br> |

### [POST] /apps/{app_id}/publish-to-creators-platform
**Publish app to Creators Platform**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [RedirectUrlResponse](#redirecturlresponse)<br> |

### [GET] /apps/{app_id}/server
Get MCP server configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | MCP server configuration retrieved successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |

### [POST] /apps/{app_id}/server
Create MCP server configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MCPServerCreatePayload](#mcpservercreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | MCP server configuration created successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
| 403 | Insufficient permissions |  |

### [PUT] /apps/{app_id}/server
Update MCP server configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MCPServerUpdatePayload](#mcpserverupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | MCP server configuration updated successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
| 403 | Insufficient permissions |  |
| 404 | Server not found |  |

### [POST] /apps/{app_id}/site
Update application site configuration

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppSiteUpdatePayload](#appsiteupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Site configuration updated successfully | **application/json**: [AppSiteResponse](#appsiteresponse)<br> |
| 403 | Insufficient permissions |  |
| 404 | App not found |  |

### [POST] /apps/{app_id}/site-enable
Enable or disable app site

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppSiteStatusPayload](#appsitestatuspayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Site status updated successfully | **application/json**: [AppDetail](#appdetail)<br> |
| 403 | Insufficient permissions |  |

### [POST] /apps/{app_id}/site/access-token-reset
Reset access token for application site

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Access token reset successfully | **application/json**: [AppSiteResponse](#appsiteresponse)<br> |
| 403 | Insufficient permissions (admin/owner required) |  |
| 404 | App or site not found |  |

### [GET] /apps/{app_id}/statistics/average-response-time
Get average response time statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Average response time statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/average-session-interactions
Get average session interaction statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Average session interaction statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/daily-conversations
Get daily conversation statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily conversation statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/daily-end-users
Get daily terminal/end-user statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily terminal statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/daily-messages
Get daily message statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily message statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/token-costs
Get daily token cost statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily token cost statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/tokens-per-second
Get tokens per second statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tokens per second statistics retrieved successfully | **application/json**: [ object ]<br> |

### [GET] /apps/{app_id}/statistics/user-satisfaction-rate
Get user satisfaction rate statistics for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | User satisfaction rate statistics retrieved successfully | **application/json**: [ object ]<br> |

### [POST] /apps/{app_id}/text-to-audio
Convert text to speech for chat messages

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | App ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TextToSpeechPayload](#texttospeechpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Text to speech conversion successful |
| 400 | Bad request - Invalid parameters |

### [GET] /apps/{app_id}/text-to-audio/voices
Get available TTS voices for a specific language

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | App ID | Yes | string |
| language | query | Language code | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | TTS voices retrieved successfully | **application/json**: [ object ]<br> |
| 400 | Invalid language parameter |  |

### [GET] /apps/{app_id}/trace
**Get app trace**

Get app tracing configuration

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Trace configuration retrieved successfully |

### [POST] /apps/{app_id}/trace
Update app tracing configuration

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [AppTracePayload](#apptracepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Trace configuration updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 403 | Insufficient permissions |  |

### [DELETE] /apps/{app_id}/trace-config
**Delete an existing trace app configuration**

Delete an existing tracing configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TraceProviderQuery](#traceproviderquery)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Tracing configuration deleted successfully |
| 400 | Invalid request parameters or configuration not found |

### [GET] /apps/{app_id}/trace-config
Get tracing configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| tracing_provider | query | Tracing provider name | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tracing configuration retrieved successfully | **application/json**: object<br> |
| 400 | Invalid request parameters |  |

### [PATCH] /apps/{app_id}/trace-config
**Update an existing trace app configuration**

Update an existing tracing configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TraceConfigPayload](#traceconfigpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tracing configuration updated successfully | **application/json**: object<br> |
| 400 | Invalid request parameters or configuration not found |  |

### [POST] /apps/{app_id}/trace-config
**Create a new trace app configuration**

Create a new tracing configuration for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TraceConfigPayload](#traceconfigpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Tracing configuration created successfully | **application/json**: object<br> |
| 400 | Invalid request parameters or configuration already exists |  |

### [POST] /apps/{app_id}/trigger-enable
**Update app trigger (enable/disable)**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserEnable](#parserenable)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [WorkflowTriggerResponse](#workflowtriggerresponse)<br> |

### [GET] /apps/{app_id}/triggers
**Get app triggers list**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [WorkflowTriggerListResponse](#workflowtriggerlistresponse)<br> |

### [GET] /apps/{app_id}/workflow-app-logs
**Get workflow app logs**

Get workflow application execution logs

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| created_at__after | query | Filter logs created after this timestamp | No | dateTime |
| created_at__before | query | Filter logs created before this timestamp | No | dateTime |
| created_by_account | query | Filter by account | No | string |
| created_by_end_user_session_id | query | Filter by end user session ID | No | string |
| detail | query | Whether to return detailed logs | No | boolean |
| keyword | query | Search keyword for filtering logs | No | string |
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
| status | query | Execution status filter (succeeded, failed, stopped, partial-succeeded) | No | string, <br>**Available values:** "failed", "partial-succeeded", "paused", "running", "scheduled", "stopped", "succeeded" |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow app logs retrieved successfully | **application/json**: [WorkflowAppLogPaginationResponse](#workflowapplogpaginationresponse)<br> |

### [GET] /apps/{app_id}/workflow-archived-logs
**Get workflow archived logs**

Get workflow archived execution logs

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| created_at__after | query | Filter logs created after this timestamp | No | dateTime |
| created_at__before | query | Filter logs created before this timestamp | No | dateTime |
| created_by_account | query | Filter by account | No | string |
| created_by_end_user_session_id | query | Filter by end user session ID | No | string |
| detail | query | Whether to return detailed logs | No | boolean |
| keyword | query | Search keyword for filtering logs | No | string |
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
| status | query | Execution status filter (succeeded, failed, stopped, partial-succeeded) | No | string, <br>**Available values:** "failed", "partial-succeeded", "paused", "running", "scheduled", "stopped", "succeeded" |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow archived logs retrieved successfully | **application/json**: [WorkflowArchivedLogPaginationResponse](#workflowarchivedlogpaginationresponse)<br> |

### [GET] /apps/{app_id}/workflow-runs
**Get workflow run list**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| last_id | query | Last run ID for pagination | No | string |
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs retrieved successfully | **application/json**: [WorkflowRunPaginationResponse](#workflowrunpaginationresponse)<br> |

### [GET] /apps/{app_id}/workflow-runs/count
**Get workflow runs count statistics**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| time_range | query | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No | string |
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs count retrieved successfully | **application/json**: [WorkflowRunCountResponse](#workflowruncountresponse)<br> |

### [POST] /apps/{app_id}/workflow-runs/tasks/{task_id}/stop
**Stop workflow task**

Stop running workflow task

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| task_id | path | Task ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 403 | Permission denied |  |
| 404 | Task not found |  |

### [GET] /apps/{app_id}/workflow-runs/{run_id}
**Get workflow run detail**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run detail retrieved successfully | **application/json**: [WorkflowRunDetailResponse](#workflowrundetailresponse)<br> |
| 404 | Workflow run not found |  |

### [GET] /apps/{app_id}/workflow-runs/{run_id}/export
Generate a download URL for an archived workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Export URL generated | **application/json**: [WorkflowRunExportResponse](#workflowrunexportresponse)<br> |

### [GET] /apps/{app_id}/workflow-runs/{run_id}/node-executions
**Get workflow run node execution list**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node executions retrieved successfully | **application/json**: [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse)<br> |
| 404 | Workflow run not found |  |

### [GET] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files
List a directory in a workflow Agent node sandbox

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Workflow Agent node ID | Yes | string |
| workflow_run_id | path | Workflow run ID | Yes | string |
| node_execution_id | query | Optional workflow node execution ID. When omitted, the latest active session for the node is used. | No | string |
| path | query | Directory path relative to the sandbox workspace | No | string, <br>**Default:** . |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Listing returned | **application/json**: [SandboxListResponse](#sandboxlistresponse)<br> |

### [GET] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files/read
Read a text/binary preview file in a workflow Agent node sandbox

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Workflow Agent node ID | Yes | string |
| workflow_run_id | path | Workflow run ID | Yes | string |
| node_execution_id | query | Optional workflow node execution ID. When omitted, the latest active session for the node is used. | No | string |
| path | query | File path relative to the sandbox workspace | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Preview returned | **application/json**: [SandboxReadResponse](#sandboxreadresponse)<br> |

### [POST] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files/upload
Upload one workflow Agent sandbox file as a Dify ToolFile mapping

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |
| workflow_run_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowAgentSandboxUploadPayload](#workflowagentsandboxuploadpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Uploaded | **application/json**: [SandboxUploadResponse](#sandboxuploadresponse)<br> |

### [GET] /apps/{app_id}/workflow/comments
**Get all comments for a workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Comments retrieved successfully | **application/json**: [WorkflowCommentBasicList](#workflowcommentbasiclist)<br> |

### [POST] /apps/{app_id}/workflow/comments
**Create a new workflow comment**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowCommentCreatePayload](#workflowcommentcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Comment created successfully | **application/json**: [WorkflowCommentCreate](#workflowcommentcreate)<br> |

### [GET] /apps/{app_id}/workflow/comments/mention-users
**Get all users in current tenant for mentions**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Mentionable users retrieved successfully | **application/json**: [WorkflowCommentMentionUsersPayload](#workflowcommentmentionuserspayload)<br> |

### [DELETE] /apps/{app_id}/workflow/comments/{comment_id}
**Delete a workflow comment**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Comment deleted successfully |

### [GET] /apps/{app_id}/workflow/comments/{comment_id}
**Get a specific workflow comment**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Comment retrieved successfully | **application/json**: [WorkflowCommentDetail](#workflowcommentdetail)<br> |

### [PUT] /apps/{app_id}/workflow/comments/{comment_id}
**Update a workflow comment**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowCommentUpdatePayload](#workflowcommentupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Comment updated successfully | **application/json**: [WorkflowCommentUpdate](#workflowcommentupdate)<br> |

### [POST] /apps/{app_id}/workflow/comments/{comment_id}/replies
**Add a reply to a workflow comment**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowCommentReplyPayload](#workflowcommentreplypayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Reply created successfully | **application/json**: [WorkflowCommentReplyCreate](#workflowcommentreplycreate)<br> |

### [DELETE] /apps/{app_id}/workflow/comments/{comment_id}/replies/{reply_id}
**Delete a comment reply**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |
| reply_id | path | Reply ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Reply deleted successfully |

### [PUT] /apps/{app_id}/workflow/comments/{comment_id}/replies/{reply_id}
**Update a comment reply**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |
| reply_id | path | Reply ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowCommentReplyPayload](#workflowcommentreplypayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Reply updated successfully | **application/json**: [WorkflowCommentReplyUpdate](#workflowcommentreplyupdate)<br> |

### [POST] /apps/{app_id}/workflow/comments/{comment_id}/resolve
**Resolve a workflow comment**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Comment resolved successfully | **application/json**: [WorkflowCommentResolve](#workflowcommentresolve)<br> |

### [GET] /apps/{app_id}/workflow/statistics/average-app-interactions
Get workflow average app interaction statistics

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Average app interaction statistics retrieved successfully |

### [GET] /apps/{app_id}/workflow/statistics/daily-conversations
Get workflow daily runs statistics

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Daily runs statistics retrieved successfully |

### [GET] /apps/{app_id}/workflow/statistics/daily-terminals
Get workflow daily terminals statistics

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Daily terminals statistics retrieved successfully |

### [GET] /apps/{app_id}/workflow/statistics/token-costs
Get workflow daily token cost statistics

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Daily token cost statistics retrieved successfully |

### [GET] /apps/{app_id}/workflows
**Get published workflows**

Get all published workflows for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| limit | query |  | No | integer, <br>**Default:** 10 |
| named_only | query |  | No | boolean |
| page | query |  | No | integer, <br>**Default:** 1 |
| user_id | query |  | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | **application/json**: [WorkflowPaginationResponse](#workflowpaginationresponse)<br> |

### [GET] /apps/{app_id}/workflows/default-workflow-block-configs
**Get default block config**

Get default block configurations for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Default block configurations retrieved successfully |

### [GET] /apps/{app_id}/workflows/default-workflow-block-configs/{block_type}
**Get default block config**

Get default block configuration by type

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| block_type | path | Block type | Yes | string |
| q | query |  | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Default block configuration retrieved successfully |
| 404 | Block type not found |

### [GET] /apps/{app_id}/workflows/draft
**Get draft workflow**

Get draft workflow for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow retrieved successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
| 404 | Draft workflow not found |  |

### [POST] /apps/{app_id}/workflows/draft
**Sync draft workflow**

Sync draft workflow configuration

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SyncDraftWorkflowPayload](#syncdraftworkflowpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow synced successfully | **application/json**: [SyncDraftWorkflowResponse](#syncdraftworkflowresponse)<br> |
| 400 | Invalid workflow configuration |  |
| 403 | Permission denied |  |

### [GET] /apps/{app_id}/workflows/draft/conversation-variables
Get conversation variables for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Conversation variables retrieved successfully | **application/json**: [WorkflowDraftVariableList](#workflowdraftvariablelist)<br> |
| 404 | Draft workflow not found |  |

### [POST] /apps/{app_id}/workflows/draft/conversation-variables
Update conversation variables for workflow draft

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ConversationVariableUpdatePayload](#conversationvariableupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Conversation variables updated successfully |

### [GET] /apps/{app_id}/workflows/draft/environment-variables
**Get draft workflow**

Get environment variables for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Environment variables retrieved successfully |
| 404 | Draft workflow not found |

### [POST] /apps/{app_id}/workflows/draft/environment-variables
Update environment variables for workflow draft

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EnvironmentVariableUpdatePayload](#environmentvariableupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Environment variables updated successfully |

### [POST] /apps/{app_id}/workflows/draft/features
Update draft workflow features

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowFeaturesPayload](#workflowfeaturespayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow features updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/delivery-test
**Test human input delivery**

Test human input delivery for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HumanInputDeliveryTestPayload](#humaninputdeliverytestpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/preview
**Preview human input form content and placeholders**

Get human input form preview for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HumanInputFormPreviewPayload](#humaninputformpreviewpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/run
**Submit human input form preview**

Submit human input form preview for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HumanInputFormSubmitPayload](#humaninputformsubmitpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /apps/{app_id}/workflows/draft/iteration/nodes/{node_id}/run
**Run draft workflow iteration node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [IterationNodeRunPayload](#iterationnoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow iteration node run started successfully |
| 403 | Permission denied |
| 404 | Node not found |

### [POST] /apps/{app_id}/workflows/draft/loop/nodes/{node_id}/run
**Run draft workflow loop node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [LoopNodeRunPayload](#loopnoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow loop node run started successfully |
| 403 | Permission denied |
| 404 | Node not found |

### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer state | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |

### [PUT] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer saved | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |

### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/candidates
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer candidates | **application/json**: [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse)<br> |

### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/impact
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer impact | **application/json**: [AgentComposerImpactResponse](#agentcomposerimpactresponse)<br> |

### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/save-to-roster
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer saved to roster | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |

### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/validate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer validation result | **application/json**: [AgentComposerValidateResponse](#agentcomposervalidateresponse)<br> |

### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/last-run
Get last run result for draft workflow node

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node last run retrieved successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
| 403 | Permission denied |  |
| 404 | Node last run not found |  |

### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/run
**Run draft workflow node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DraftWorkflowNodeRunPayload](#draftworkflownoderunpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node run started successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
| 403 | Permission denied |  |
| 404 | Node not found |  |

### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/trigger/run
**Poll for trigger events and execute single node when event arrives**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Trigger event received and node executed successfully |
| 403 | Permission denied |
| 500 | Internal server error |

### [DELETE] /apps/{app_id}/workflows/draft/nodes/{node_id}/variables
Delete all variables for a specific node

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Node variables deleted successfully |

### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/variables
Get variables for a specific node

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node variables retrieved successfully | **application/json**: [WorkflowDraftVariableList](#workflowdraftvariablelist)<br> |

### [POST] /apps/{app_id}/workflows/draft/run
**Run draft workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DraftWorkflowRunPayload](#draftworkflowrunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Draft workflow run started successfully |
| 403 | Permission denied |

### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs
Snapshot of every node's declared outputs for a draft workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node outputs | **application/json**: [WorkflowRunSnapshotView](#workflowrunsnapshotview)<br> |
| 404 | Workflow run not found |  |

### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/events
Server-Sent Events stream of inspector deltas for a draft workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow run node output event stream |
| 404 | Workflow run not found |

### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}
One node's declared outputs for a draft workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID inside the workflow graph | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output detail | **application/json**: [NodeOutputsView](#nodeoutputsview)<br> |
| 404 | Workflow run / node not found |  |

### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
Full value for one declared output, including signed download URL for files.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID inside the workflow graph | Yes | string |
| output_name | path | Declared output name as exposed by Composer | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output preview | **application/json**: [OutputPreviewView](#outputpreviewview)<br> |
| 404 | Workflow run / node / output not found |  |

### [GET] /apps/{app_id}/workflows/draft/system-variables
Get system variables for workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | System variables retrieved successfully | **application/json**: [WorkflowDraftVariableList](#workflowdraftvariablelist)<br> |

### [POST] /apps/{app_id}/workflows/draft/trigger/run
**Poll for trigger events and execute full workflow when event arrives**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DraftWorkflowTriggerRunRequest](#draftworkflowtriggerrunrequest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Trigger event received and workflow executed successfully |
| 403 | Permission denied |
| 500 | Internal server error |

### [POST] /apps/{app_id}/workflows/draft/trigger/run-all
**Full workflow debug when the start node is a trigger**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DraftWorkflowTriggerRunAllPayload](#draftworkflowtriggerrunallpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow executed successfully |
| 403 | Permission denied |
| 500 | Internal server error |

### [DELETE] /apps/{app_id}/workflows/draft/variables
Delete all draft workflow variables

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Workflow variables deleted successfully |

### [GET] /apps/{app_id}/workflows/draft/variables
**Get draft workflow**

Get draft workflow variables

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| limit | query | Items per page | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow variables retrieved successfully | **application/json**: [WorkflowDraftVariableListWithoutValue](#workflowdraftvariablelistwithoutvalue)<br> |

### [DELETE] /apps/{app_id}/workflows/draft/variables/{variable_id}
Delete a workflow variable

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Variable deleted successfully |
| 404 | Variable not found |

### [GET] /apps/{app_id}/workflows/draft/variables/{variable_id}
Get a specific workflow variable

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| variable_id | path | Variable ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable retrieved successfully | **application/json**: [WorkflowDraftVariable](#workflowdraftvariable)<br> |
| 404 | Variable not found |  |

### [PATCH] /apps/{app_id}/workflows/draft/variables/{variable_id}
Update a workflow variable

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowDraftVariableUpdatePayload](#workflowdraftvariableupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable updated successfully | **application/json**: [WorkflowDraftVariable](#workflowdraftvariable)<br> |
| 404 | Variable not found |  |

### [PUT] /apps/{app_id}/workflows/draft/variables/{variable_id}/reset
Reset a workflow variable to its default value

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| variable_id | path | Variable ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable reset successfully | **application/json**: [WorkflowDraftVariable](#workflowdraftvariable)<br> |
| 204 | Variable reset (no content) |  |
| 404 | Variable not found |  |

### [GET] /apps/{app_id}/workflows/publish
**Get published workflow**

Get published workflow for an application

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflow retrieved successfully, or null if not found | **application/json**: [WorkflowResponse](#workflowresponse)<br> |

### [POST] /apps/{app_id}/workflows/publish
**Publish workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [PublishWorkflowPayload](#publishworkflowpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs
Snapshot of every node's declared outputs for a published workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node outputs | **application/json**: [WorkflowRunSnapshotView](#workflowrunsnapshotview)<br> |
| 404 | Workflow run not found |  |

### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/events
Server-Sent Events stream of inspector deltas for a published workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow run node output event stream |
| 404 | Workflow run not found |

### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}
One node's declared outputs for a published workflow run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID inside the workflow graph | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output detail | **application/json**: [NodeOutputsView](#nodeoutputsview)<br> |
| 404 | Workflow run / node not found |  |

### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
Full value for one declared output of a published run.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID inside the workflow graph | Yes | string |
| output_name | path | Declared output name as exposed by Composer | Yes | string |
| run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run node output preview | **application/json**: [OutputPreviewView](#outputpreviewview)<br> |
| 404 | Workflow run / node / output not found |  |

### [GET] /apps/{app_id}/workflows/triggers/webhook
**Get webhook trigger for a node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | query |  | Yes | string |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [WebhookTriggerResponse](#webhooktriggerresponse)<br> |

### [DELETE] /apps/{app_id}/workflows/{workflow_id}
**Delete workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| workflow_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PATCH] /apps/{app_id}/workflows/{workflow_id}
**Update workflow attributes**

Update workflow by ID

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| workflow_id | path | Workflow ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowUpdatePayload](#workflowupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow updated successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
| 403 | Permission denied |  |
| 404 | Workflow not found |  |

### [POST] /apps/{app_id}/workflows/{workflow_id}/restore
Restore a published workflow version into the draft workflow

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path | Application ID | Yes | string |
| workflow_id | path | Published workflow ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow restored successfully |
| 400 | Source workflow must be published |
| 404 | Workflow not found |

### [GET] /apps/{resource_id}/api-keys
**Get all API keys for an app**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| resource_id | path | App ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API keys retrieved successfully | **application/json**: [ApiKeyList](#apikeylist)<br> |

### [POST] /apps/{resource_id}/api-keys
**Create a new API key for an app**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| resource_id | path | App ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | API key created successfully | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
| 400 | Maximum keys exceeded |  |

### [DELETE] /apps/{resource_id}/api-keys/{api_key_id}
**Delete an API key for an app**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| api_key_id | path | API key ID | Yes | string |
| resource_id | path | App ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | API key deleted successfully |

### [GET] /apps/{server_id}/server/refresh
Refresh MCP server configuration and regenerate server code

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| server_id | path | Server ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | MCP server refreshed successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
| 403 | Insufficient permissions |  |
| 404 | Server not found |  |

### [GET] /auth/plugin/datasource/default-list
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /auth/plugin/datasource/list
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /auth/plugin/datasource/{provider_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /auth/plugin/datasource/{provider_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceCredentialPayload](#datasourcecredentialpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /auth/plugin/datasource/{provider_id}/custom-client
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /auth/plugin/datasource/{provider_id}/custom-client
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceCustomClientPayload](#datasourcecustomclientpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /auth/plugin/datasource/{provider_id}/default
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceDefaultPayload](#datasourcedefaultpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /auth/plugin/datasource/{provider_id}/delete
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceCredentialDeletePayload](#datasourcecredentialdeletepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /auth/plugin/datasource/{provider_id}/update
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceCredentialUpdatePayload](#datasourcecredentialupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /auth/plugin/datasource/{provider_id}/update-name
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceUpdateNamePayload](#datasourceupdatenamepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /billing/invoices
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PUT] /billing/partners/{partner_key}/tenants
Sync partner tenants bindings

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| partner_key | path | Partner key | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [PartnerTenantsPayload](#partnertenantspayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Tenants synced to partner successfully |
| 400 | Invalid partner information |

### [GET] /billing/subscription
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /code-based-extension
Get code-based extension data by module name

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| module | query | Extension module name | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [CodeBasedExtensionResponse](#codebasedextensionresponse)<br> |

### [GET] /compliance/download
Get compliance document download link

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| doc_name | query | Compliance document name | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /data-source/integrates
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [DataSourceIntegrateListResponse](#datasourceintegratelistresponse)<br> |

### [PATCH] /data-source/integrates
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /data-source/integrates/{binding_id}/{action}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path |  | Yes | string |
| binding_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [DataSourceIntegrateListResponse](#datasourceintegratelistresponse)<br> |

### [PATCH] /data-source/integrates/{binding_id}/{action}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path |  | Yes | string |
| binding_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /datasets
Get list of datasets

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| ids | query | Filter by dataset IDs | No | [ string ] |
| include_all | query | Include all datasets | No | boolean |
| keyword | query | Search keyword | No | string |
| limit | query | Number of items per page | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |
| tag_ids | query | Filter by tag IDs | No | [ string ] |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Datasets retrieved successfully | **application/json**: [DatasetListResponse](#datasetlistresponse)<br> |

### [POST] /datasets
Create a new dataset

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasetCreatePayload](#datasetcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Dataset created successfully | **application/json**: [DatasetDetailResponse](#datasetdetailresponse)<br> |
| 400 | Invalid request parameters |  |

### [GET] /datasets/api-base-info
Get dataset API base information

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API base info retrieved successfully | **application/json**: [ApiBaseUrlResponse](#apibaseurlresponse)<br> |

### [GET] /datasets/api-keys
Get dataset API keys

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API keys retrieved successfully | **application/json**: [ApiKeyList](#apikeylist)<br> |

### [POST] /datasets/api-keys
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API key created successfully | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
| 400 | Maximum keys exceeded |  |

### [DELETE] /datasets/api-keys/{api_key_id}
Delete dataset API key

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| api_key_id | path | API key ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | API key deleted successfully |

### [GET] /datasets/batch_import_status/{job_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| job_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import status | **application/json**: [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse)<br> |

### [POST] /datasets/batch_import_status/{job_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| job_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BatchImportPayload](#batchimportpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import started | **application/json**: [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse)<br> |

### [POST] /datasets/external
Create external knowledge dataset

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ExternalDatasetCreatePayload](#externaldatasetcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | External dataset created successfully | **application/json**: [DatasetDetail](#datasetdetail)<br> |
| 400 | Invalid parameters |  |
| 403 | Permission denied |  |

### [GET] /datasets/external-knowledge-api
Get external knowledge API templates

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| keyword | query | Search keyword | No | string |
| limit | query | Number of items per page (default: 20) | No | string |
| page | query | Page number (default: 1) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | External API templates retrieved successfully |

### [POST] /datasets/external-knowledge-api
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ExternalKnowledgeApiPayload](#externalknowledgeapipayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /datasets/external-knowledge-api/{external_knowledge_api_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| external_knowledge_api_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | External knowledge API deleted successfully |

### [GET] /datasets/external-knowledge-api/{external_knowledge_api_id}
Get external knowledge API template details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| external_knowledge_api_id | path | External knowledge API ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | External API template retrieved successfully |
| 404 | Template not found |

### [PATCH] /datasets/external-knowledge-api/{external_knowledge_api_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| external_knowledge_api_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ExternalKnowledgeApiPayload](#externalknowledgeapipayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /datasets/external-knowledge-api/{external_knowledge_api_id}/use-check
Check if external knowledge API is being used

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| external_knowledge_api_id | path | External knowledge API ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Usage check completed successfully | **application/json**: [UsageCountResponse](#usagecountresponse)<br> |

### [POST] /datasets/indexing-estimate
Estimate dataset indexing cost

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [IndexingEstimatePayload](#indexingestimatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Indexing estimate calculated successfully | **application/json**: [IndexingEstimateResponse](#indexingestimateresponse)<br> |

### [POST] /datasets/init
Initialize dataset with documents

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [KnowledgeConfig](#knowledgeconfig)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Dataset initialized successfully | **application/json**: [DatasetAndDocumentResponse](#datasetanddocumentresponse)<br> |
| 400 | Invalid request parameters |  |

### [GET] /datasets/metadata/built-in
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Built-in fields retrieved successfully | **application/json**: [DatasetMetadataBuiltInFieldsResponse](#datasetmetadatabuiltinfieldsresponse)<br> |

### [POST] /datasets/notion-indexing-estimate
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [NotionEstimatePayload](#notionestimatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [IndexingEstimate](#indexingestimate)<br> |

### [GET] /datasets/process-rule
Get dataset document processing rules

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| document_id | query | Document ID (optional) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Process rules retrieved successfully |

### [GET] /datasets/retrieval-setting
Get dataset retrieval settings

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Retrieval settings retrieved successfully | **application/json**: [RetrievalSettingResponse](#retrievalsettingresponse)<br> |

### [GET] /datasets/retrieval-setting/{vector_type}
Get mock dataset retrieval settings by vector type

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| vector_type | path | Vector store type | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Mock retrieval settings retrieved successfully | **application/json**: [RetrievalSettingResponse](#retrievalsettingresponse)<br> |

### [DELETE] /datasets/{dataset_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Dataset deleted successfully |

### [GET] /datasets/{dataset_id}
Get dataset details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dataset retrieved successfully | **application/json**: [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse)<br> |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### [PATCH] /datasets/{dataset_id}
Update dataset details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasetUpdatePayload](#datasetupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dataset updated successfully | **application/json**: [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse)<br> |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### [POST] /datasets/{dataset_id}/api-keys/{status}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| status | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /datasets/{dataset_id}/auto-disable-logs
Get dataset auto disable logs

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Auto disable logs retrieved successfully | **application/json**: [AutoDisableLogsResponse](#autodisablelogsresponse)<br> |
| 404 | Dataset not found |  |

### [GET] /datasets/{dataset_id}/batch/{batch}/indexing-estimate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| batch | path |  | Yes | string |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /datasets/{dataset_id}/batch/{batch}/indexing-status
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| batch | path |  | Yes | string |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Indexing status retrieved successfully | **application/json**: [DocumentStatusListResponse](#documentstatuslistresponse)<br> |

### [DELETE] /datasets/{dataset_id}/documents
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Documents deleted successfully |

### [GET] /datasets/{dataset_id}/documents
Get documents in a dataset

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| fetch | query | Fetch full details (default: false) | No | string |
| keyword | query | Search keyword | No | string |
| limit | query | Number of items per page (default: 20) | No | string |
| page | query | Page number (default: 1) | No | string |
| sort | query | Sort order (default: -created_at) | No | string |
| status | query | Filter documents by display status | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Documents retrieved successfully | **application/json**: [DocumentWithSegmentsListResponse](#documentwithsegmentslistresponse)<br> |

### [POST] /datasets/{dataset_id}/documents
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [KnowledgeConfig](#knowledgeconfig)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Documents created successfully | **application/json**: [DatasetAndDocumentResponse](#datasetanddocumentresponse)<br> |

### [POST] /datasets/{dataset_id}/documents/download-zip
**Stream a ZIP archive containing the requested uploaded documents**

Download selected dataset documents as a single ZIP archive (upload-file only)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DocumentBatchDownloadZipPayload](#documentbatchdownloadzippayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /datasets/{dataset_id}/documents/generate-summary
**Generate summary index for specified documents**

Generate summary index for documents
This endpoint checks if the dataset configuration supports summary generation
(indexing_technique must be 'high_quality' and summary_index_setting.enable must be true),
then asynchronously generates summary indexes for the provided documents.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [GenerateSummaryPayload](#generatesummarypayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Summary generation started successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 400 | Invalid request or dataset configuration |  |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### [POST] /datasets/{dataset_id}/documents/metadata
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MetadataOperationData](#metadataoperationdata)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Documents metadata updated successfully |

### [PATCH] /datasets/{dataset_id}/documents/status/{action}/batch
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path |  | Yes | string |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [DELETE] /datasets/{dataset_id}/documents/{document_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Document deleted successfully |

### [GET] /datasets/{dataset_id}/documents/{document_id}
Get document details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| metadata | query | Metadata inclusion (all/only/without) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Document retrieved successfully |
| 404 | Document not found |

### [GET] /datasets/{dataset_id}/documents/{document_id}/download
Get a signed download URL for a dataset document's original uploaded file

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Download URL generated successfully | **application/json**: [UrlResponse](#urlresponse)<br> |

### [GET] /datasets/{dataset_id}/documents/{document_id}/indexing-estimate
Estimate document indexing cost

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Indexing estimate calculated successfully |
| 400 | Document already finished |
| 404 | Document not found |

### [GET] /datasets/{dataset_id}/documents/{document_id}/indexing-status
Get document indexing status

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Indexing status retrieved successfully | **application/json**: [DocumentStatusResponse](#documentstatusresponse)<br> |
| 404 | Document not found |  |

### [PUT] /datasets/{dataset_id}/documents/{document_id}/metadata
Update document metadata

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DocumentMetadataUpdatePayload](#documentmetadataupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document metadata updated successfully | **application/json**: [SimpleResultMessageResponse](#simpleresultmessageresponse)<br> |
| 403 | Permission denied |  |
| 404 | Document not found |  |

### [GET] /datasets/{dataset_id}/documents/{document_id}/notion/sync
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /datasets/{dataset_id}/documents/{document_id}/pipeline-execution-log
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/pause
**pause document**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Document paused successfully |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/resume
**recover document**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Document resumed successfully |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/{action}
Update document processing status (pause/resume)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path | Action to perform (pause/resume) | Yes | string |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Processing status updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 400 | Invalid action |  |
| 404 | Document not found |  |

### [POST] /datasets/{dataset_id}/documents/{document_id}/rename
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DocumentRenamePayload](#documentrenamepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document renamed successfully | **application/json**: [DocumentResponse](#documentresponse)<br> |

### [POST] /datasets/{dataset_id}/documents/{document_id}/segment
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SegmentCreatePayload](#segmentcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Segment created successfully | **application/json**: [SegmentDetailResponse](#segmentdetailresponse)<br> |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segment/{action}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path | Action | Yes | string |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | query | Segment IDs | No | [ string ] |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [DELETE] /datasets/{dataset_id}/documents/{document_id}/segments
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | query | Segment IDs | No | [ string ] |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Segments deleted successfully |

### [GET] /datasets/{dataset_id}/documents/{document_id}/segments
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| enabled | query |  | No | string, <br>**Default:** all |
| hit_count_gte | query |  | No | integer |
| keyword | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer, <br>**Default:** 1 |
| status | query |  | No | [ string ] |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Segments retrieved successfully | **application/json**: [ConsoleSegmentListResponse](#consolesegmentlistresponse)<br> |

### [GET] /datasets/{dataset_id}/documents/{document_id}/segments/batch_import
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import status | **application/json**: [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse)<br> |

### [POST] /datasets/{dataset_id}/documents/{document_id}/segments/batch_import
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BatchImportPayload](#batchimportpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import started | **application/json**: [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse)<br> |

### [DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Segment ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Segment deleted successfully |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Segment ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SegmentUpdatePayload](#segmentupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Segment updated successfully | **application/json**: [SegmentDetailResponse](#segmentdetailresponse)<br> |

### [GET] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Parent segment ID | Yes | string |
| keyword | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunks retrieved successfully | **application/json**: [ChildChunkListResponse](#childchunklistresponse)<br> |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Parent segment ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChildChunkBatchUpdatePayload](#childchunkbatchupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunks updated successfully | **application/json**: [ChildChunkBatchUpdateResponse](#childchunkbatchupdateresponse)<br> |

### [POST] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Parent segment ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChildChunkCreatePayload](#childchunkcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunk created successfully | **application/json**: [ChildChunkDetailResponse](#childchunkdetailresponse)<br> |

### [DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| child_chunk_id | path | Child chunk ID | Yes | string |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Parent segment ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Child chunk deleted successfully |

### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| child_chunk_id | path | Child chunk ID | Yes | string |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Parent segment ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChildChunkUpdatePayload](#childchunkupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunk updated successfully | **application/json**: [ChildChunkDetailResponse](#childchunkdetailresponse)<br> |

### [GET] /datasets/{dataset_id}/documents/{document_id}/summary-status
**Get summary index generation status for a document**

Get summary index generation status for a document
Returns:
- total_segments: Total number of segments in the document
- summary_status: Dictionary with status counts
  - completed: Number of summaries completed
  - generating: Number of summaries being generated
  - error: Number of summaries with errors
  - not_started: Number of segments without summary records
- summaries: List of summary records with status and content preview

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Summary status retrieved successfully |
| 404 | Document not found |

### [GET] /datasets/{dataset_id}/documents/{document_id}/website-sync
**sync website document**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /datasets/{dataset_id}/error-docs
Get dataset error documents

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Error documents retrieved successfully | **application/json**: [ErrorDocsResponse](#errordocsresponse)<br> |
| 404 | Dataset not found |  |

### [POST] /datasets/{dataset_id}/external-hit-testing
Test external knowledge retrieval for dataset

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ExternalHitTestingPayload](#externalhittestingpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | External hit testing completed successfully |
| 400 | Invalid parameters |
| 404 | Dataset not found |

### [POST] /datasets/{dataset_id}/hit-testing
Test dataset knowledge retrieval

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HitTestingPayload](#hittestingpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Hit testing completed successfully | **application/json**: [HitTestingResponse](#hittestingresponse)<br> |
| 400 | Invalid parameters |  |
| 404 | Dataset not found |  |

### [GET] /datasets/{dataset_id}/indexing-status
Get dataset indexing status

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Indexing status retrieved successfully | **application/json**: [DocumentStatusListResponse](#documentstatuslistresponse)<br> |

### [GET] /datasets/{dataset_id}/metadata
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Metadata retrieved successfully | **application/json**: [DatasetMetadataListResponse](#datasetmetadatalistresponse)<br> |

### [POST] /datasets/{dataset_id}/metadata
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MetadataArgs](#metadataargs)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Metadata created successfully | **application/json**: [DatasetMetadataResponse](#datasetmetadataresponse)<br> |

### [POST] /datasets/{dataset_id}/metadata/built-in/{action}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | path |  | Yes | string |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Action completed successfully |

### [DELETE] /datasets/{dataset_id}/metadata/{metadata_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| metadata_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Metadata deleted successfully |

### [PATCH] /datasets/{dataset_id}/metadata/{metadata_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| metadata_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MetadataUpdatePayload](#metadataupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Metadata updated successfully | **application/json**: [DatasetMetadataResponse](#datasetmetadataresponse)<br> |

### [GET] /datasets/{dataset_id}/notion/sync
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /datasets/{dataset_id}/permission-part-users
Get dataset permission user list

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Permission users retrieved successfully | **application/json**: [PartialMemberListResponse](#partialmemberlistresponse)<br> |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### [GET] /datasets/{dataset_id}/queries
Get dataset query history

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Query history retrieved successfully | **application/json**: [DatasetQueryListResponse](#datasetquerylistresponse)<br> |

### [GET] /datasets/{dataset_id}/related-apps
Get applications related to dataset

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Related apps retrieved successfully | **application/json**: [RelatedAppListResponse](#relatedapplistresponse)<br> |

### [POST] /datasets/{dataset_id}/retry
**retry document**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DocumentRetryPayload](#documentretrypayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Documents retry started successfully |

### [GET] /datasets/{dataset_id}/use-check
Check if dataset is in use

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dataset use status retrieved successfully | **application/json**: [UsageCheckResponse](#usagecheckresponse)<br> |

### [GET] /datasets/{resource_id}/api-keys
**Get all API keys for a dataset**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| resource_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API keys retrieved successfully | **application/json**: [ApiKeyList](#apikeylist)<br> |

### [POST] /datasets/{resource_id}/api-keys
**Create a new API key for a dataset**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| resource_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | API key created successfully | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
| 400 | Maximum keys exceeded |  |

### [DELETE] /datasets/{resource_id}/api-keys/{api_key_id}
**Delete an API key for a dataset**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| api_key_id | path | API key ID | Yes | string |
| resource_id | path | Dataset ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | API key deleted successfully |

### [POST] /email-code-login
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EmailPayload](#emailpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |

### [POST] /email-code-login/validity
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EmailCodeLoginPayload](#emailcodeloginpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /email-register
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /email-register/send-email
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |

### [POST] /email-register/validity
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [VerificationTokenResponse](#verificationtokenresponse)<br> |

### [GET] /explore/apps
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| language | query | Language code for recommended app localization | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [RecommendedAppListResponse](#recommendedapplistresponse)<br> |

### [GET] /explore/apps/{app_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /features
**Get feature configuration for current tenant**

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [FeatureModel](#featuremodel)<br> |

### [GET] /features/vector-space
**Get vector-space usage and limit for current tenant**

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [LimitationModel](#limitationmodel)<br> |

### [GET] /files/support-type
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AllowedExtensionsResponse](#allowedextensionsresponse)<br> |

### [GET] /files/upload
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [UploadConfig](#uploadconfig)<br> |

### [POST] /files/upload
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | File uploaded successfully | **application/json**: [FileResponse](#fileresponse)<br> |

### [GET] /files/{file_id}/preview
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| file_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TextContentResponse](#textcontentresponse)<br> |

### [POST] /forgot-password
Send password reset email

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ForgotPasswordSendPayload](#forgotpasswordsendpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Email sent successfully | **application/json**: [ForgotPasswordEmailResponse](#forgotpasswordemailresponse)<br> |
| 400 | Invalid email or rate limit exceeded |  |

### [POST] /forgot-password/resets
Reset password with verification token

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ForgotPasswordResetPayload](#forgotpasswordresetpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Password reset successfully | **application/json**: [ForgotPasswordResetResponse](#forgotpasswordresetresponse)<br> |
| 400 | Invalid token or password mismatch |  |

### [POST] /forgot-password/validity
Verify password reset code

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ForgotPasswordCheckPayload](#forgotpasswordcheckpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Code verified successfully | **application/json**: [ForgotPasswordCheckResponse](#forgotpasswordcheckresponse)<br> |
| 400 | Invalid code or token |  |

### [GET] /form/human_input/{form_token}
**Get human input form definition by form token**

GET /console/api/form/human_input/<form_token>

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| form_token | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /form/human_input/{form_token}
**Submit human input form by form token**

POST /console/api/form/human_input/<form_token>

Request body:
{
    "inputs": {
        "content": "User input content"
    },
    "action": "Approve"
}

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| form_token | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [HumanInputFormSubmitPayload](#humaninputformsubmitpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /info
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TenantInfoResponse](#tenantinforesponse)<br> |

### [GET] /installed-apps
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [InstalledAppListResponse](#installedapplistresponse)<br> |

### [POST] /installed-apps
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleMessageResponse](#simplemessageresponse)<br> |

### [DELETE] /installed-apps/{installed_app_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | App uninstalled successfully |

### [PATCH] /installed-apps/{installed_app_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultMessageResponse](#simpleresultmessageresponse)<br> |

### [POST] /installed-apps/{installed_app_id}/audio-to-text
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/chat-messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChatMessagePayload](#chatmessagepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/chat-messages/{task_id}/stop
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /installed-apps/{installed_app_id}/completion-messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CompletionMessageExplorePayload](#completionmessageexplorepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/completion-messages/{task_id}/stop
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /installed-apps/{installed_app_id}/conversations
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| last_id | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| pinned | query |  | No | boolean |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /installed-apps/{installed_app_id}/conversations/{c_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Conversation deleted successfully |

### [POST] /installed-apps/{installed_app_id}/conversations/{c_id}/name
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ConversationRenamePayload](#conversationrenamepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PATCH] /installed-apps/{installed_app_id}/conversations/{c_id}/pin
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ResultResponse](#resultresponse)<br> |

### [PATCH] /installed-apps/{installed_app_id}/conversations/{c_id}/unpin
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ResultResponse](#resultresponse)<br> |

### [GET] /installed-apps/{installed_app_id}/messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| conversation_id | query | Conversation UUID | Yes | string |
| first_id | query | First message ID for pagination | No | string |
| limit | query | Number of messages to return (1-100) | No | integer, <br>**Default:** 20 |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/messages/{message_id}/feedbacks
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MessageFeedbackPayload](#messagefeedbackpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Feedback submitted successfully | **application/json**: [ResultResponse](#resultresponse)<br> |

### [GET] /installed-apps/{installed_app_id}/messages/{message_id}/more-like-this
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| response_mode | query |  | Yes | string, <br>**Available values:** "blocking", "streaming" |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /installed-apps/{installed_app_id}/messages/{message_id}/suggested-questions
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SuggestedQuestionsResponse](#suggestedquestionsresponse)<br> |

### [GET] /installed-apps/{installed_app_id}/meta
**Get app meta**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /installed-apps/{installed_app_id}/parameters
**Retrieve app parameters**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /installed-apps/{installed_app_id}/saved-messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| last_id | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| installed_app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/saved-messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SavedMessageCreatePayload](#savedmessagecreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ResultResponse](#resultresponse)<br> |

### [DELETE] /installed-apps/{installed_app_id}/saved-messages/{message_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Saved message deleted successfully |

### [POST] /installed-apps/{installed_app_id}/text-to-audio
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TextToAudioPayload](#texttoaudiopayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/workflows/run
**Run workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowRunPayload](#workflowrunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /installed-apps/{installed_app_id}/workflows/tasks/{task_id}/stop
**Stop workflow task**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /instruction-generate
Generate instruction for workflow nodes or general use

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [InstructionGeneratePayload](#instructiongeneratepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Instruction generated successfully |
| 400 | Invalid request parameters or flow/workflow not found |
| 402 | Provider quota exceeded |

### [POST] /instruction-generate/template
Get instruction generation template

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [InstructionTemplatePayload](#instructiontemplatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Template retrieved successfully |
| 400 | Invalid request parameters |

### [POST] /login
**Authenticate user and login**

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [LoginPayload](#loginpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultOptionalDataResponse](#simpleresultoptionaldataresponse)<br> |

### [POST] /logout
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /mcp/oauth/callback
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [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.

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success — inspect should_show to decide whether to render the modal |
| 401 | Unauthorized |

### [POST] /notification/dismiss
Mark a notification as dismissed for the current user.

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
| 401 | Unauthorized |  |

### [GET] /notion/pages/{page_id}/{page_type}/preview
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| credential_id | query | Credential ID | Yes | string |
| page_id | path |  | Yes | string |
| page_type | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TextContentResponse](#textcontentresponse)<br> |

### [GET] /notion/pre-import/pages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| credential_id | query | Credential ID | Yes | string |
| dataset_id | query | Dataset ID | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [NotionIntegrateInfoListResponse](#notionintegrateinfolistresponse)<br> |

### [GET] /oauth/authorize/{provider}
Handle OAuth callback and complete login process

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path | OAuth provider name (github/google) | Yes | string |
| code | query | Authorization code from OAuth provider | No | string |
| state | query | Optional state parameter (used for invite token) | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 302 | Redirect to console with access token |
| 400 | OAuth process failed |

### [GET] /oauth/data-source/binding/{provider}
Bind OAuth data source with authorization code

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path | Data source provider name (notion) | Yes | string |
| code | query | Authorization code from OAuth provider | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Data source binding success | **application/json**: [OAuthDataSourceBindingResponse](#oauthdatasourcebindingresponse)<br> |
| 400 | Invalid provider or code |  |

### [GET] /oauth/data-source/callback/{provider}
Handle OAuth callback from data source provider

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path | Data source provider name (notion) | Yes | string |
| code | query | Authorization code from OAuth provider | No | string |
| error | query | Error message from OAuth provider | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 302 | Redirect to console with result |
| 400 | Invalid provider |

### [GET] /oauth/data-source/{provider}
Get OAuth authorization URL for data source provider

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path | Data source provider name (notion) | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Authorization URL or internal setup success | **application/json**: [OAuthDataSourceResponse](#oauthdatasourceresponse)<br> |
| 400 | Invalid provider |  |
| 403 | Admin privileges required |  |

### [GET] /oauth/data-source/{provider}/{binding_id}/sync
Sync data from OAuth data source

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| binding_id | path | Data source binding ID | Yes | string |
| provider | path | Data source provider name (notion) | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Data source sync success | **application/json**: [OAuthDataSourceSyncResponse](#oauthdatasourcesyncresponse)<br> |
| 400 | Invalid provider or sync failed |  |

### [GET] /oauth/login/{provider}
Initiate OAuth login process

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path | OAuth provider name (github/google) | Yes | string |
| invite_token | query | Optional invitation token | No | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 302 | Redirect to OAuth authorization URL |
| 400 | Invalid provider |

### [GET] /oauth/plugin/{provider_id}/datasource/callback
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /oauth/plugin/{provider_id}/datasource/get-authorization-url
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /oauth/plugin/{provider}/tool/authorization-url
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /oauth/plugin/{provider}/tool/callback
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /oauth/plugin/{provider}/trigger/callback
**Handle OAuth callback for trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /oauth/provider
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /oauth/provider/account
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /oauth/provider/authorize
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /oauth/provider/token
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /rag/pipeline/customized/templates/{template_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| template_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Pipeline template deleted |

### [PATCH] /rag/pipeline/customized/templates/{template_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| template_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Pipeline template updated |

### [POST] /rag/pipeline/customized/templates/{template_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| template_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleDataResponse](#simpledataresponse)<br> |

### [POST] /rag/pipeline/dataset
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RagPipelineDatasetImportPayload](#ragpipelinedatasetimportpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | RAG pipeline dataset import started | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |

### [POST] /rag/pipeline/empty-dataset
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | RAG pipeline dataset created | **application/json**: [DatasetDetailResponse](#datasetdetailresponse)<br> |

### [GET] /rag/pipeline/templates
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| language | query | Template language | No | string, <br>**Default:** en-US |
| type | query | Template source: built-in or customized | No | string, <br>**Default:** built-in |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline templates | **application/json**: [PipelineTemplateListResponse](#pipelinetemplatelistresponse)<br> |

### [GET] /rag/pipeline/templates/{template_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| type | query | Template source: built-in or customized | No | string, <br>**Default:** built-in |
| template_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline template | **application/json**: [PipelineTemplateDetailResponse](#pipelinetemplatedetailresponse)<br> |

### [GET] /rag/pipelines/datasource-plugins
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/imports
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RagPipelineImportPayload](#ragpipelineimportpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import completed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
| 202 | Import pending confirmation | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
| 400 | Import failed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |

### [POST] /rag/pipelines/imports/{import_id}/confirm
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| import_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import confirmed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
| 400 | Import failed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |

### [GET] /rag/pipelines/imports/{pipeline_id}/check-dependencies
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dependencies checked | **application/json**: [RagPipelineImportCheckDependenciesResponse](#ragpipelineimportcheckdependenciesresponse)<br> |

### [GET] /rag/pipelines/recommended-plugins
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/transform/datasets/{dataset_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/customized/publish
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Pipeline template published |

### [GET] /rag/pipelines/{pipeline_id}/exports
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| include_secret | query | Whether to include secret values in the exported DSL | No | string, <br>**Default:** false |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline exported | **application/json**: [SimpleDataResponse](#simpledataresponse)<br> |

### [GET] /rag/pipelines/{pipeline_id}/workflow-runs
**Get workflow run list**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs retrieved successfully | **application/json**: [WorkflowRunPaginationResponse](#workflowrunpaginationresponse)<br> |

### [POST] /rag/pipelines/{pipeline_id}/workflow-runs/tasks/{task_id}/stop
**Stop workflow task**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}
**Get workflow run detail**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| run_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run detail retrieved successfully | **application/json**: [WorkflowRunDetailResponse](#workflowrundetailresponse)<br> |

### [GET] /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}/node-executions
**Get workflow run node execution list**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| run_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node executions retrieved successfully | **application/json**: [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse)<br> |

### [GET] /rag/pipelines/{pipeline_id}/workflows
**Get published workflows**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | **application/json**: [WorkflowPaginationResponse](#workflowpaginationresponse)<br> |
| 403 | Permission denied |  |

### [GET] /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs
**Get default block config**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs/{block_type}
**Get default block config**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| block_type | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft
**Get draft rag pipeline's workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow retrieved successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
| 404 | Draft workflow not found |  |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft
**Sync draft workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [RagPipelineWorkflowSyncResponse](#ragpipelineworkflowsyncresponse)<br> |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/datasource/nodes/{node_id}/run
**Run rag pipeline datasource**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceNodeRunPayload](#datasourcenoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/datasource/variables-inspect
**Set datasource variables**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceVariablesPayload](#datasourcevariablespayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Datasource variables set successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/environment-variables
**Get draft workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/iteration/nodes/{node_id}/run
**Run draft workflow iteration node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [NodeRunPayload](#noderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/loop/nodes/{node_id}/run
**Run draft workflow loop node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [NodeRunPayload](#noderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/last-run
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node last run retrieved successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/run
**Run draft workflow node**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [NodeRunRequiredPayload](#noderunrequiredpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node run started successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |

### [DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/pre-processing/parameters
**Get first step parameters of rag pipeline**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/processing/parameters
**Get second step parameters of rag pipeline**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/run
**Run draft workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DraftWorkflowRunPayload](#draftworkflowrunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/system-variables
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/variables
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/variables
**Get draft workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PATCH] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowDraftVariablePatchPayload](#workflowdraftvariablepatchpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PUT] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}/reset
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/publish
**Get published pipeline**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflow retrieved successfully, or null if not exist | **application/json**: [WorkflowResponse](#workflowresponse)<br> |

### [POST] /rag/pipelines/{pipeline_id}/workflows/publish
**Publish workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [RagPipelineWorkflowPublishResponse](#ragpipelineworkflowpublishresponse)<br> |

### [POST] /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/preview
**Run datasource content preview**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [Parser](#parser)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/run
**Run rag pipeline datasource**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [DatasourceNodeRunPayload](#datasourcenoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/published/pre-processing/parameters
**Get first step parameters of rag pipeline**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /rag/pipelines/{pipeline_id}/workflows/published/processing/parameters
**Get second step parameters of rag pipeline**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /rag/pipelines/{pipeline_id}/workflows/published/run
**Run published workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [PublishedWorkflowRunPayload](#publishedworkflowrunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}
**Delete a published workflow version that is not currently active on the pipeline**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| workflow_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Workflow deleted successfully |

### [PATCH] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}
**Update workflow attributes**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| workflow_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow updated successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
| 400 | No valid fields to update |  |
| 403 | Permission denied |  |
| 404 | Workflow not found |  |

### [POST] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}/restore
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| workflow_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [RagPipelineWorkflowSyncResponse](#ragpipelineworkflowsyncresponse)<br> |

### [POST] /refresh-token
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /remote-files/upload
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RemoteFileUploadPayload](#remotefileuploadpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | File uploaded successfully | **application/json**: [FileWithSignedUrl](#filewithsignedurl)<br> |

### [GET] /remote-files/{url}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| url | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [RemoteFileInfo](#remotefileinfo)<br> |

### [POST] /reset-password
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EmailPayload](#emailpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |

### [POST] /rule-code-generate
Generate code rules using LLM

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RuleCodeGeneratePayload](#rulecodegeneratepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Code rules generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### [POST] /rule-generate
Generate rule configuration using LLM

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RuleGeneratePayload](#rulegeneratepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Rule configuration generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### [POST] /rule-structured-output-generate
Generate structured output rules using LLM

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [RuleStructuredOutputPayload](#rulestructuredoutputpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Structured output generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### [GET] /snippets/{snippet_id}/workflow-runs
**List workflow runs for snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs retrieved successfully | **application/json**: [WorkflowRunPaginationResponse](#workflowrunpaginationresponse)<br> |

### [POST] /snippets/{snippet_id}/workflow-runs/tasks/{task_id}/stop
**Stop a running snippet workflow task**

Uses both the legacy stop flag mechanism and the graph engine
command channel for backward compatibility.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Task stopped successfully |
| 404 | Snippet not found |

### [GET] /snippets/{snippet_id}/workflow-runs/{run_id}
**Get workflow run detail for snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| run_id | path |  | Yes | string |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow run detail retrieved successfully | **application/json**: [WorkflowRunDetailResponse](#workflowrundetailresponse)<br> |
| 404 | Workflow run not found |  |

### [GET] /snippets/{snippet_id}/workflow-runs/{run_id}/node-executions
**List node executions for a workflow run**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| run_id | path |  | Yes | string |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node executions retrieved successfully | **application/json**: [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse)<br> |

### [GET] /snippets/{snippet_id}/workflows
**Get all published workflow versions for snippet**

Get all published workflows for a snippet

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path | Snippet ID | Yes | string |
| limit | query |  | No | integer, <br>**Default:** 10 |
| page | query |  | No | integer, <br>**Default:** 1 |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | **application/json**: [WorkflowPaginationResponse](#workflowpaginationresponse)<br> |

### [GET] /snippets/{snippet_id}/workflows/default-workflow-block-configs
**Get default block configurations for snippet workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Default block configs retrieved successfully |

### [GET] /snippets/{snippet_id}/workflows/draft
**Get draft workflow for snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow retrieved successfully | **application/json**: [SnippetWorkflowResponse](#snippetworkflowresponse)<br> |
| 404 | Snippet or draft workflow not found |  |

### [POST] /snippets/{snippet_id}/workflows/draft
**Sync draft workflow for snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SnippetDraftSyncPayload](#snippetdraftsyncpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Draft workflow synced successfully |
| 400 | Hash mismatch |

### [GET] /snippets/{snippet_id}/workflows/draft/config
**Get snippet draft workflow configuration limits**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Draft config retrieved successfully |

### [GET] /snippets/{snippet_id}/workflows/draft/conversation-variables
Conversation variables are not used in snippet workflows; returns an empty list for API parity

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Conversation variables retrieved successfully | **application/json**: [WorkflowDraftVariableList](#workflowdraftvariablelist)<br> |

### [GET] /snippets/{snippet_id}/workflows/draft/environment-variables
Get environment variables from snippet draft workflow graph

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Environment variables retrieved successfully |
| 404 | Draft workflow not found |

### [POST] /snippets/{snippet_id}/workflows/draft/iteration/nodes/{node_id}/run
**Run a draft workflow iteration node for snippet**

Run draft workflow iteration node for snippet
Iteration nodes execute their internal sub-graph multiple times over an input list.
Returns an SSE event stream with iteration progress and results.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path | Node ID | Yes | string |
| snippet_id | path | Snippet ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SnippetIterationNodeRunPayload](#snippetiterationnoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Iteration node run started successfully (SSE stream) |
| 404 | Snippet or draft workflow not found |

### [POST] /snippets/{snippet_id}/workflows/draft/loop/nodes/{node_id}/run
**Run a draft workflow loop node for snippet**

Run draft workflow loop node for snippet
Loop nodes execute their internal sub-graph repeatedly until a condition is met.
Returns an SSE event stream with loop progress and results.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path | Node ID | Yes | string |
| snippet_id | path | Snippet ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SnippetLoopNodeRunPayload](#snippetloopnoderunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Loop node run started successfully (SSE stream) |
| 404 | Snippet or draft workflow not found |

### [GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/last-run
**Get the last run result for a specific node in snippet draft workflow**

Get last run result for a node in snippet draft workflow
Returns the most recent execution record for the given node,
including status, inputs, outputs, and timing information.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path | Node ID | Yes | string |
| snippet_id | path | Snippet ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node last run retrieved successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
| 404 | Snippet, draft workflow, or node last run not found |  |

### [POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/run
**Run a single node in snippet draft workflow**

Run a single node in snippet draft workflow (single-step debugging)
Executes a specific node with provided inputs for single-step debugging.
Returns the node execution result including status, outputs, and timing.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path | Node ID | Yes | string |
| snippet_id | path | Snippet ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SnippetDraftNodeRunPayload](#snippetdraftnoderunpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node run completed successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
| 404 | Snippet or draft workflow not found |  |

### [DELETE] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/variables
Delete all variables for a specific node (snippet draft workflow)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Node variables deleted successfully |

### [GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/variables
Get variables for a specific node (snippet draft workflow)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node variables retrieved successfully | **application/json**: [WorkflowDraftVariableList](#workflowdraftvariablelist)<br> |

### [POST] /snippets/{snippet_id}/workflows/draft/run
**Run draft workflow for snippet**

Executes the snippet's draft workflow with the provided inputs
and returns an SSE event stream with execution progress and results.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SnippetDraftRunPayload](#snippetdraftrunpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Draft workflow run started successfully (SSE stream) |
| 404 | Snippet or draft workflow not found |

### [GET] /snippets/{snippet_id}/workflows/draft/system-variables
System variables are not used in snippet workflows; returns an empty list for API parity

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | System variables retrieved successfully | **application/json**: [WorkflowDraftVariableList](#workflowdraftvariablelist)<br> |

### [DELETE] /snippets/{snippet_id}/workflows/draft/variables
Delete all draft workflow variables for the current user (snippet scope)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Workflow variables deleted successfully |

### [GET] /snippets/{snippet_id}/workflows/draft/variables
List draft workflow variables without values (paginated, snippet scope)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| limit | query | Items per page | No | integer, <br>**Default:** 20 |
| page | query | Page number | No | integer, <br>**Default:** 1 |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow variables retrieved successfully | **application/json**: [WorkflowDraftVariableListWithoutValue](#workflowdraftvariablelistwithoutvalue)<br> |

### [DELETE] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
Delete a draft workflow variable (snippet scope)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Variable deleted successfully |
| 404 | Variable not found |

### [GET] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
Get a specific draft workflow variable (snippet scope)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable retrieved successfully | **application/json**: [WorkflowDraftVariable](#workflowdraftvariable)<br> |
| 404 | Variable not found |  |

### [PATCH] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
Update a draft workflow variable (snippet scope)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowDraftVariableUpdatePayload](#workflowdraftvariableupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable updated successfully | **application/json**: [WorkflowDraftVariable](#workflowdraftvariable)<br> |
| 404 | Variable not found |  |

### [PUT] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}/reset
Reset a draft workflow variable to its default value (snippet scope)

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable reset successfully | **application/json**: [WorkflowDraftVariable](#workflowdraftvariable)<br> |
| 204 | Variable reset (no content) |  |
| 404 | Variable not found |  |

### [GET] /snippets/{snippet_id}/workflows/publish
**Get published workflow for snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflow retrieved successfully | **application/json**: [SnippetWorkflowResponse](#snippetworkflowresponse)<br> |
| 404 | Snippet not found |  |

### [POST] /snippets/{snippet_id}/workflows/publish
**Publish snippet workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [PublishWorkflowPayload](#publishworkflowpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow published successfully |
| 400 | No draft workflow found |

### [POST] /snippets/{snippet_id}/workflows/{workflow_id}/restore
**Restore a published snippet workflow version into the draft workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path | Snippet ID | Yes | string |
| workflow_id | path | Published workflow ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow restored successfully |
| 400 | Source workflow must be published |
| 404 | Workflow not found |

### [GET] /spec/schema-definitions
**Get system JSON Schema definitions specification**

Used for frontend component type mapping

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /system-features
**Get system-wide feature configuration**

Get system-wide feature configuration
NOTE: This endpoint is unauthenticated by design, as it provides system features
data required for dashboard initialization.

Authentication would create circular dependency (can't login without dashboard loading).

Only non-sensitive configuration data should be returned by this endpoint.

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SystemFeatureModel](#systemfeaturemodel)<br> |

### [POST] /tag-bindings
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TagBindingPayload](#tagbindingpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /tag-bindings/remove
Remove one or more tag bindings from a target.

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TagBindingRemovePayload](#tagbindingremovepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /tags
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| keyword | query | Search keyword for tag name. | No | string |
| type | query | Tag type filter. Can be "knowledge", "app", or "snippet". | No | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ [TagResponse](#tagresponse) ]<br> |

### [POST] /tags
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TagBasePayload](#tagbasepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TagResponse](#tagresponse)<br> |

### [DELETE] /tags/{tag_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| tag_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Tag deleted successfully |

### [PATCH] /tags/{tag_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| tag_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TagUpdateRequestPayload](#tagupdaterequestpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TagResponse](#tagresponse)<br> |

### [POST] /test/retrieval
Bedrock retrieval test (internal use only)

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BedrockRetrievalPayload](#bedrockretrievalpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Bedrock retrieval test completed |

### [GET] /trial-apps/{app_id}
**Get app detail**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /trial-apps/{app_id}/audio-to-text
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /trial-apps/{app_id}/chat-messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ChatRequest](#chatrequest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /trial-apps/{app_id}/completion-messages
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CompletionRequest](#completionrequest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /trial-apps/{app_id}/datasets
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /trial-apps/{app_id}/messages/{message_id}/suggested-questions
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /trial-apps/{app_id}/parameters
**Retrieve app parameters**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /trial-apps/{app_id}/site
**Retrieve app site info**

Returns the site configuration for the application including theme, icons, and text.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /trial-apps/{app_id}/text-to-audio
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TextToSpeechRequest](#texttospeechrequest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /trial-apps/{app_id}/workflows
**Get workflow detail**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /trial-apps/{app_id}/workflows/run
**Run workflow**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowRunRequest](#workflowrunrequest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /trial-apps/{app_id}/workflows/tasks/{task_id}/stop
**Stop workflow task**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /trial-models
**Get hosted trial model provider configuration for model-provider pages**

Get hosted trial model provider configuration

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TrialModelsResponse](#trialmodelsresponse)<br> |

### [POST] /website/crawl
Crawl website content

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WebsiteCrawlPayload](#websitecrawlpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Website crawl initiated successfully |
| 400 | Invalid crawl parameters |

### [GET] /website/crawl/status/{job_id}
Get website crawl status

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| job_id | path | Crawl job ID | Yes | string |
| provider | query | Crawl provider (firecrawl/watercrawl/jinareader) | Yes | string, <br>**Available values:** "firecrawl", "jinareader", "watercrawl" |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Crawl status retrieved successfully |
| 400 | Invalid provider |
| 404 | Crawl job not found |

### [POST] /workflow-generate
Generate a Dify workflow graph from natural language

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowGeneratePayload](#workflowgeneratepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow graph generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### [GET] /workflow/{workflow_run_id}/events
**Get workflow execution events stream after resume**

GET /console/api/workflow/<workflow_run_id>/events

Returns Server-Sent Events stream.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| workflow_run_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workflow/{workflow_run_id}/pause-details
**Get workflow pause details**

Get workflow pause details
GET /console/api/workflow/<workflow_run_id>/pause-details

Returns information about why and where the workflow is paused.

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| workflow_run_id | path | Workflow run ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow pause details retrieved successfully | **application/json**: [WorkflowPauseDetailsResponse](#workflowpausedetailsresponse)<br> |
| 404 | Workflow run not found |  |

### [GET] /workspaces
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [TenantInfoResponse](#tenantinforesponse)<br> |

### [GET] /workspaces/current/agent-provider/{provider_name}
Get specific agent provider details

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_name | path | Agent provider name | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: object<br> |

### [GET] /workspaces/current/agent-providers
Get list of available agent providers

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [ object ]<br> |

### [GET] /workspaces/current/customized-snippets
**List customized snippets with pagination and search**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| creators | query | Filter by creator account IDs | No | [ string ] |
| is_published | query | Filter by published status | No | boolean |
| keyword | query |  | No | string |
| limit | query |  | No | integer, <br>**Default:** 20 |
| page | query |  | No | integer, <br>**Default:** 1 |
| tag_ids | query | Filter by tag IDs | No | [ string ] |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Snippets retrieved successfully | **application/json**: [SnippetPagination](#snippetpagination)<br> |

### [POST] /workspaces/current/customized-snippets
**Create a new customized snippet**

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [CreateSnippetPayload](#createsnippetpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Snippet created successfully | **application/json**: [Snippet](#snippet)<br> |
| 400 | Invalid request |  |

### [POST] /workspaces/current/customized-snippets/imports
**Import snippet from DSL**

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SnippetImportPayload](#snippetimportpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Snippet imported successfully |
| 202 | Import pending confirmation |
| 400 | Import failed |

### [POST] /workspaces/current/customized-snippets/imports/{import_id}/confirm
**Confirm a pending snippet import**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| import_id | path | Import ID to confirm | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Import confirmed successfully |
| 400 | Import failed |

### [DELETE] /workspaces/current/customized-snippets/{snippet_id}
**Delete customized snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Snippet deleted successfully |
| 404 | Snippet not found |

### [GET] /workspaces/current/customized-snippets/{snippet_id}
**Get customized snippet details**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Snippet retrieved successfully | **application/json**: [Snippet](#snippet)<br> |
| 404 | Snippet not found |  |

### [PATCH] /workspaces/current/customized-snippets/{snippet_id}
**Update customized snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [UpdateSnippetPayload](#updatesnippetpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Snippet updated successfully | **application/json**: [Snippet](#snippet)<br> |
| 400 | Invalid request |  |
| 404 | Snippet not found |  |

### [GET] /workspaces/current/customized-snippets/{snippet_id}/check-dependencies
**Check dependencies for a snippet**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path | Snippet ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Dependencies checked successfully |
| 404 | Snippet not found |

### [GET] /workspaces/current/customized-snippets/{snippet_id}/export
**Export snippet as DSL**

Export snippet configuration as DSL

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path | Snippet ID to export | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Snippet exported successfully |
| 404 | Snippet not found |

### [POST] /workspaces/current/customized-snippets/{snippet_id}/use-count/increment
**Increment snippet use count when it is inserted into a workflow**

Increment snippet use count by 1

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| snippet_id | path | Snippet ID | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Use count incremented successfully |
| 404 | Snippet not found |

### [GET] /workspaces/current/dataset-operators
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AccountWithRoleList](#accountwithrolelist)<br> |

### [GET] /workspaces/current/default-model
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| model_type | query | Enum class for model type. | Yes | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/default-model
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPostDefault](#parserpostdefault)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /workspaces/current/endpoints
Create a new plugin endpoint

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EndpointCreatePayload](#endpointcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint created successfully | **application/json**: [EndpointCreateResponse](#endpointcreateresponse)<br> |
| 403 | Admin privileges required |  |

### ~~[POST] /workspaces/current/endpoints/create~~

***DEPRECATED***

Deprecated legacy alias for creating a plugin endpoint. Use POST /workspaces/current/endpoints instead.

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EndpointCreatePayload](#endpointcreatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint created successfully | **application/json**: [EndpointCreateResponse](#endpointcreateresponse)<br> |
| 403 | Admin privileges required |  |

### ~~[POST] /workspaces/current/endpoints/delete~~

***DEPRECATED***

Deprecated legacy alias for deleting a plugin endpoint. Use DELETE /workspaces/current/endpoints/{id} instead.

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EndpointIdPayload](#endpointidpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint deleted successfully | **application/json**: [EndpointDeleteResponse](#endpointdeleteresponse)<br> |
| 403 | Admin privileges required |  |

### [POST] /workspaces/current/endpoints/disable
Disable a plugin endpoint

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EndpointIdPayload](#endpointidpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint disabled successfully | **application/json**: [EndpointDisableResponse](#endpointdisableresponse)<br> |
| 403 | Admin privileges required |  |

### [POST] /workspaces/current/endpoints/enable
Enable a plugin endpoint

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EndpointIdPayload](#endpointidpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint enabled successfully | **application/json**: [EndpointEnableResponse](#endpointenableresponse)<br> |
| 403 | Admin privileges required |  |

### [GET] /workspaces/current/endpoints/list
List plugin endpoints with pagination

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| page | query |  | Yes | integer |
| page_size | query |  | Yes | integer |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [EndpointListResponse](#endpointlistresponse)<br> |

### [GET] /workspaces/current/endpoints/list/plugin
List endpoints for a specific plugin

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| page | query |  | Yes | integer |
| page_size | query |  | Yes | integer |
| plugin_id | query |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [PluginEndpointListResponse](#pluginendpointlistresponse)<br> |

### ~~[POST] /workspaces/current/endpoints/update~~

***DEPRECATED***

Deprecated legacy alias for updating a plugin endpoint. Use PATCH /workspaces/current/endpoints/{id} instead.

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [LegacyEndpointUpdatePayload](#legacyendpointupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint updated successfully | **application/json**: [EndpointUpdateResponse](#endpointupdateresponse)<br> |
| 403 | Admin privileges required |  |

### [DELETE] /workspaces/current/endpoints/{id}
Delete a plugin endpoint

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| id | path | Endpoint ID | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint deleted successfully | **application/json**: [EndpointDeleteResponse](#endpointdeleteresponse)<br> |
| 403 | Admin privileges required |  |

### [PATCH] /workspaces/current/endpoints/{id}
Update a plugin endpoint

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| id | path | Endpoint ID | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [EndpointUpdatePayload](#endpointupdatepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint updated successfully | **application/json**: [EndpointUpdateResponse](#endpointupdateresponse)<br> |
| 403 | Admin privileges required |  |

### [GET] /workspaces/current/members
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [AccountWithRoleList](#accountwithrolelist)<br> |

### [POST] /workspaces/current/members/invite-email
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MemberInvitePayload](#memberinvitepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/members/owner-transfer-check
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [OwnerTransferCheckPayload](#ownertransfercheckpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [VerificationTokenResponse](#verificationtokenresponse)<br> |

### [POST] /workspaces/current/members/send-owner-transfer-confirm-email
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [OwnerTransferEmailPayload](#ownertransferemailpayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |

### [DELETE] /workspaces/current/members/{member_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| member_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/members/{member_id}/owner-transfer
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| member_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [OwnerTransferPayload](#ownertransferpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PUT] /workspaces/current/members/{member_id}/update-role
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| member_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MemberRoleUpdatePayload](#memberroleupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/model-providers
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| model_type | query | Enum class for model type. | No | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/model-providers/{provider}/checkout-url
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /workspaces/current/model-providers/{provider}/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserCredentialDelete](#parsercredentialdelete)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Credential deleted successfully |

### [GET] /workspaces/current/model-providers/{provider}/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| credential_id | query |  | No | string |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserCredentialCreate](#parsercredentialcreate)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PUT] /workspaces/current/model-providers/{provider}/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserCredentialUpdate](#parsercredentialupdate)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/credentials/switch
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserCredentialSwitch](#parsercredentialswitch)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /workspaces/current/model-providers/{provider}/credentials/validate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserCredentialValidate](#parsercredentialvalidate)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /workspaces/current/model-providers/{provider}/models
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserDeleteModels](#parserdeletemodels)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Model deleted successfully |

### [GET] /workspaces/current/model-providers/{provider}/models
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/models
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPostModels](#parserpostmodels)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /workspaces/current/model-providers/{provider}/models/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserDeleteCredential](#parserdeletecredential)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Credential deleted successfully |

### [GET] /workspaces/current/model-providers/{provider}/models/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| config_from | query |  | No | string |
| credential_id | query |  | No | string |
| model | query |  | Yes | string |
| model_type | query | Enum class for model type. | Yes | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/models/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserCreateCredential](#parsercreatecredential)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PUT] /workspaces/current/model-providers/{provider}/models/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserUpdateCredential](#parserupdatecredential)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/models/credentials/switch
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserSwitch](#parserswitch)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /workspaces/current/model-providers/{provider}/models/credentials/validate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserValidate](#parservalidate)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PATCH] /workspaces/current/model-providers/{provider}/models/disable
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserDeleteModels](#parserdeletemodels)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [PATCH] /workspaces/current/model-providers/{provider}/models/enable
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserDeleteModels](#parserdeletemodels)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /workspaces/current/model-providers/{provider}/models/load-balancing-configs/credentials-validate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [LoadBalancingCredentialPayload](#loadbalancingcredentialpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/models/load-balancing-configs/{config_id}/credentials-validate
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| config_id | path |  | Yes | string |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [LoadBalancingCredentialPayload](#loadbalancingcredentialpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/model-providers/{provider}/models/parameter-rules
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| model | query |  | Yes | string |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/model-providers/{provider}/preferred-provider-type
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPreferredProviderType](#parserpreferredprovidertype)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [GET] /workspaces/current/models/model-types/{model_type}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| model_type | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/permission
**Get workspace permission settings**

Returns permission flags that control workspace features like member invitations and owner transfer.

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [WorkspacePermissionResponse](#workspacepermissionresponse)<br> |

### [GET] /workspaces/current/plugin/asset
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| file_name | query |  | Yes | string |
| plugin_unique_identifier | query |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/debugging-key
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [PluginDebuggingKeyResponse](#plugindebuggingkeyresponse)<br> |

### [GET] /workspaces/current/plugin/fetch-manifest
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| plugin_unique_identifier | query |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/icon
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| filename | query |  | Yes | string |
| tenant_id | query |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/install/github
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserGithubInstall](#parsergithubinstall)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/install/marketplace
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPluginIdentifiers](#parserpluginidentifiers)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/install/pkg
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPluginIdentifiers](#parserpluginidentifiers)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/list
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| page | query | Page number | No | integer, <br>**Default:** 1 |
| page_size | query | Page size (1-256) | No | integer, <br>**Default:** 256 |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/list/installations/ids
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserLatest](#parserlatest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/list/latest-versions
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserLatest](#parserlatest)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/marketplace/pkg
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| plugin_unique_identifier | query |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/parameters/dynamic-options
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| action | query |  | Yes | string |
| credential_id | query |  | No | string |
| parameter | query |  | Yes | string |
| plugin_id | query |  | Yes | string |
| provider | query |  | Yes | string |
| provider_type | query |  | Yes | string, <br>**Available values:** "tool", "trigger" |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/parameters/dynamic-options-with-credentials
**Fetch dynamic options using credentials directly (for edit mode)**

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserDynamicOptionsWithCredentials](#parserdynamicoptionswithcredentials)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/permission/change
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPermissionChange](#parserpermissionchange)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |

### [GET] /workspaces/current/plugin/permission/fetch
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/preferences/autoupgrade/exclude
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserExcludePlugin](#parserexcludeplugin)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/preferences/change
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserPreferencesChange](#parserpreferenceschange)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/preferences/fetch
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/readme
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| language | query |  | No | string, <br>**Default:** en-US |
| plugin_unique_identifier | query |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/plugin/tasks
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| page | query | Page number | No | integer, <br>**Default:** 1 |
| page_size | query | Page size (1-256) | No | integer, <br>**Default:** 256 |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/tasks/delete_all
#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |

### [GET] /workspaces/current/plugin/tasks/{task_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/tasks/{task_id}/delete
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |

### [POST] /workspaces/current/plugin/tasks/{task_id}/delete/{identifier}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| identifier | path |  | Yes | string |
| task_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |

### [POST] /workspaces/current/plugin/uninstall
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserUninstall](#parseruninstall)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |

### [POST] /workspaces/current/plugin/upgrade/github
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserGithubUpgrade](#parsergithubupgrade)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/upgrade/marketplace
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserMarketplaceUpgrade](#parsermarketplaceupgrade)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/upload/bundle
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/upload/github
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ParserGithubUpload](#parsergithubupload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/plugin/upload/pkg
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-labels
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/api/add
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ApiToolProviderAddPayload](#apitoolprovideraddpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/api/delete
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ApiToolProviderDeletePayload](#apitoolproviderdeletepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/api/get
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/api/remote
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/api/schema
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ApiToolSchemaPayload](#apitoolschemapayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/api/test/pre
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ApiToolTestPayload](#apitooltestpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/api/tools
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/api/update
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ApiToolProviderUpdatePayload](#apitoolproviderupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/builtin/{provider}/add
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BuiltinToolAddPayload](#builtintooladdpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/credential/info
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/credential/schema/{credential_type}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| credential_type | path |  | Yes | string |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/credentials
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/builtin/{provider}/default-credential
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BuiltinProviderDefaultCredentialPayload](#builtinproviderdefaultcredentialpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/builtin/{provider}/delete
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BuiltinToolCredentialDeletePayload](#builtintoolcredentialdeletepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/icon
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/info
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/client-schema
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [ToolOAuthCustomClientPayload](#tooloauthcustomclientpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/builtin/{provider}/tools
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/builtin/{provider}/update
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [BuiltinToolUpdatePayload](#builtintoolupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /workspaces/current/tool-provider/mcp
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MCPProviderDeletePayload](#mcpproviderdeletepayload)<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /workspaces/current/tool-provider/mcp
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MCPProviderCreatePayload](#mcpprovidercreatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [PUT] /workspaces/current/tool-provider/mcp
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MCPProviderUpdatePayload](#mcpproviderupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/mcp/auth
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [MCPAuthPayload](#mcpauthpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/mcp/tools/{provider_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/mcp/update/{provider_id}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/workflow/create
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowToolCreatePayload](#workflowtoolcreatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/workflow/delete
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowToolDeletePayload](#workflowtooldeletepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/workflow/get
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-provider/workflow/tools
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/tool-provider/workflow/update
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkflowToolUpdatePayload](#workflowtoolupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tool-providers
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tools/api
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tools/builtin
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tools/mcp
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/tools/workflow
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/icon
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/info
**Get info for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [DELETE] /workspaces/current/trigger-provider/{provider}/oauth/client
**Remove custom OAuth client configuration**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/oauth/client
**Get OAuth client configuration for a provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{provider}/oauth/client
**Configure custom OAuth client for a provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerOAuthClientPayload](#triggeroauthclientpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/build/{subscription_builder_id}
**Build a subscription instance for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| subscription_builder_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/create
**Add a new subscription instance for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerSubscriptionBuilderCreatePayload](#triggersubscriptionbuildercreatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/logs/{subscription_builder_id}
**Get the request logs for a subscription instance for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| subscription_builder_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/update/{subscription_builder_id}
**Update a subscription instance for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| subscription_builder_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/verify-and-update/{subscription_builder_id}
**Verify and update a subscription instance for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| subscription_builder_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerSubscriptionBuilderVerifyPayload](#triggersubscriptionbuilderverifypayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/{subscription_builder_id}
**Get a subscription instance for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| subscription_builder_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/list
**List all trigger subscriptions for the current tenant's provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/oauth/authorize
**Initiate OAuth authorization flow for a trigger provider**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/verify/{subscription_id}
**Verify credentials for an existing subscription (edit mode only)**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| subscription_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerSubscriptionBuilderVerifyPayload](#triggersubscriptionbuilderverifypayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/delete
**Delete a subscription instance**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| subscription_id | path |  | Yes | string |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |

### [POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/update
**Update a subscription instance**

#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| subscription_id | path |  | Yes | string |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/current/triggers
**List all trigger providers for the current tenant**

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/custom-config
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkspaceCustomConfigPayload](#workspacecustomconfigpayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/custom-config/webapp-logo/upload
#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/info
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [WorkspaceInfoPayload](#workspaceinfopayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [POST] /workspaces/switch
#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SwitchWorkspacePayload](#switchworkspacepayload)<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

### [GET] /workspaces/{tenant_id}/model-providers/{provider}/{icon_type}/{lang}
#### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| icon_type | path |  | Yes | string |
| lang | path |  | Yes | string |
| provider | path |  | Yes | string |
| tenant_id | path |  | Yes | string |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

---
## default
Default namespace

### [GET] /explore/banners
**Get banner list**

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Success |

---
### Schemas

#### APIBasedExtensionListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| APIBasedExtensionListResponse | array |  |  |

#### APIBasedExtensionPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| api_endpoint | string | API endpoint URL | Yes |
| api_key | string | API key for authentication | Yes |
| name | string | Extension name | Yes |

#### APIBasedExtensionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| api_endpoint | string |  | Yes |
| api_key | string |  | Yes |
| created_at | integer |  | No |
| id | string |  | Yes |
| name | string |  | Yes |

#### Account

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar | string |  | No |
| avatar_url | string |  | Yes |
| created_at | integer |  | No |
| email | string |  | Yes |
| id | string |  | Yes |
| interface_language | string |  | No |
| interface_theme | string |  | No |
| is_password_set | boolean |  | Yes |
| last_login_at | integer |  | No |
| last_login_ip | string |  | No |
| name | string |  | Yes |
| timezone | string |  | No |

#### AccountAvatarPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar | string |  | Yes |

#### AccountAvatarQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar | string | Avatar file ID | Yes |

#### AccountDeletePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| token | string |  | Yes |

#### AccountDeletionFeedbackPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| feedback | string |  | Yes |

#### AccountInitPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interface_language | string |  | Yes |
| invitation_code | string |  | No |
| timezone | string |  | Yes |

#### AccountIntegrateListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AccountIntegrateResponse](#accountintegrateresponse) ] |  | Yes |

#### AccountIntegrateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| is_bound | boolean |  | Yes |
| link | string |  | No |
| provider | string |  | Yes |

#### AccountInterfaceLanguagePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interface_language | string |  | Yes |

#### AccountInterfaceThemePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interface_theme | string, <br>**Available values:** "dark", "light" | *Enum:* `"dark"`, `"light"` | Yes |

#### AccountNamePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |

#### AccountPasswordPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_password | string |  | Yes |
| password | string |  | No |
| repeat_new_password | string |  | Yes |

#### AccountTimezonePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timezone | string |  | Yes |

#### AccountWithRole

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar | string |  | No |
| created_at | integer |  | No |
| email | string |  | Yes |
| id | string |  | Yes |
| last_active_at | integer |  | No |
| last_login_at | integer |  | No |
| name | string |  | Yes |
| role | string |  | Yes |
| status | string |  | Yes |

#### AccountWithRoleList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| accounts | [ [AccountWithRole](#accountwithrole) ] |  | Yes |

#### ActivateCheckQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | No |
| token | string |  | Yes |
| workspace_id | string |  | No |

#### ActivatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | No |
| interface_language | string |  | Yes |
| name | string |  | Yes |
| timezone | string |  | Yes |
| token | string |  | Yes |
| workspace_id | string |  | No |

#### ActivationCheckData

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| workspace_id | string |  | Yes |
| workspace_name | string |  | Yes |

#### ActivationCheckResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ActivationCheckData](#activationcheckdata) | Activation data if valid | No |
| is_valid | boolean | Whether token is valid | Yes |

#### ActivationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result | Yes |

#### AdvancedChatWorkflowRunForListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string |  | No |
| created_at | integer |  | No |
| created_by_account | [SimpleAccount](#simpleaccount) |  | No |
| elapsed_time | number |  | No |
| exceptions_count | integer |  | No |
| finished_at | integer |  | No |
| id | string |  | Yes |
| message_id | string |  | No |
| retry_index | integer |  | No |
| status | string |  | No |
| total_steps | integer |  | No |
| total_tokens | integer |  | No |
| version | string |  | No |

#### AdvancedChatWorkflowRunPaginationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AdvancedChatWorkflowRunForListResponse](#advancedchatworkflowrunforlistresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |

#### AdvancedChatWorkflowRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string |  | No |
| files | [ object ] |  | No |
| inputs | object |  | No |
| parent_message_id | string |  | No |
| query | string |  | No |

#### AdvancedPromptTemplateQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_mode | string | Application mode | Yes |
| has_context | string, <br>**Default:** true | Whether has context | No |
| model_mode | string | Model mode | Yes |
| model_name | string | Model name | Yes |

#### AgentAppComposerResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) |  | Yes |
| agent | [AgentComposerAgentResponse](#agentcomposeragentresponse) |  | Yes |
| agent_soul | [AgentSoulConfig](#agentsoulconfig) |  | Yes |
| save_options | [ [ComposerSaveStrategy](#composersavestrategy) ] |  | Yes |
| validation | [ComposerValidationFindingsResponse](#composervalidationfindingsresponse) |  | No |
| variant | string |  | Yes |

#### AgentAppFeaturesPayload

Presentation features configurable on an Agent App.

All fields are optional; an omitted field is reset to its disabled/empty
default (the config form sends the full desired feature state on save).

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| opening_statement | string | Conversation opener shown before the first turn | No |
| retriever_resource | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) | Citations / attributions config, e.g. {'enabled': true} | No |
| sensitive_word_avoidance | [AgentSensitiveWordAvoidanceFeatureConfig](#agentsensitivewordavoidancefeatureconfig) | Content moderation config | No |
| speech_to_text | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) | Speech-to-text config | No |
| suggested_questions | [ string ] | Preset questions shown alongside the opener | No |
| suggested_questions_after_answer | [AgentSuggestedQuestionsAfterAnswerFeatureConfig](#agentsuggestedquestionsafteranswerfeatureconfig) | Follow-up suggestions config, e.g. {'enabled': true} | No |
| text_to_speech | [AgentTextToSpeechFeatureConfig](#agenttexttospeechfeatureconfig) | Text-to-speech config | No |

#### AgentCliToolAuthorizationStatus

Authorization state for Agent-scoped CLI tools.

Missing status keeps backward compatibility with draft rows and CLI tools that
do not need pre-authorization. Explicit denied-like states are blocked by the
composer/publish validators and skipped by runtime request builders.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentCliToolAuthorizationStatus | string | Authorization state for Agent-scoped CLI tools.  Missing status keeps backward compatibility with draft rows and CLI tools that do not need pre-authorization. Explicit denied-like states are blocked by the composer/publish validators and skipped by runtime request builders. |  |

#### AgentCliToolConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| approved | boolean |  | No |
| authorization_status | [AgentCliToolAuthorizationStatus](#agentclitoolauthorizationstatus) |  | No |
| command | string |  | No |
| dangerous | boolean |  | No |
| dangerous_accepted | boolean |  | No |
| dangerous_acknowledged | boolean |  | No |
| dangerous_command | boolean |  | No |
| description | string |  | No |
| enabled | boolean, <br>**Default:** true |  | No |
| env | [AgentCliToolEnvConfig](#agentclitoolenvconfig) |  | No |
| id | string |  | No |
| install | string |  | No |
| install_command | string |  | No |
| install_commands | [ string ] |  | No |
| invoke_metadata | object |  | No |
| label | string |  | No |
| name | string |  | No |
| permission | [AgentPermissionConfig](#agentpermissionconfig) |  | No |
| pre_authorized | boolean |  | No |
| requires_confirmation | boolean |  | No |
| risk_accepted | boolean |  | No |
| risk_level | [AgentCliToolRiskLevel](#agentclitoolrisklevel) |  | No |
| setup_command | string |  | No |
| tool_name | string |  | No |

#### AgentCliToolEnvConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| secret_refs | [ [AgentSecretRefConfig](#agentsecretrefconfig) ] |  | No |
| variables | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] |  | No |

#### AgentCliToolRiskLevel

Risk marker for CLI tool bootstrap commands.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentCliToolRiskLevel | string | Risk marker for CLI tool bootstrap commands. |  |

#### AgentComposerAgentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_config_snapshot_id | string |  | No |
| description | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |
| scope | [AgentScope](#agentscope) |  | Yes |
| status | [AgentStatus](#agentstatus) |  | Yes |

#### AgentComposerBindingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_id | string |  | No |
| binding_type | [WorkflowAgentBindingType](#workflowagentbindingtype) |  | Yes |
| current_snapshot_id | string |  | No |
| id | string |  | Yes |
| node_id | string |  | Yes |
| workflow_id | string |  | Yes |

#### AgentComposerCandidatesResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_node_job_candidates | [AgentComposerNodeJobCandidatesResponse](#agentcomposernodejobcandidatesresponse) |  | No |
| allowed_soul_candidates | [AgentComposerSoulCandidatesResponse](#agentcomposersoulcandidatesresponse) |  | No |
| capabilities | [ComposerCandidateCapabilities](#composercandidatecapabilities) |  | No |
| truncated | boolean |  | No |
| variant | [ComposerVariant](#composervariant) |  | Yes |

#### AgentComposerDifyToolCandidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| granularity | string |  | No |
| id | string |  | No |
| name | string |  | No |
| plugin_id | string |  | No |
| provider | string |  | No |
| provider_id | string |  | No |
| tools_count | integer |  | No |

#### AgentComposerFileCandidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file_id | string |  | No |
| id | string |  | No |
| kind | string, <br>**Default:** file |  | No |
| name | string |  | No |
| reference | string |  | No |
| remote_url | string |  | No |
| tenant_id | string |  | No |
| transfer_method | string |  | No |
| type | string |  | No |
| upload_file_id | string |  | No |
| url | string |  | No |

#### AgentComposerImpactBindingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | Yes |
| node_id | string |  | Yes |
| workflow_id | string |  | Yes |

#### AgentComposerImpactResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| bindings | [ [AgentComposerImpactBindingResponse](#agentcomposerimpactbindingresponse) ] |  | No |
| current_snapshot_id | string |  | No |
| workflow_node_count | integer |  | Yes |

#### AgentComposerNodeJobCandidatesResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| declare_output_types | [ [DeclaredOutputType](#declaredoutputtype) ] |  | No |
| human_contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] |  | No |
| previous_node_outputs | [ [WorkflowPreviousNodeOutputRef](#workflowpreviousnodeoutputref) ] |  | No |

#### AgentComposerSkillCandidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| file_id | string |  | No |
| id | string |  | No |
| kind | string, <br>**Default:** skill |  | No |
| name | string |  | No |
| path | string |  | No |

#### AgentComposerSoulCandidatesResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cli_tools | [ [AgentCliToolConfig](#agentclitoolconfig) ] |  | No |
| dify_tools | [ [AgentComposerDifyToolCandidateResponse](#agentcomposerdifytoolcandidateresponse) ] |  | No |
| human_contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] |  | No |
| knowledge_datasets | [ [AgentKnowledgeDatasetConfig](#agentknowledgedatasetconfig) ] |  | No |
| skills_files | [  ] |  | No |

#### AgentComposerSoulLockResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| can_unlock | boolean |  | No |
| locked | boolean |  | Yes |
| reason | string |  | No |

#### AgentComposerValidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errors | [ string ] |  | No |
| knowledge_retrieval_placeholder | [ [ComposerKnowledgePlaceholderResponse](#composerknowledgeplaceholderresponse) ] |  | No |
| result | string |  | Yes |
| warnings | [ [ComposerValidationWarningResponse](#composervalidationwarningresponse) ] |  | No |

#### AgentConfigRevisionOperation

Audit operation recorded for Agent Soul version/revision changes.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentConfigRevisionOperation | string | Audit operation recorded for Agent Soul version/revision changes. |  |

#### AgentConfigRevisionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by | string |  | No |
| current_snapshot_id | string |  | Yes |
| id | string |  | Yes |
| operation | [AgentConfigRevisionOperation](#agentconfigrevisionoperation) |  | Yes |
| previous_snapshot_id | string |  | No |
| revision | integer |  | Yes |
| summary | string |  | No |
| version_note | string |  | No |

#### AgentConfigSnapshotDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_id | string |  | No |
| config_snapshot | [AgentSoulConfig](#agentsoulconfig) |  | Yes |
| created_at | integer |  | No |
| created_by | string |  | No |
| id | string |  | Yes |
| revisions | [ [AgentConfigRevisionResponse](#agentconfigrevisionresponse) ] |  | No |
| summary | string |  | No |
| version | integer |  | Yes |
| version_note | string |  | No |

#### AgentConfigSnapshotListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) ] |  | Yes |

#### AgentConfigSnapshotSummaryResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_id | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| id | string |  | Yes |
| summary | string |  | No |
| version | integer |  | Yes |
| version_note | string |  | No |

#### AgentEnvVariableConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default | string<br>integer<br>number<br>boolean<br>[ string ]<br>[ integer ]<br>[ number ]<br>[ boolean ] |  | No |
| env_name | string |  | No |
| key | string |  | No |
| name | string |  | No |
| required | boolean |  | No |
| type | string |  | No |
| value | string<br>integer<br>number<br>boolean<br>[ string ]<br>[ integer ]<br>[ number ]<br>[ boolean ] |  | No |
| variable | string |  | No |

#### AgentFeatureToggleConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | No |

#### AgentFileRefConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file_id | string |  | No |
| id | string |  | No |
| name | string |  | No |
| reference | string |  | No |
| remote_url | string |  | No |
| tenant_id | string |  | No |
| transfer_method | string |  | No |
| type | string |  | No |
| upload_file_id | string |  | No |
| url | string |  | No |

#### AgentHumanContactConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| channel | string |  | No |
| contact_id | string |  | No |
| contact_method | string |  | No |
| email | string |  | No |
| human_id | string |  | No |
| id | string |  | No |
| method | string |  | No |
| name | string |  | No |
| tenant_id | string |  | No |

#### AgentHumanToolConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| enabled | boolean, <br>**Default:** true |  | No |
| name | string |  | No |

#### AgentIconType

Supported icon storage formats for Agent roster entries.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentIconType | string | Supported icon storage formats for Agent roster entries. |  |

#### AgentIdPath

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_id | string |  | Yes |

#### AgentInviteOptionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) |  | No |
| active_config_snapshot_id | string |  | No |
| agent_kind | [AgentKind](#agentkind) |  | Yes |
| app_id | string |  | No |
| archived_at | integer |  | No |
| archived_by | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| description | string |  | Yes |
| existing_node_ids | [ string ] |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | [AgentIconType](#agenticontype) |  | No |
| id | string |  | Yes |
| in_current_workflow_count | integer |  | No |
| is_in_current_workflow | boolean |  | No |
| name | string |  | Yes |
| published_node_reference_count | integer |  | No |
| published_reference_count | integer |  | No |
| published_references | [ [AgentPublishedReferenceResponse](#agentpublishedreferenceresponse) ] |  | No |
| role | string |  | No |
| scope | [AgentScope](#agentscope) |  | Yes |
| source | [AgentSource](#agentsource) |  | Yes |
| status | [AgentStatus](#agentstatus) |  | Yes |
| updated_at | integer |  | No |
| updated_by | string |  | No |
| workflow_id | string |  | No |
| workflow_node_id | string |  | No |

#### AgentInviteOptionsQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string | Workflow app id for in-current-workflow markers | No |
| keyword | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer, <br>**Default:** 1 |  | No |

#### AgentInviteOptionsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AgentInviteOptionResponse](#agentinviteoptionresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### AgentKind

Agent implementation family.

This leaves room for future non-Dify agent implementations while keeping
the current roster/workflow APIs scoped to Dify Agent.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentKind | string | Agent implementation family.  This leaves room for future non-Dify agent implementations while keeping the current roster/workflow APIs scoped to Dify Agent. |  |

#### AgentKnowledgeDatasetConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| id | string |  | No |
| name | string |  | No |

#### AgentKnowledgeQueryConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| query | string |  | No |
| score_threshold | number |  | No |
| score_threshold_enabled | boolean |  | No |
| top_k | integer |  | No |

#### AgentKnowledgeQueryMode

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentKnowledgeQueryMode | string |  |  |

#### AgentLogQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation UUID | Yes |
| message_id | string | Message UUID | Yes |

#### AgentMemoryArtifactConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| name | string |  | No |
| type | string |  | No |
| url | string |  | No |

#### AgentModelResponseFormatConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string |  | No |

#### AgentModerationIOConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | No |
| preset_response | string |  | No |

#### AgentModerationProviderConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| api_based_extension_id | string |  | No |
| inputs_config | [AgentModerationIOConfig](#agentmoderationioconfig) |  | No |
| keywords | string |  | No |
| outputs_config | [AgentModerationIOConfig](#agentmoderationioconfig) |  | No |

#### AgentPermissionConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed | boolean |  | No |
| state | string |  | No |
| status | string |  | No |

#### AgentPublishedReferenceResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | Yes |
| app_mode | string |  | Yes |
| app_name | string |  | Yes |
| node_ids | [ string ] |  | No |
| workflow_id | string |  | Yes |
| workflow_version | string |  | Yes |

#### AgentReferencingWorkflowResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | Yes |
| app_mode | string |  | Yes |
| app_name | string |  | Yes |
| node_ids | [ string ] |  | No |
| workflow_id | string |  | Yes |

#### AgentReferencingWorkflowsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AgentReferencingWorkflowResponse](#agentreferencingworkflowresponse) ] |  | No |

#### AgentRosterListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AgentRosterResponse](#agentrosterresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### AgentRosterResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) |  | No |
| active_config_snapshot_id | string |  | No |
| agent_kind | [AgentKind](#agentkind) |  | Yes |
| app_id | string |  | No |
| archived_at | integer |  | No |
| archived_by | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| description | string |  | Yes |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | [AgentIconType](#agenticontype) |  | No |
| id | string |  | Yes |
| name | string |  | Yes |
| published_node_reference_count | integer |  | No |
| published_reference_count | integer |  | No |
| published_references | [ [AgentPublishedReferenceResponse](#agentpublishedreferenceresponse) ] |  | No |
| role | string |  | No |
| scope | [AgentScope](#agentscope) |  | Yes |
| source | [AgentSource](#agentsource) |  | Yes |
| status | [AgentStatus](#agentstatus) |  | Yes |
| updated_at | integer |  | No |
| updated_by | string |  | No |
| workflow_id | string |  | No |
| workflow_node_id | string |  | No |

#### AgentSandboxProviderConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cpu | integer |  | No |
| env | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] |  | No |
| image | string |  | No |
| working_dir | string |  | No |

#### AgentSandboxUploadPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Agent App conversation ID | Yes |
| path | string | File path relative to the sandbox workspace | Yes |

#### AgentScope

Visibility and lifecycle scope of an Agent record.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentScope | string | Visibility and lifecycle scope of an Agent record. |  |

#### AgentSecretRefConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | No |
| env_name | string |  | No |
| id | string |  | No |
| key | string |  | No |
| name | string |  | No |
| permission | [AgentPermissionConfig](#agentpermissionconfig) |  | No |
| permission_status | string |  | No |
| provider | string |  | No |
| provider_credential_id | string |  | No |
| ref | string |  | No |
| type | string |  | No |
| variable | string |  | No |

#### AgentSensitiveWordAvoidanceFeatureConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| config | [AgentModerationProviderConfig](#agentmoderationproviderconfig) |  | No |
| enabled | boolean |  | No |
| type | string |  | No |

#### AgentSkillRefConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| file_id | string |  | No |
| id | string |  | No |
| name | string |  | No |
| path | string |  | No |

#### AgentSoulAppFeaturesConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| opening_statement | string |  | No |
| retriever_resource | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) |  | No |
| sensitive_word_avoidance | [AgentSensitiveWordAvoidanceFeatureConfig](#agentsensitivewordavoidancefeatureconfig) |  | No |
| speech_to_text | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) |  | No |
| suggested_questions | [ string ] |  | No |
| suggested_questions_after_answer | [AgentSuggestedQuestionsAfterAnswerFeatureConfig](#agentsuggestedquestionsafteranswerfeatureconfig) |  | No |
| text_to_speech | [AgentTextToSpeechFeatureConfig](#agenttexttospeechfeatureconfig) |  | No |

#### AgentSoulConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_features | [AgentSoulAppFeaturesConfig](#agentsoulappfeaturesconfig) |  | No |
| app_variables | [ [AppVariableConfig](#appvariableconfig) ] |  | No |
| env | [AgentSoulEnvConfig](#agentsoulenvconfig) |  | No |
| human | [AgentSoulHumanConfig](#agentsoulhumanconfig) |  | No |
| knowledge | [AgentSoulKnowledgeConfig](#agentsoulknowledgeconfig) |  | No |
| memory | [AgentSoulMemoryConfig](#agentsoulmemoryconfig) |  | No |
| misc_legacy | [AgentSoulAppFeaturesConfig](#agentsoulappfeaturesconfig) |  | No |
| model | [AgentSoulModelConfig](#agentsoulmodelconfig) |  | No |
| prompt | [AgentSoulPromptConfig](#agentsoulpromptconfig) |  | No |
| sandbox | [AgentSoulSandboxConfig](#agentsoulsandboxconfig) |  | No |
| schema_version | integer, <br>**Default:** 1 |  | No |
| skills_files | [AgentSoulSkillsFilesConfig](#agentsoulskillsfilesconfig) |  | No |
| tools | [AgentSoulToolsConfig](#agentsoultoolsconfig) |  | No |

#### AgentSoulDifyToolConfig

One Dify Plugin Tool configured on Agent Soul.

The API backend prepares this persisted product shape into
``DifyPluginToolConfig`` before sending a run request to Agent backend.
``provider_id`` keeps compatibility with existing Agent tool config payloads;
new callers should send ``plugin_id`` + ``provider`` when available.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_ref | [AgentSoulDifyToolCredentialRef](#agentsouldifytoolcredentialref) |  | No |
| credential_type | string, <br>**Available values:** "api-key", "oauth2", "unauthorized", <br>**Default:** api-key | *Enum:* `"api-key"`, `"oauth2"`, `"unauthorized"` | No |
| description | string |  | No |
| enabled | boolean, <br>**Default:** true |  | No |
| name | string |  | No |
| plugin_id | string |  | No |
| provider | string |  | No |
| provider_id | string |  | No |
| provider_type | string, <br>**Default:** plugin |  | No |
| runtime_parameters | object |  | No |
| tool_name | string |  | No |

#### AgentSoulDifyToolCredentialRef

Reference to a stored Dify Plugin Tool credential.

Secret values are resolved only at runtime. The legacy ``credential_id``
field is accepted by :class:`AgentSoulDifyToolConfig` and normalized here so
old Agent tool payloads can be read while new payloads stay explicit.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| provider | string |  | No |
| type | string, <br>**Available values:** "provider", "tool", <br>**Default:** tool | *Enum:* `"provider"`, `"tool"` | No |

#### AgentSoulEnvConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| secret_refs | [ [AgentSecretRefConfig](#agentsecretrefconfig) ] |  | No |
| variables | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] |  | No |

#### AgentSoulHumanConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] |  | No |
| tools | [ [AgentHumanToolConfig](#agenthumantoolconfig) ] |  | No |

#### AgentSoulKnowledgeConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| datasets | [ [AgentKnowledgeDatasetConfig](#agentknowledgedatasetconfig) ] |  | No |
| query_config | [AgentKnowledgeQueryConfig](#agentknowledgequeryconfig) |  | No |
| query_mode | [AgentKnowledgeQueryMode](#agentknowledgequerymode) |  | No |

#### AgentSoulMemoryConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| artifacts | [ [AgentMemoryArtifactConfig](#agentmemoryartifactconfig) ] |  | No |
| budget | string |  | No |
| scope | string |  | No |

#### AgentSoulModelConfig

Stable model selection for Agent runtime without storing secret values.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_ref | [AgentSoulModelCredentialRef](#agentsoulmodelcredentialref) |  | No |
| model | string |  | Yes |
| model_provider | string |  | Yes |
| model_settings | [AgentSoulModelSettings](#agentsoulmodelsettings) |  | No |
| plugin_id | string |  | Yes |

#### AgentSoulModelCredentialRef

Reference to model credentials resolved only at runtime.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| provider | string |  | No |
| type | string |  | Yes |

#### AgentSoulModelSettings

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| frequency_penalty | number |  | No |
| max_tokens | integer |  | No |
| presence_penalty | number |  | No |
| response_format | [AgentModelResponseFormatConfig](#agentmodelresponseformatconfig) |  | No |
| stop | [ string ] |  | No |
| temperature | number |  | No |
| top_p | number |  | No |

#### AgentSoulPromptConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| system_prompt | string |  | No |

#### AgentSoulSandboxConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| config | [AgentSandboxProviderConfig](#agentsandboxproviderconfig) |  | No |
| provider | string |  | No |

#### AgentSoulSkillsFilesConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ [AgentFileRefConfig](#agentfilerefconfig) ] |  | No |
| skills | [ [AgentSkillRefConfig](#agentskillrefconfig) ] |  | No |

#### AgentSoulToolsConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cli_tools | [ [AgentCliToolConfig](#agentclitoolconfig) ] |  | No |
| dify_tools | [ [AgentSoulDifyToolConfig](#agentsouldifytoolconfig) ] |  | No |

#### AgentSource

Origin that created or imported the Agent.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentSource | string | Origin that created or imported the Agent. |  |

#### AgentStatus

Soft lifecycle state for Agent records.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentStatus | string | Soft lifecycle state for Agent records. |  |

#### AgentSuggestedQuestionsAfterAnswerFeatureConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | No |
| model | [AgentSoulModelConfig](#agentsoulmodelconfig) |  | No |
| prompt | string |  | No |

#### AgentTextToSpeechFeatureConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| autoPlay | string |  | No |
| enabled | boolean |  | No |
| language | string |  | No |
| voice | string |  | No |

#### AgentThought

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chain_id | string |  | No |
| created_at | integer |  | No |
| files | [ string ] |  | Yes |
| id | string |  | Yes |
| message_chain_id | string |  | No |
| message_id | string |  | Yes |
| observation | string |  | No |
| position | integer |  | Yes |
| thought | string |  | No |
| tool | string |  | No |
| tool_input | string |  | No |
| tool_labels | [JSONValue](#jsonvalue) |  | Yes |

#### AllowedExtensionsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_extensions | [ string ] |  | Yes |

#### Annotation

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | No |
| created_at | integer |  | No |
| hit_count | integer |  | No |
| id | string |  | Yes |
| question | string |  | No |

#### AnnotationCountResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| count | integer | Number of annotations | Yes |

#### AnnotationExportList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [Annotation](#annotation) ] |  | Yes |

#### AnnotationFilePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message_id | string | Message ID | Yes |

#### AnnotationHitHistory

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_content | string |  | No |
| annotation_question | string |  | No |
| created_at | integer |  | No |
| id | string |  | Yes |
| question | string |  | No |
| score | number |  | No |
| source | string |  | No |

#### AnnotationHitHistoryList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AnnotationHitHistory](#annotationhithistory) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### AnnotationHitHistoryListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer, <br>**Default:** 20 | Page size | No |
| page | integer, <br>**Default:** 1 | Page number | No |

#### AnnotationList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [Annotation](#annotation) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### AnnotationListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword | string | Search keyword | No |
| limit | integer, <br>**Default:** 20 | Page size | No |
| page | integer, <br>**Default:** 1 | Page number | No |

#### AnnotationReplyPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model_name | string | Embedding model name | Yes |
| embedding_provider_name | string | Embedding provider name | Yes |
| score_threshold | number | Score threshold for annotation matching | Yes |

#### AnnotationReplyStatusQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string, <br>**Available values:** "disable", "enable" | *Enum:* `"disable"`, `"enable"` | Yes |

#### AnnotationSettingUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| score_threshold | number | Score threshold | Yes |

#### ApiBaseUrlResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| api_base_url | string |  | Yes |

#### ApiKeyAuthBindingPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| category | string |  | Yes |
| credentials | object |  | Yes |
| provider | string |  | Yes |

#### ApiKeyAuthDataSourceItem

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| category | string |  | Yes |
| created_at | integer |  | Yes |
| disabled | boolean |  | Yes |
| id | string |  | Yes |
| provider | string |  | Yes |
| updated_at | integer |  | Yes |

#### ApiKeyAuthDataSourceListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| sources | [ [ApiKeyAuthDataSourceItem](#apikeyauthdatasourceitem) ] |  | Yes |

#### ApiKeyItem

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| id | string |  | Yes |
| last_used_at | integer |  | No |
| token | string |  | Yes |
| type | string |  | Yes |

#### ApiKeyList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ApiKeyItem](#apikeyitem) ] |  | Yes |

#### ApiProviderSchemaType

Enum class for api provider schema type.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ApiProviderSchemaType | string | Enum class for api provider schema type. |  |

#### ApiToolProviderAddPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| custom_disclaimer | string |  | No |
| icon | object |  | Yes |
| labels | [ string ] |  | No |
| privacy_policy | string |  | No |
| provider | string |  | Yes |
| schema | string |  | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) |  | Yes |

#### ApiToolProviderDeletePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | string |  | Yes |

#### ApiToolProviderUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| custom_disclaimer | string |  | No |
| icon | object |  | Yes |
| labels | [ string ] |  | No |
| original_provider | string |  | Yes |
| privacy_policy | string |  | No |
| provider | string |  | Yes |
| schema | string |  | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) |  | Yes |

#### ApiToolSchemaPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| schema | string |  | Yes |

#### ApiToolTestPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| parameters | object |  | Yes |
| provider_name | string |  | No |
| schema | string |  | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) |  | Yes |
| tool_name | string |  | Yes |

#### AppApiStatusPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enable_api | boolean | Enable or disable API | Yes |

#### AppDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| access_mode | string |  | No |
| app_model_config | [ModelConfig](#modelconfig) |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| description | string |  | No |
| enable_api | boolean |  | Yes |
| enable_site | boolean |  | Yes |
| icon | string |  | No |
| icon_background | string |  | No |
| id | string |  | Yes |
| mode_compatible_with_agent | string |  | Yes |
| name | string |  | Yes |
| tags | [ [Tag](#tag) ] |  | No |
| tracing | [JSONValue](#jsonvalue) |  | No |
| updated_at | integer |  | No |
| updated_by | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |
| workflow | [WorkflowPartial](#workflowpartial) |  | No |

#### AppDetailWithSite

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| access_mode | string |  | No |
| api_base_url | string |  | No |
| app_model_config | [ModelConfig](#modelconfig) |  | No |
| bound_agent_id | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| deleted_tools | [ [DeletedTool](#deletedtool) ] |  | No |
| description | string |  | No |
| enable_api | boolean |  | Yes |
| enable_site | boolean |  | Yes |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| id | string |  | Yes |
| max_active_requests | integer |  | No |
| mode_compatible_with_agent | string |  | Yes |
| name | string |  | Yes |
| site | [Site](#site) |  | No |
| tags | [ [Tag](#tag) ] |  | No |
| tracing | [JSONValue](#jsonvalue) |  | No |
| updated_at | integer |  | No |
| updated_by | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |
| workflow | [WorkflowPartial](#workflowpartial) |  | No |

#### AppDslVersionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_dsl_version | string |  | Yes |

#### AppExportQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| include_secret | boolean | Include secrets in export | No |
| workflow_id | string | Specific workflow ID to export | No |

#### AppExportResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | string |  | Yes |

#### AppIconPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string | Icon data | No |
| icon_background | string | Icon background color | No |
| icon_type | [IconType](#icontype) | Icon type | No |

#### AppImportPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | No |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| mode | string | Import mode | Yes |
| name | string |  | No |
| yaml_content | string |  | No |
| yaml_url | string |  | No |

#### AppListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| creator_ids | [ string ] | Filter by creator account IDs | No |
| is_created_by_me | boolean | Filter by creator | No |
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
| mode | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all | App mode filter<br>*Enum:* `"advanced-chat"`, `"agent"`, `"agent-chat"`, `"all"`, `"channel"`, `"chat"`, `"completion"`, `"workflow"` | No |
| name | string | Filter by app name | No |
| page | integer, <br>**Default:** 1 | Page number (1-99999) | No |
| tag_ids | [ string ] | Filter by tag IDs | No |

#### AppMCPServerResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| description | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |
| parameters | object<br>[ object ]<br>string |  | Yes |
| server_code | string |  | Yes |
| status | [AppMCPServerStatus](#appmcpserverstatus) |  | Yes |
| updated_at | integer |  | No |

#### AppMCPServerStatus

AppMCPServer Status Enum

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AppMCPServerStatus | string | AppMCPServer Status Enum |  |

#### AppNamePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Name to check | Yes |

#### AppPagination

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_next | boolean |  | Yes |
| items | [ [AppPartial](#apppartial) ] |  | Yes |
| page | integer |  | Yes |
| per_page | integer |  | Yes |
| total | integer |  | Yes |

#### AppPartial

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| access_mode | string |  | No |
| app_model_config | [ModelConfigPartial](#modelconfigpartial) |  | No |
| author_name | string |  | No |
| create_user_name | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| desc_or_prompt | string |  | No |
| has_draft_trigger | boolean |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| id | string |  | Yes |
| max_active_requests | integer |  | No |
| mode_compatible_with_agent | string |  | Yes |
| name | string |  | Yes |
| tags | [ [Tag](#tag) ] |  | No |
| updated_at | integer |  | No |
| updated_by | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |
| workflow | [WorkflowPartial](#workflowpartial) |  | No |

#### AppSiteResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | Yes |
| code | string |  | No |
| copyright | string |  | No |
| custom_disclaimer | string |  | No |
| customize_domain | string |  | No |
| customize_token_strategy | string |  | Yes |
| default_language | string |  | Yes |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| privacy_policy | string |  | No |
| prompt_public | boolean |  | Yes |
| show_workflow_steps | boolean |  | Yes |
| title | string |  | Yes |
| use_icon_as_answer_icon | boolean |  | Yes |

#### AppSiteStatusPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enable_site | boolean | Enable or disable site | Yes |

#### AppSiteUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chat_color_theme | string |  | No |
| chat_color_theme_inverted | boolean |  | No |
| copyright | string |  | No |
| custom_disclaimer | string |  | No |
| customize_domain | string |  | No |
| customize_token_strategy | string |  | No |
| default_language | string |  | No |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| privacy_policy | string |  | No |
| prompt_public | boolean |  | No |
| show_workflow_steps | boolean |  | No |
| title | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |

#### AppTracePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean | Enable or disable tracing | Yes |
| tracing_provider | string | Tracing provider | No |

#### AppVariableConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default |  |  | No |
| name | string |  | Yes |
| required | boolean |  | No |
| type | string |  | Yes |

#### AudioTranscriptResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| text | string | Transcribed text from audio | Yes |

#### AutoDisableLogsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| count | integer |  | Yes |
| document_ids | [ string ] |  | Yes |

#### AvatarUrlResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar_url | string |  | Yes |

#### BatchImportPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| upload_file_id | string |  | Yes |

#### BedrockRetrievalPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| knowledge_id | string |  | Yes |
| query | string |  | Yes |
| retrieval_setting | [BedrockRetrievalSetting](#bedrockretrievalsetting) |  | Yes |

#### BedrockRetrievalSetting

Retrieval settings for Amazon Bedrock knowledge base queries.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| score_threshold | number | Minimum relevance score threshold | No |
| top_k | integer | Maximum number of results to retrieve | No |

#### BillingModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | Yes |
| subscription | [SubscriptionModel](#subscriptionmodel) |  | Yes |

#### BrandingModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| application_title | string |  | Yes |
| enabled | boolean |  | Yes |
| favicon | string |  | Yes |
| login_page_logo | string |  | Yes |
| workspace_logo | string |  | Yes |

#### BuiltinProviderDefaultCredentialPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |

#### BuiltinToolAddPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| name | string |  | No |
| type | [CredentialType](#credentialtype) |  | Yes |
| visibility | string |  | No |

#### BuiltinToolCredentialDeletePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |

#### BuiltinToolUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| credentials | object |  | No |
| name | string |  | No |

#### ButtonStyle

Button styles for user actions.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ButtonStyle | string | Button styles for user actions. |  |

#### ChangeEmailResetPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_email | string |  | Yes |
| token | string |  | Yes |

#### ChangeEmailSendPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| language | string |  | No |
| phase | string |  | No |
| token | string |  | No |

#### ChangeEmailValidityPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| email | string |  | Yes |
| token | string |  | Yes |

#### ChatConversationQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_status | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all | Annotation status filter<br>*Enum:* `"all"`, `"annotated"`, `"not_annotated"` | No |
| end | string | End date (YYYY-MM-DD HH:MM) | No |
| keyword | string | Search keyword | No |
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
| page | integer, <br>**Default:** 1 | Page number | No |
| sort_by | string, <br>**Available values:** "-created_at", "-updated_at", "created_at", "updated_at", <br>**Default:** -updated_at | Sort field and direction<br>*Enum:* `"-created_at"`, `"-updated_at"`, `"created_at"`, `"updated_at"` | No |
| start | string | Start date (YYYY-MM-DD HH:MM) | No |

#### ChatMessagePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation ID | No |
| files | [ object ] | Uploaded files | No |
| inputs | object |  | Yes |
| model_config | object |  | No |
| parent_message_id | string | Parent message ID | No |
| query | string | User query | Yes |
| response_mode | string, <br>**Available values:** "blocking", "streaming", <br>**Default:** blocking | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string, <br>**Default:** dev | Retriever source | No |

#### ChatMessagesQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation ID | Yes |
| first_id | string | First message ID for pagination | No |
| limit | integer, <br>**Default:** 20 | Number of messages to return (1-100) | No |

#### ChatRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string |  | No |
| files | [ object ] |  | No |
| inputs | object |  | Yes |
| parent_message_id | string |  | No |
| query | string |  | Yes |
| retriever_from | string, <br>**Default:** explore_app |  | No |

#### CheckDependenciesResult

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] |  | No |

#### CheckEmailUniquePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |

#### CheckResultView

``type_check`` / ``output_check`` per-output summary block.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| passed | boolean |  | Yes |
| reason | string |  | No |

#### ChildChunkBatchUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chunks | [ [ChildChunkUpdateArgs](#childchunkupdateargs) ] |  | Yes |

#### ChildChunkBatchUpdateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ChildChunkResponse](#childchunkresponse) ] |  | Yes |

#### ChildChunkCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |

#### ChildChunkDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ChildChunkResponse](#childchunkresponse) |  | Yes |

#### ChildChunkListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer, <br>**Default:** 1 |  | No |

#### ChildChunkListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ChildChunkResponse](#childchunkresponse) ] |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |
| total_pages | integer |  | Yes |

#### ChildChunkResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| created_at | integer |  | Yes |
| id | string |  | Yes |
| position | integer |  | Yes |
| segment_id | string |  | Yes |
| type | string |  | Yes |
| updated_at | integer |  | Yes |
| word_count | integer |  | Yes |

#### ChildChunkUpdateArgs

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| id | string |  | No |

#### ChildChunkUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |

#### CodeBasedExtensionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data |  | Extension data | Yes |
| module | string | Module name | Yes |

#### CompletionConversationQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_status | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all | Annotation status filter<br>*Enum:* `"all"`, `"annotated"`, `"not_annotated"` | No |
| end | string | End date (YYYY-MM-DD HH:MM) | No |
| keyword | string | Search keyword | No |
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
| page | integer, <br>**Default:** 1 | Page number | No |
| start | string | Start date (YYYY-MM-DD HH:MM) | No |

#### CompletionMessageExplorePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |
| query | string |  | No |
| response_mode | string |  | No |
| retriever_from | string, <br>**Default:** explore_app |  | No |

#### CompletionMessagePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] | Uploaded files | No |
| inputs | object |  | Yes |
| model_config | object |  | No |
| query | string | Query text | No |
| response_mode | string, <br>**Available values:** "blocking", "streaming", <br>**Default:** blocking | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string, <br>**Default:** dev | Retriever source | No |

#### CompletionRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |
| query | string |  | No |
| response_mode | string |  | No |
| retriever_from | string, <br>**Default:** explore_app |  | No |

#### ComplianceDownloadQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| doc_name | string | Compliance document name | Yes |

#### ComposerBindingPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_id | string |  | No |
| binding_type | string, <br>**Available values:** "inline_agent", "roster_agent" | *Enum:* `"inline_agent"`, `"roster_agent"` | Yes |
| current_snapshot_id | string |  | No |

#### ComposerCandidateCapabilities

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| human_roster_available | boolean |  | No |

#### ComposerKnowledgePlaceholderResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| placeholder_name | string |  | Yes |

#### ComposerSavePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_soul | [AgentSoulConfig](#agentsoulconfig) |  | No |
| binding | [ComposerBindingPayload](#composerbindingpayload) |  | No |
| client_revision_id | string |  | No |
| idempotency_key | string |  | No |
| new_agent_name | string |  | No |
| node_job | [WorkflowNodeJobConfig](#workflownodejobconfig) |  | No |
| save_strategy | [ComposerSaveStrategy](#composersavestrategy) |  | Yes |
| soul_lock | [ComposerSoulLockPayload](#composersoullockpayload) |  | No |
| variant | [ComposerVariant](#composervariant) |  | Yes |
| version_note | string |  | No |

#### ComposerSaveStrategy

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ComposerSaveStrategy | string |  |  |

#### ComposerSoulLockPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| locked | boolean, <br>**Default:** true |  | No |
| unlocked_from_version_id | string |  | No |

#### ComposerValidationFindingsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| knowledge_retrieval_placeholder | [ [ComposerKnowledgePlaceholderResponse](#composerknowledgeplaceholderresponse) ] |  | No |
| warnings | [ [ComposerValidationWarningResponse](#composervalidationwarningresponse) ] |  | No |

#### ComposerValidationWarningResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| id | string |  | No |
| kind | string |  | No |
| message | string |  | No |
| surface | string |  | No |

#### ComposerVariant

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ComposerVariant | string |  |  |

#### Condition

Condition detail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| comparison_operator | string, <br>**Available values:** "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" | *Enum:* `"<"`, `"="`, `">"`, `"after"`, `"before"`, `"contains"`, `"empty"`, `"end with"`, `"in"`, `"is"`, `"is not"`, `"not contains"`, `"not empty"`, `"not in"`, `"start with"`, `"≠"`, `"≤"`, `"≥"` | Yes |
| name | string |  | Yes |
| value | string<br>[ string ]<br>integer<br>number |  | No |

#### ConsoleDatasetListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ids | [ string ] | Filter by dataset IDs | No |
| include_all | boolean | Include all datasets | No |
| keyword | string | Search keyword | No |
| limit | integer, <br>**Default:** 20 | Number of items per page | No |
| page | integer, <br>**Default:** 1 | Page number | No |
| tag_ids | [ string ] | Filter by tag IDs | No |

#### ConsoleSegmentListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [SegmentResponse](#segmentresponse) ] |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |
| total_pages | integer |  | Yes |

#### Conversation

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| admin_feedback_stats | [FeedbackStat](#feedbackstat) |  | No |
| annotation | [ConversationAnnotation](#conversationannotation) |  | No |
| created_at | integer |  | No |
| first_message | [SimpleMessageDetail](#simplemessagedetail) |  | No |
| from_account_id | string |  | No |
| from_account_name | string |  | No |
| from_end_user_id | string |  | No |
| from_end_user_session_id | string |  | No |
| from_source | string |  | Yes |
| id | string |  | Yes |
| model_config | [SimpleModelConfig](#simplemodelconfig) |  | No |
| read_at | integer |  | No |
| status | string |  | Yes |
| updated_at | integer |  | No |
| user_feedback_stats | [FeedbackStat](#feedbackstat) |  | No |

#### ConversationAnnotation

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| account | [SimpleAccount](#simpleaccount) |  | No |
| content | string |  | Yes |
| created_at | integer |  | No |
| id | string |  | Yes |
| question | string |  | No |

#### ConversationAnnotationHitHistory

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_create_account | [SimpleAccount](#simpleaccount) |  | No |
| created_at | integer |  | No |
| id | string |  | Yes |

#### ConversationDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| admin_feedback_stats | [FeedbackStat](#feedbackstat) |  | No |
| annotated | boolean |  | Yes |
| created_at | integer |  | No |
| from_account_id | string |  | No |
| from_end_user_id | string |  | No |
| from_source | string |  | Yes |
| id | string |  | Yes |
| introduction | string |  | No |
| message_count | integer |  | Yes |
| model_config | [ModelConfig](#modelconfig) |  | No |
| status | string |  | Yes |
| updated_at | integer |  | No |
| user_feedback_stats | [FeedbackStat](#feedbackstat) |  | No |

#### ConversationListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| last_id | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |
| pinned | boolean |  | No |

#### ConversationMessageDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| first_message | [MessageDetail](#messagedetail) |  | No |
| from_account_id | string |  | No |
| from_end_user_id | string |  | No |
| from_source | string |  | Yes |
| id | string |  | Yes |
| model_config | [ModelConfig](#modelconfig) |  | No |
| status | string |  | Yes |

#### ConversationPagination

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_next | boolean |  | Yes |
| items | [ [Conversation](#conversation) ] |  | Yes |
| page | integer |  | Yes |
| per_page | integer |  | Yes |
| total | integer |  | Yes |

#### ConversationRenamePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auto_generate | boolean |  | No |
| name | string |  | No |

#### ConversationVariableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| description | string |  | No |
| id | string |  | Yes |
| name | string |  | Yes |
| updated_at | integer |  | No |
| value | string |  | No |
| value_type | string |  | Yes |

#### ConversationVariableUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ object ] | Conversation variables for the draft workflow | Yes |

#### ConversationVariablesQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation ID to filter variables | Yes |

#### ConversationWithSummary

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| admin_feedback_stats | [FeedbackStat](#feedbackstat) |  | No |
| annotated | boolean |  | Yes |
| created_at | integer |  | No |
| from_account_id | string |  | No |
| from_account_name | string |  | No |
| from_end_user_id | string |  | No |
| from_end_user_session_id | string |  | No |
| from_source | string |  | Yes |
| id | string |  | Yes |
| message_count | integer |  | Yes |
| model_config | [SimpleModelConfig](#simplemodelconfig) |  | No |
| name | string |  | Yes |
| read_at | integer |  | No |
| status | string |  | Yes |
| status_count | [StatusCount](#statuscount) |  | No |
| summary_or_query | string |  | Yes |
| updated_at | integer |  | No |
| user_feedback_stats | [FeedbackStat](#feedbackstat) |  | No |

#### ConversationWithSummaryPagination

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_next | boolean |  | Yes |
| items | [ [ConversationWithSummary](#conversationwithsummary) ] |  | Yes |
| page | integer |  | Yes |
| per_page | integer |  | Yes |
| total | integer |  | Yes |

#### ConvertToWorkflowPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| name | string |  | No |

#### CopyAppPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Description for the copied app | No |
| icon | string | Icon | No |
| icon_background | string | Icon background color | No |
| icon_type | [IconType](#icontype) | Icon type | No |
| name | string | Name for the copied app | No |

#### CreateAnnotationPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_reply | object | Annotation reply data | No |
| answer | string | Answer text | No |
| content | string | Content text | No |
| message_id | string | Message ID | No |
| question | string | Question text | No |

#### CreateAppPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | App description (max 400 chars) | No |
| icon | string | Icon | No |
| icon_background | string | Icon background color | No |
| icon_type | [IconType](#icontype) | Icon type | No |
| mode | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "chat", "completion", "workflow" | App mode<br>*Enum:* `"advanced-chat"`, `"agent"`, `"agent-chat"`, `"chat"`, `"completion"`, `"workflow"` | Yes |
| name | string | App name | Yes |

#### CreateSnippetPayload

Payload for creating a new snippet.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| graph | object |  | No |
| icon_info | [IconInfo](#iconinfo) |  | No |
| input_fields | [ [InputFieldDefinition](#inputfielddefinition) ] |  | No |
| name | string |  | Yes |
| type | string, <br>**Available values:** "group", "node", <br>**Default:** node | *Enum:* `"group"`, `"node"` | No |

#### CredentialType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CredentialType | string |  |  |

#### CustomizedPipelineTemplatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| icon_info | object |  | No |
| name | string |  | Yes |

#### DataSource

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| info_list | [InfoList](#infolist) |  | Yes |

#### DataSourceIntegrateIconResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emoji | string |  | No |
| type | string |  | No |
| url | string |  | No |

#### DataSourceIntegrateListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DataSourceIntegrateResponse](#datasourceintegrateresponse) ] |  | Yes |

#### DataSourceIntegratePageResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| page_icon | [DataSourceIntegrateIconResponse](#datasourceintegrateiconresponse) |  | Yes |
| page_id | string |  | Yes |
| page_name | string |  | Yes |
| parent_id | string |  | Yes |
| type | string |  | Yes |

#### DataSourceIntegrateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | Yes |
| disabled | boolean |  | Yes |
| id | string |  | Yes |
| is_bound | boolean |  | Yes |
| link | string |  | Yes |
| provider | string |  | Yes |
| source_info | [DataSourceIntegrateWorkspaceResponse](#datasourceintegrateworkspaceresponse) |  | Yes |

#### DataSourceIntegrateWorkspaceResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pages | [ [DataSourceIntegratePageResponse](#datasourceintegratepageresponse) ] |  | Yes |
| total | integer |  | Yes |
| workspace_icon | string |  | Yes |
| workspace_id | string |  | Yes |
| workspace_name | string |  | Yes |

#### DatasetAndDocumentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| batch | string |  | Yes |
| dataset | [DatasetResponse](#datasetresponse) |  | Yes |
| documents | [ [DocumentResponse](#documentresponse) ] |  | Yes |

#### DatasetCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| external_knowledge_api_id | string |  | No |
| external_knowledge_id | string |  | No |
| indexing_technique | string |  | No |
| name | string |  | Yes |
| permission | [PermissionEnum](#permissionenum) |  | No |
| provider | string, <br>**Default:** vendor |  | No |

#### DatasetDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_count | integer |  | No |
| author_name | string |  | No |
| built_in_field_enabled | boolean |  | No |
| chunk_structure | string |  | No |
| created_at | object |  | No |
| created_by | string |  | No |
| data_source_type | string |  | No |
| description | string |  | No |
| doc_form | string |  | No |
| doc_metadata | [ [DatasetDocMetadata](#datasetdocmetadata) ] |  | No |
| document_count | integer |  | No |
| embedding_available | boolean |  | No |
| embedding_model | string |  | No |
| embedding_model_provider | string |  | No |
| enable_api | boolean |  | No |
| external_knowledge_info | [ExternalKnowledgeInfo](#externalknowledgeinfo) |  | No |
| external_retrieval_model | [ExternalRetrievalModel](#externalretrievalmodel) |  | No |
| icon_info | [DatasetIconInfo](#dataseticoninfo) |  | No |
| id | string |  | No |
| indexing_technique | string |  | No |
| is_multimodal | boolean |  | No |
| is_published | boolean |  | No |
| name | string |  | No |
| permission | string |  | No |
| pipeline_id | string |  | No |
| provider | string |  | No |
| retrieval_model_dict | [DatasetRetrievalModel](#datasetretrievalmodel) |  | No |
| runtime_mode | string |  | No |
| summary_index_setting | [_AnonymousInlineModel_b1954337d565](#_anonymousinlinemodel_b1954337d565) |  | No |
| tags | [ [Tag](#tag) ] |  | No |
| total_available_documents | integer |  | No |
| total_documents | integer |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |
| word_count | integer |  | No |

#### DatasetDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_count | integer |  | Yes |
| author_name | string |  | Yes |
| built_in_field_enabled | boolean |  | Yes |
| chunk_structure | string |  | Yes |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| data_source_type | string |  | Yes |
| description | string |  | Yes |
| doc_form | string |  | Yes |
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] |  | Yes |
| document_count | integer |  | Yes |
| embedding_available | boolean |  | No |
| embedding_model | string |  | Yes |
| embedding_model_provider | string |  | Yes |
| enable_api | boolean |  | Yes |
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) |  | No |
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) |  | Yes |
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) |  | No |
| id | string |  | Yes |
| indexing_technique | string |  | Yes |
| is_multimodal | boolean |  | Yes |
| is_published | boolean |  | Yes |
| name | string |  | Yes |
| permission | string |  | Yes |
| pipeline_id | string |  | Yes |
| provider | string |  | Yes |
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) |  | Yes |
| runtime_mode | string |  | Yes |
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) |  | No |
| tags | [ [DatasetTagResponse](#datasettagresponse) ] |  | Yes |
| total_available_documents | integer |  | Yes |
| total_documents | integer |  | Yes |
| updated_at | integer |  | Yes |
| updated_by | string |  | Yes |
| word_count | integer |  | Yes |

#### DatasetDetailWithPartialMembersResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_count | integer |  | Yes |
| author_name | string |  | Yes |
| built_in_field_enabled | boolean |  | Yes |
| chunk_structure | string |  | Yes |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| data_source_type | string |  | Yes |
| description | string |  | Yes |
| doc_form | string |  | Yes |
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] |  | Yes |
| document_count | integer |  | Yes |
| embedding_available | boolean |  | No |
| embedding_model | string |  | Yes |
| embedding_model_provider | string |  | Yes |
| enable_api | boolean |  | Yes |
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) |  | No |
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) |  | Yes |
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) |  | No |
| id | string |  | Yes |
| indexing_technique | string |  | Yes |
| is_multimodal | boolean |  | Yes |
| is_published | boolean |  | Yes |
| name | string |  | Yes |
| partial_member_list | [ string ] |  | No |
| permission | string |  | Yes |
| pipeline_id | string |  | Yes |
| provider | string |  | Yes |
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) |  | Yes |
| runtime_mode | string |  | Yes |
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) |  | No |
| tags | [ [DatasetTagResponse](#datasettagresponse) ] |  | Yes |
| total_available_documents | integer |  | Yes |
| total_documents | integer |  | Yes |
| updated_at | integer |  | Yes |
| updated_by | string |  | Yes |
| word_count | integer |  | Yes |

#### DatasetDocMetadata

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| name | string |  | No |
| type | string |  | No |

#### DatasetDocMetadataResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | Yes |

#### DatasetExternalKnowledgeInfoResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| external_knowledge_api_endpoint | string |  | No |
| external_knowledge_api_id | string |  | No |
| external_knowledge_api_name | string |  | No |
| external_knowledge_id | string |  | No |

#### DatasetExternalRetrievalModelResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| score_threshold | number |  | No |
| score_threshold_enabled | boolean |  | No |
| top_k | integer |  | Yes |

#### DatasetIconInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| icon_url | string |  | No |

#### DatasetIconInfoResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| icon_url | string |  | No |

#### DatasetKeywordSetting

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_weight | number |  | No |

#### DatasetKeywordSettingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_weight | number |  | No |

#### DatasetListItemResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_count | integer |  | Yes |
| author_name | string |  | Yes |
| built_in_field_enabled | boolean |  | Yes |
| chunk_structure | string |  | Yes |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| data_source_type | string |  | Yes |
| description | string |  | Yes |
| doc_form | string |  | Yes |
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] |  | Yes |
| document_count | integer |  | Yes |
| embedding_available | boolean |  | No |
| embedding_model | string |  | Yes |
| embedding_model_provider | string |  | Yes |
| enable_api | boolean |  | Yes |
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) |  | No |
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) |  | Yes |
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) |  | No |
| id | string |  | Yes |
| indexing_technique | string |  | Yes |
| is_multimodal | boolean |  | Yes |
| is_published | boolean |  | Yes |
| name | string |  | Yes |
| partial_member_list | [ string ] |  | Yes |
| permission | string |  | Yes |
| pipeline_id | string |  | Yes |
| provider | string |  | Yes |
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) |  | Yes |
| runtime_mode | string |  | Yes |
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) |  | No |
| tags | [ [DatasetTagResponse](#datasettagresponse) ] |  | Yes |
| total_available_documents | integer |  | Yes |
| total_documents | integer |  | Yes |
| updated_at | integer |  | Yes |
| updated_by | string |  | Yes |
| word_count | integer |  | Yes |

#### DatasetListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DatasetListItemResponse](#datasetlistitemresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### DatasetMetadataBuiltInFieldResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| type | string |  | Yes |

#### DatasetMetadataBuiltInFieldsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fields | [ [DatasetMetadataBuiltInFieldResponse](#datasetmetadatabuiltinfieldresponse) ] |  | Yes |

#### DatasetMetadataListItemResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| count | integer |  | No |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | Yes |

#### DatasetMetadataListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| built_in_field_enabled | boolean |  | Yes |
| doc_metadata | [ [DatasetMetadataListItemResponse](#datasetmetadatalistitemresponse) ] |  | Yes |

#### DatasetMetadataResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | Yes |

#### DatasetQueryContentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| content_type | string |  | Yes |
| file_info | [DatasetQueryFileInfoResponse](#datasetqueryfileinforesponse) |  | No |

#### DatasetQueryDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| created_by_role | string |  | Yes |
| id | string |  | Yes |
| queries | [ [DatasetQueryContentResponse](#datasetquerycontentresponse) ] |  | Yes |
| source | string |  | Yes |
| source_app_id | string |  | Yes |

#### DatasetQueryFileInfoResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| extension | string |  | Yes |
| id | string |  | Yes |
| mime_type | string |  | Yes |
| name | string |  | Yes |
| size | integer |  | Yes |
| source_url | string |  | Yes |

#### DatasetQueryListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DatasetQueryDetailResponse](#datasetquerydetailresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### DatasetRerankingModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_model_name | string |  | No |
| reranking_provider_name | string |  | No |

#### DatasetRerankingModelResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_model_name | string |  | No |
| reranking_provider_name | string |  | No |

#### DatasetResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by | string |  | No |
| data_source_type | string |  | No |
| description | string |  | No |
| id | string |  | Yes |
| indexing_technique | string |  | No |
| name | string |  | Yes |
| permission | string |  | No |

#### DatasetRetrievalModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_enable | boolean |  | No |
| reranking_mode | string |  | No |
| reranking_model | [DatasetRerankingModel](#datasetrerankingmodel) |  | No |
| score_threshold | number |  | No |
| score_threshold_enabled | boolean |  | No |
| search_method | string |  | No |
| top_k | integer |  | No |
| weights | [DatasetWeightedScore](#datasetweightedscore) |  | No |

#### DatasetRetrievalModelResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_enable | boolean |  | Yes |
| reranking_mode | string |  | No |
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) |  | No |
| score_threshold | number |  | No |
| score_threshold_enabled | boolean |  | Yes |
| search_method | string |  | Yes |
| top_k | integer |  | Yes |
| weights | [DatasetWeightedScoreResponse](#datasetweightedscoreresponse) |  | No |

#### DatasetSummaryIndexSettingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enable | boolean |  | No |
| model_name | string |  | No |
| model_provider_name | string |  | No |
| summary_prompt | string |  | No |

#### DatasetTagResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | Yes |

#### DatasetUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| embedding_model | string |  | No |
| embedding_model_provider | string |  | No |
| external_knowledge_api_id | string |  | No |
| external_knowledge_id | string |  | No |
| external_retrieval_model | object |  | No |
| icon_info | object |  | No |
| indexing_technique | string |  | No |
| is_multimodal | boolean |  | No |
| name | string |  | No |
| partial_member_list | [ object ] |  | No |
| permission | [PermissionEnum](#permissionenum) |  | No |
| retrieval_model | object |  | No |
| summary_index_setting | object |  | No |

#### DatasetVectorSetting

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model_name | string |  | No |
| embedding_provider_name | string |  | No |
| vector_weight | number |  | No |

#### DatasetVectorSettingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model_name | string |  | No |
| embedding_provider_name | string |  | No |
| vector_weight | number |  | No |

#### DatasetWeightedScore

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_setting | [DatasetKeywordSetting](#datasetkeywordsetting) |  | No |
| vector_setting | [DatasetVectorSetting](#datasetvectorsetting) |  | No |
| weight_type | string |  | No |

#### DatasetWeightedScoreResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) |  | No |
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) |  | No |
| weight_type | string |  | No |

#### DatasourceCredentialDeletePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |

#### DatasourceCredentialPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| name | string |  | No |

#### DatasourceCredentialUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| credentials | object |  | No |
| name | string |  | No |

#### DatasourceCustomClientPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| client_params | object |  | No |
| enable_oauth_custom_client | boolean |  | No |

#### DatasourceDefaultPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |

#### DatasourceNodeRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | No |
| datasource_type | string |  | Yes |
| inputs | object |  | Yes |

#### DatasourceUpdateNamePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| name | string |  | Yes |

#### DatasourceVariablesPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| datasource_info | object |  | Yes |
| datasource_type | string |  | Yes |
| start_node_id | string |  | Yes |
| start_node_title | string |  | Yes |

#### DebugPermission

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DebugPermission | string |  |  |

#### DeclaredArrayItem

Per-item shape for an ``array``-typed declared output.

PRD §OUTPUT 配置框 keeps arrays one level deep on first version; nested arrays
are rejected so the runtime type checker and JSON Schema stay easy to reason
about. Stage 4 §4.2.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| type | [DeclaredOutputType](#declaredoutputtype) |  | Yes |

#### DeclaredOutputCheckConfig

File-output content check via a model-based comparison against a benchmark file.

Per PRD §OUTPUT 配置框, output check is **file-only** and optional. Stage 4 §4.3.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| benchmark_file_ref | [AgentFileRefConfig](#agentfilerefconfig) |  | No |
| enabled | boolean |  | No |
| model_ref | [AgentSoulModelConfig](#agentsoulmodelconfig) |  | No |
| prompt | string |  | No |

#### DeclaredOutputConfig

One declared output of a Workflow Agent Node.

Stage 4 normalizes the shape: ``check`` is singular (was ``checks: list`` in
stage 3), and ``failure_strategy`` defaults to a populated value so runtime
code can call ``output.failure_strategy.on_failure`` without None-guards.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| array_item | [DeclaredArrayItem](#declaredarrayitem) |  | No |
| check | [DeclaredOutputCheckConfig](#declaredoutputcheckconfig) |  | No |
| description | string |  | No |
| failure_strategy | [DeclaredOutputFailureStrategy](#declaredoutputfailurestrategy) |  | No |
| file | [DeclaredOutputFileConfig](#declaredoutputfileconfig) |  | No |
| id | string |  | No |
| name | string |  | Yes |
| required | boolean, <br>**Default:** true |  | No |
| type | [DeclaredOutputType](#declaredoutputtype) |  | Yes |

#### DeclaredOutputFailureStrategy

Per-output failure handling.

A single strategy applies to both ``type_check`` and ``output_check`` failures
(PRD does not distinguish them at the UX level). Stage 4 §4.4.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default_value |  |  | No |
| on_failure | [OutputErrorStrategy](#outputerrorstrategy) |  | No |
| retry | [DeclaredOutputRetryConfig](#declaredoutputretryconfig) |  | No |

#### DeclaredOutputFileConfig

File-type output metadata. Both lists empty means "any file accepted".

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| extensions | [ string ] |  | No |
| mime_types | [ string ] |  | No |

#### DeclaredOutputRetryConfig

Per-output retry configuration that mirrors ``graphon.RetryConfig`` shape.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | No |
| max_retries | integer |  | No |
| retry_interval_ms | integer |  | No |

#### DeclaredOutputType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DeclaredOutputType | string |  |  |

#### DefaultBlockConfigQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| q | string |  | No |

#### DeletedTool

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider_id | string |  | Yes |
| tool_name | string |  | Yes |
| type | string |  | Yes |

#### DocumentBatchDownloadZipPayload

Request payload for bulk downloading documents as a zip archive.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_ids | [ string (uuid) ] |  | Yes |

#### DocumentMetadataOperation

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string |  | Yes |
| metadata_list | [ [MetadataDetail](#metadatadetail) ] |  | Yes |
| partial_update | boolean |  | No |

#### DocumentMetadataResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | Yes |
| value | string<br>integer<br>number<br>boolean |  | No |

#### DocumentMetadataUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| doc_metadata |  |  | No |
| doc_type | string |  | No |

#### DocumentRenamePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |

#### DocumentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| archived | boolean |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| created_from | string |  | No |
| data_source_detail_dict |  |  | No |
| data_source_info |  |  | No |
| data_source_type | string |  | No |
| dataset_process_rule_id | string |  | No |
| disabled_at | integer |  | No |
| disabled_by | string |  | No |
| display_status | string |  | No |
| doc_form | string |  | No |
| doc_metadata | [ [DocumentMetadataResponse](#documentmetadataresponse) ] |  | No |
| enabled | boolean |  | No |
| error | string |  | No |
| hit_count | integer |  | No |
| id | string |  | Yes |
| indexing_status | string |  | No |
| name | string |  | Yes |
| need_summary | boolean |  | No |
| position | integer |  | No |
| summary_index_status | string |  | No |
| tokens | integer |  | No |
| word_count | integer |  | No |

#### DocumentRetryPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_ids | [ string ] |  | Yes |

#### DocumentStatusListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] |  | Yes |

#### DocumentStatusResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cleaning_completed_at | integer |  | Yes |
| completed_at | integer |  | Yes |
| completed_segments | integer |  | No |
| error | string |  | Yes |
| id | string |  | Yes |
| indexing_status | string |  | Yes |
| parsing_completed_at | integer |  | Yes |
| paused_at | integer |  | Yes |
| processing_started_at | integer |  | Yes |
| splitting_completed_at | integer |  | Yes |
| stopped_at | integer |  | Yes |
| total_segments | integer |  | No |

#### DocumentWithSegmentsListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DocumentWithSegmentsResponse](#documentwithsegmentsresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### DocumentWithSegmentsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| archived | boolean |  | No |
| completed_segments | integer |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| created_from | string |  | No |
| data_source_detail_dict |  |  | No |
| data_source_info |  |  | No |
| data_source_type | string |  | No |
| dataset_process_rule_id | string |  | No |
| disabled_at | integer |  | No |
| disabled_by | string |  | No |
| display_status | string |  | No |
| doc_form | string |  | No |
| doc_metadata | [ [DocumentMetadataResponse](#documentmetadataresponse) ] |  | No |
| enabled | boolean |  | No |
| error | string |  | No |
| hit_count | integer |  | No |
| id | string |  | Yes |
| indexing_status | string |  | No |
| name | string |  | Yes |
| need_summary | boolean |  | No |
| position | integer |  | No |
| process_rule_dict |  |  | No |
| summary_index_status | string |  | No |
| tokens | integer |  | No |
| total_segments | integer |  | No |
| word_count | integer |  | No |

#### DraftWorkflowNodeRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |
| query | string |  | No |

#### DraftWorkflowRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| datasource_info_list | [ object ] |  | Yes |
| datasource_type | string |  | Yes |
| inputs | object |  | Yes |
| start_node_id | string |  | Yes |

#### DraftWorkflowSyncPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ object ] |  | No |
| environment_variables | [ object ] |  | No |
| features | object |  | No |
| graph | object |  | Yes |
| hash | string |  | No |
| rag_pipeline_variables | [ object ] |  | No |

#### DraftWorkflowTriggerRunAllPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_ids | [ string ] |  | Yes |

#### DraftWorkflowTriggerRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string |  | Yes |

#### DraftWorkflowTriggerRunRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string | Node ID | Yes |

#### EducationActivatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| institution | string |  | Yes |
| role | string |  | Yes |
| token | string |  | Yes |

#### EducationAutocompleteQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keywords | string |  | Yes |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer |  | No |

#### EducationAutocompleteResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| curr_page | integer |  | No |
| data | [ string ] |  | No |
| has_next | boolean |  | No |

#### EducationModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| activated | boolean |  | Yes |
| enabled | boolean |  | Yes |

#### EducationStatusResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_refresh | boolean |  | No |
| expire_at | integer |  | No |
| is_student | boolean |  | No |
| result | boolean |  | No |

#### EducationVerifyResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| token | string |  | No |

#### EmailCodeLoginPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| email | string |  | Yes |
| language | string |  | No |
| timezone | string |  | No |
| token | string |  | Yes |

#### EmailPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| language | string |  | No |

#### EmailRegisterResetPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string |  | No |
| new_password | string |  | Yes |
| password_confirm | string |  | Yes |
| timezone | string |  | No |
| token | string |  | Yes |

#### EmailRegisterSendPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | Email address | Yes |
| language | string | Language code | No |

#### EmailRegisterValidityPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| email | string |  | Yes |
| token | string |  | Yes |

#### EndpointCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| plugin_unique_identifier | string |  | Yes |
| settings | object |  | Yes |

#### EndpointCreateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| success | boolean | Operation success | Yes |

#### EndpointDeleteResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| success | boolean | Operation success | Yes |

#### EndpointDisableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| success | boolean | Operation success | Yes |

#### EndpointEnableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| success | boolean | Operation success | Yes |

#### EndpointIdPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endpoint_id | string |  | Yes |

#### EndpointListForPluginQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| page | integer |  | Yes |
| page_size | integer |  | Yes |
| plugin_id | string |  | Yes |

#### EndpointListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| page | integer |  | Yes |
| page_size | integer |  | Yes |

#### EndpointListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endpoints | [ object ] | Endpoint information | Yes |

#### EndpointUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| settings | object |  | Yes |

#### EndpointUpdateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| success | boolean | Operation success | Yes |

#### EnvironmentVariableUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| environment_variables | [ object ] | Environment variables for the draft workflow | Yes |

#### ErrorDocsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] |  | Yes |
| total | integer |  | Yes |

#### ExecutionContentType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ExecutionContentType | string |  |  |

#### ExternalApiTemplateListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword | string | Search keyword | No |
| limit | integer, <br>**Default:** 20 | Number of items per page | No |
| page | integer, <br>**Default:** 1 | Page number | No |

#### ExternalDatasetCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| external_knowledge_api_id | string |  | Yes |
| external_knowledge_id | string |  | Yes |
| external_retrieval_model | object |  | No |
| name | string |  | Yes |

#### ExternalHitTestingPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| external_retrieval_model | object |  | No |
| metadata_filtering_conditions | object |  | No |
| query | string |  | Yes |

#### ExternalKnowledgeApiPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| settings | object |  | Yes |

#### ExternalKnowledgeInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| external_knowledge_api_endpoint | string |  | No |
| external_knowledge_api_id | string |  | No |
| external_knowledge_api_name | string |  | No |
| external_knowledge_id | string |  | No |

#### ExternalRetrievalModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| score_threshold | number |  | No |
| score_threshold_enabled | boolean |  | No |
| top_k | integer |  | No |

#### FeatureModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_quota_limit | [LimitationModel](#limitationmodel) |  | Yes |
| api_rate_limit | [Quota](#quota) |  | Yes |
| apps | [LimitationModel](#limitationmodel) |  | Yes |
| billing | [BillingModel](#billingmodel) |  | Yes |
| can_replace_logo | boolean |  | Yes |
| dataset_operator_enabled | boolean |  | Yes |
| docs_processing | string, <br>**Default:** standard |  | Yes |
| documents_upload_quota | [LimitationModel](#limitationmodel) |  | Yes |
| education | [EducationModel](#educationmodel) |  | Yes |
| human_input_email_delivery_enabled | boolean |  | Yes |
| is_allow_transfer_workspace | boolean, <br>**Default:** true |  | Yes |
| knowledge_pipeline | [KnowledgePipeline](#knowledgepipeline) |  | Yes |
| knowledge_rate_limit | integer, <br>**Default:** 10 |  | Yes |
| members | [LimitationModel](#limitationmodel) |  | Yes |
| model_load_balancing_enabled | boolean |  | Yes |
| next_credit_reset_date | integer |  | Yes |
| trigger_event | [Quota](#quota) |  | Yes |
| vector_space | [LimitationModel](#limitationmodel) |  | Yes |
| webapp_copyright_enabled | boolean |  | Yes |
| workspace_members | [LicenseLimitationModel](#licenselimitationmodel) |  | Yes |

#### Feedback

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | No |
| from_account | [SimpleAccount](#simpleaccount) |  | No |
| from_end_user_id | string |  | No |
| from_source | string |  | Yes |
| rating | string |  | Yes |

#### FeedbackExportQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| end_date | string | End date (YYYY-MM-DD) | No |
| format | string, <br>**Available values:** "csv", "json", <br>**Default:** csv | Export format<br>*Enum:* `"csv"`, `"json"` | No |
| from_source | string | Filter by feedback source | No |
| has_comment | boolean | Only include feedback with comments | No |
| rating | string | Filter by rating | No |
| start_date | string | Start date (YYYY-MM-DD) | No |

#### FeedbackStat

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dislike | integer |  | Yes |
| like | integer |  | Yes |

#### FileInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file_ids | [ string ] |  | Yes |

#### FileInputConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_file_extensions | [ string ] |  | No |
| allowed_file_types | [ [FileType](#filetype) ] |  | No |
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] |  | No |
| output_variable_name | string |  | Yes |
| type | string |  | No |

#### FileListInputConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_file_extensions | [ string ] |  | No |
| allowed_file_types | [ [FileType](#filetype) ] |  | No |
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] |  | No |
| number_limits | integer |  | No |
| output_variable_name | string |  | Yes |
| type | string |  | No |

#### FileResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| extension | string |  | No |
| file_key | string |  | No |
| id | string |  | Yes |
| mime_type | string |  | No |
| name | string |  | Yes |
| original_url | string |  | No |
| preview_url | string |  | No |
| reference | string |  | No |
| size | integer |  | Yes |
| source_url | string |  | No |
| tenant_id | string |  | No |
| user_id | string |  | No |

#### FileTransferMethod

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileTransferMethod | string |  |  |

#### FileType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileType | string |  |  |

#### FileWithSignedUrl

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| extension | string |  | Yes |
| id | string |  | Yes |
| mime_type | string |  | Yes |
| name | string |  | Yes |
| size | integer |  | Yes |
| url | string |  | Yes |

#### ForgotPasswordCheckPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| email | string |  | Yes |
| token | string |  | Yes |

#### ForgotPasswordCheckResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | Email address | Yes |
| is_valid | boolean | Whether code is valid | Yes |
| token | string | New reset token | Yes |

#### ForgotPasswordEmailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string | Error code if account not found | No |
| data | string | Reset token | No |
| result | string | Operation result | Yes |

#### ForgotPasswordResetPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_password | string |  | Yes |
| password_confirm | string |  | Yes |
| token | string |  | Yes |

#### ForgotPasswordResetResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result | Yes |

#### ForgotPasswordSendPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| language | string |  | No |

#### FormInputConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FormInputConfig | [ParagraphInputConfig](#paragraphinputconfig)<br>[SelectInputConfig](#selectinputconfig)<br>[FileInputConfig](#fileinputconfig)<br>[FileListInputConfig](#filelistinputconfig) |  |  |

#### GenerateSummaryPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_list | [ string ] |  | Yes |

#### Github

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| github_plugin_unique_identifier | string |  | Yes |
| package | string |  | Yes |
| repo | string |  | Yes |
| version | string |  | Yes |

#### HitTestingChildChunk

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| id | string |  | Yes |
| position | integer |  | Yes |
| score | number |  | Yes |

#### HitTestingDocument

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data_source_type | string |  | Yes |
| doc_metadata |  |  | Yes |
| doc_type | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |

#### HitTestingFile

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| extension | string |  | Yes |
| id | string |  | Yes |
| mime_type | string |  | Yes |
| name | string |  | Yes |
| size | integer |  | Yes |
| source_url | string |  | Yes |

#### HitTestingPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| attachment_ids | [ string ] |  | No |
| external_retrieval_model | object |  | No |
| query | string |  | Yes |
| retrieval_model | [RetrievalModel](#retrievalmodel) |  | No |

#### HitTestingQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |

#### HitTestingRecord

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| child_chunks | [ [HitTestingChildChunk](#hittestingchildchunk) ] |  | Yes |
| files | [ [HitTestingFile](#hittestingfile) ] |  | Yes |
| score | number |  | Yes |
| segment | [HitTestingSegment](#hittestingsegment) |  | Yes |
| summary | string |  | Yes |
| tsne_position |  |  | Yes |

#### HitTestingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| query | [HitTestingQuery](#hittestingquery) |  | Yes |
| records | [ [HitTestingRecord](#hittestingrecord) ] |  | Yes |

#### HitTestingSegment

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | Yes |
| completed_at | integer |  | Yes |
| content | string |  | Yes |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| disabled_at | integer |  | Yes |
| disabled_by | string |  | Yes |
| document | [HitTestingDocument](#hittestingdocument) |  | Yes |
| document_id | string |  | Yes |
| enabled | boolean |  | Yes |
| error | string |  | Yes |
| hit_count | integer |  | Yes |
| id | string |  | Yes |
| index_node_hash | string |  | Yes |
| index_node_id | string |  | Yes |
| indexing_at | integer |  | Yes |
| keywords | [ string ] |  | Yes |
| position | integer |  | Yes |
| sign_content | string |  | Yes |
| status | string |  | Yes |
| stopped_at | integer |  | Yes |
| tokens | integer |  | Yes |
| word_count | integer |  | Yes |

#### HumanInputContent

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| form_definition | [HumanInputFormDefinition](#humaninputformdefinition) |  | No |
| form_submission_data | [HumanInputFormSubmissionData](#humaninputformsubmissiondata) |  | No |
| submitted | boolean |  | Yes |
| type | [ExecutionContentType](#executioncontenttype) |  | No |
| workflow_run_id | string |  | Yes |

#### HumanInputDeliveryTestPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| delivery_method_id | string | Delivery method ID | Yes |
| inputs | object | Values used to fill missing upstream variables referenced in form_content | No |

#### HumanInputFormDefinition

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| actions | [ [UserActionConfig](#useractionconfig) ] |  | No |
| display_in_ui | boolean |  | No |
| expiration_time | integer |  | Yes |
| form_content | string |  | Yes |
| form_id | string |  | Yes |
| form_token | string |  | No |
| inputs | [ [FormInputConfig](#forminputconfig) ] |  | No |
| node_id | string |  | Yes |
| node_title | string |  | Yes |
| resolved_default_values | object |  | No |

#### HumanInputFormPreviewPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object | Values used to fill missing upstream variables referenced in form_content | No |

#### HumanInputFormSubmissionData

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action_id | string |  | Yes |
| action_text | string |  | Yes |
| node_id | string |  | Yes |
| node_title | string |  | Yes |
| rendered_content | string |  | Yes |
| submitted_data | object |  | No |

#### HumanInputFormSubmitPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string | Selected action ID | Yes |
| form_inputs | object | Values the user provides for the form's own fields | Yes |
| inputs | object | Values used to fill missing upstream variables referenced in form_content | Yes |

#### HumanInputPauseTypeResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| backstage_input_url | string |  | No |
| form_id | string |  | Yes |
| type | string |  | Yes |

#### IconInfo

Icon information model.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| icon_url | string |  | No |

#### IconType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IconType | string |  |  |

#### IdentityMode

How Dify forwards the end-user's identity to an MCP server.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IdentityMode | string | How Dify forwards the end-user's identity to an MCP server. |  |

#### Import

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | No |
| app_mode | string |  | No |
| current_dsl_version | string, <br>**Default:** 0.6.0 |  | No |
| error | string |  | No |
| id | string |  | Yes |
| imported_dsl_version | string |  | No |
| status | [ImportStatus](#importstatus) |  | Yes |

#### ImportStatus

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ImportStatus | string |  |  |

#### IncludeSecretQuery

Query parameter for including secret variables in export.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| include_secret | string, <br>**Default:** false | Whether to include secret variables | No |

#### IndexingEstimate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| preview | [ [PreviewDetail](#previewdetail) ] |  | Yes |
| qa_preview | [ [QAPreviewDetail](#qapreviewdetail) ] |  | No |
| total_segments | integer |  | Yes |

#### IndexingEstimatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dataset_id | string |  | No |
| doc_form | string, <br>**Default:** text_model |  | No |
| doc_language | string, <br>**Default:** English |  | No |
| indexing_technique | string |  | Yes |
| info_list | object |  | Yes |
| process_rule | object |  | Yes |

#### IndexingEstimatePreviewItemResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| child_chunks | [ string ] |  | No |
| content | string |  | Yes |
| summary | string |  | No |

#### IndexingEstimateQaPreviewItemResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | Yes |
| question | string |  | Yes |

#### IndexingEstimateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| preview | [ [IndexingEstimatePreviewItemResponse](#indexingestimatepreviewitemresponse) ] |  | Yes |
| qa_preview | [ [IndexingEstimateQaPreviewItemResponse](#indexingestimateqapreviewitemresponse) ] |  | No |
| total_segments | integer |  | Yes |

#### InfoList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data_source_type | string, <br>**Available values:** "notion_import", "upload_file", "website_crawl" | *Enum:* `"notion_import"`, `"upload_file"`, `"website_crawl"` | Yes |
| file_info_list | [FileInfo](#fileinfo) |  | No |
| notion_info_list | [ [NotionInfo](#notioninfo) ] |  | No |
| website_info_list | [WebsiteInfo](#websiteinfo) |  | No |

#### Inner

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model | string |  | No |
| model_type | [ModelType](#modeltype) |  | Yes |
| provider | string |  | No |

#### InputFieldDefinition

Input field definition for snippet parameters.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default | string |  | No |
| hint | boolean |  | No |
| label | string |  | No |
| max_length | integer |  | No |
| options | [ string ] |  | No |
| placeholder | string |  | No |
| required | boolean |  | No |
| type | string |  | No |

#### InstallPermission

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InstallPermission | string |  |  |

#### InstalledAppCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | Yes |

#### InstalledAppInfoResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| id | string |  | Yes |
| mode | string |  | No |
| name | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |

#### InstalledAppListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| installed_apps | [ [InstalledAppResponse](#installedappresponse) ] |  | Yes |

#### InstalledAppResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app | [InstalledAppInfoResponse](#installedappinforesponse) |  | Yes |
| app_owner_tenant_id | string |  | Yes |
| editable | boolean |  | Yes |
| id | string |  | Yes |
| is_pinned | boolean |  | Yes |
| last_used_at | integer |  | No |
| uninstallable | boolean |  | Yes |

#### InstalledAppUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| is_pinned | boolean |  | No |

#### InstalledAppsListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string | App ID to filter by | No |

#### InstructionGeneratePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| current | string | Current instruction text | No |
| flow_id | string | Workflow/Flow ID | Yes |
| ideal_output | string | Expected ideal output | No |
| instruction | string | Instruction for generation | Yes |
| language | string, <br>**Default:** javascript | Programming language (javascript/python) | No |
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
| node_id | string | Node ID for workflow context | No |

#### InstructionTemplatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string | Instruction template type | Yes |

#### IterationNodeRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | No |

#### JSONValue

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| JSONValue |  |  |  |

#### JsonValue

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| JsonValue |  |  |  |

#### KnowledgeConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data_source | [DataSource](#datasource) |  | No |
| doc_form | string, <br>**Default:** text_model |  | No |
| doc_language | string, <br>**Default:** English |  | No |
| duplicate | boolean, <br>**Default:** true |  | No |
| embedding_model | string |  | No |
| embedding_model_provider | string |  | No |
| indexing_technique | string, <br>**Available values:** "economy", "high_quality" | *Enum:* `"economy"`, `"high_quality"` | Yes |
| is_multimodal | boolean |  | No |
| name | string |  | No |
| original_document_id | string |  | No |
| process_rule | [ProcessRule](#processrule) |  | No |
| retrieval_model | [RetrievalModel](#retrievalmodel) |  | No |
| summary_index_setting | object |  | No |

#### KnowledgePipeline

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| publish_enabled | boolean |  | Yes |

#### LLMMode

Enum class for large language model mode.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LLMMode | string | Enum class for large language model mode. |  |

#### LegacyEndpointUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endpoint_id | string |  | Yes |
| name | string |  | Yes |
| settings | object |  | Yes |

#### LicenseLimitationModel

- enabled: whether this limit is enforced
- size: current usage count
- limit: maximum allowed count; 0 means unlimited

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean | Whether this limit is currently active | Yes |
| limit | integer | Maximum number of resources allowed; 0 means no limit | Yes |
| size | integer | Number of resources already consumed | Yes |

#### LicenseModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expired_at | string |  | Yes |
| status | [LicenseStatus](#licensestatus) |  | Yes |
| workspaces | [LicenseLimitationModel](#licenselimitationmodel) |  | Yes |

#### LicenseStatus

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LicenseStatus | string |  |  |

#### LimitationModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer |  | Yes |
| size | integer |  | Yes |

#### LoadBalancingCredentialPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### LoadBalancingPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| configs | [ object ] |  | No |
| enabled | boolean |  | No |

#### LoginPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| invite_token | string | Invitation token | No |
| password | string |  | Yes |
| remember_me | boolean | Remember me flag | No |

#### LoopNodeRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | No |

#### MCPAuthPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authorization_code | string |  | No |
| provider_id | string |  | Yes |

#### MCPProviderCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authentication | object |  | No |
| configuration | object |  | No |
| headers | object |  | No |
| icon | string |  | Yes |
| icon_background | string |  | No |
| icon_type | string |  | Yes |
| identity_mode | [IdentityMode](#identitymode) |  | No |
| name | string |  | Yes |
| server_identifier | string |  | Yes |
| server_url | string |  | Yes |

#### MCPProviderDeletePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider_id | string |  | Yes |

#### MCPProviderUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authentication | object |  | No |
| configuration | object |  | No |
| headers | object |  | No |
| icon | string |  | Yes |
| icon_background | string |  | No |
| icon_type | string |  | Yes |
| identity_mode | [IdentityMode](#identitymode) |  | No |
| name | string |  | Yes |
| provider_id | string |  | Yes |
| server_identifier | string |  | Yes |
| server_url | string |  | Yes |

#### MCPServerCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Server description | No |
| parameters | object | Server parameters configuration | Yes |

#### MCPServerUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Server description | No |
| id | string | Server ID | Yes |
| parameters | object | Server parameters configuration | Yes |
| status | string | Server status | No |

#### Marketplace

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| marketplace_plugin_unique_identifier | string |  | Yes |
| version | string |  | No |

#### MemberInvitePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emails | [ string ] |  | No |
| language | string |  | No |
| role | [TenantAccountRole](#tenantaccountrole) |  | Yes |

#### MemberRoleUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| role | string |  | Yes |

#### MessageDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_thoughts | [ [AgentThought](#agentthought) ] |  | Yes |
| annotation | [ConversationAnnotation](#conversationannotation) |  | No |
| annotation_hit_history | [ConversationAnnotationHitHistory](#conversationannotationhithistory) |  | No |
| answer_tokens | integer |  | Yes |
| conversation_id | string |  | Yes |
| created_at | integer |  | No |
| error | string |  | No |
| feedbacks | [ [Feedback](#feedback) ] |  | Yes |
| from_account_id | string |  | No |
| from_end_user_id | string |  | No |
| from_source | string |  | Yes |
| id | string |  | Yes |
| inputs | object |  | Yes |
| message | [JSONValue](#jsonvalue) |  | Yes |
| message_files | [ [MessageFile](#messagefile) ] |  | Yes |
| message_metadata_dict | [JSONValue](#jsonvalue) |  | Yes |
| message_tokens | integer |  | Yes |
| parent_message_id | string |  | No |
| provider_response_latency | number |  | Yes |
| query | string |  | Yes |
| re_sign_file_url_answer | string |  | Yes |
| status | string |  | Yes |
| workflow_run_id | string |  | No |

#### MessageDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_thoughts | [ [AgentThought](#agentthought) ] |  | No |
| annotation | [ConversationAnnotation](#conversationannotation) |  | No |
| annotation_hit_history | [ConversationAnnotationHitHistory](#conversationannotationhithistory) |  | No |
| answer_tokens | integer |  | No |
| conversation_id | string |  | Yes |
| created_at | integer |  | No |
| error | string |  | No |
| extra_contents | [ [HumanInputContent](#humaninputcontent) ] |  | No |
| feedbacks | [ [Feedback](#feedback) ] |  | No |
| from_account_id | string |  | No |
| from_end_user_id | string |  | No |
| from_source | string |  | Yes |
| id | string |  | Yes |
| inputs | object |  | Yes |
| message | [JSONValue](#jsonvalue) |  | No |
| message_files | [ [MessageFile](#messagefile) ] |  | No |
| message_metadata_dict | [JSONValue](#jsonvalue) |  | No |
| message_tokens | integer |  | No |
| parent_message_id | string |  | No |
| provider_response_latency | number |  | No |
| query | string |  | Yes |
| re_sign_file_url_answer | string |  | Yes |
| status | string |  | Yes |
| workflow_run_id | string |  | No |

#### MessageFeedbackPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | No |
| message_id | string | Message ID | Yes |
| rating | string |  | No |

#### MessageFile

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| belongs_to | string |  | No |
| filename | string |  | Yes |
| id | string |  | Yes |
| mime_type | string |  | No |
| size | integer |  | No |
| transfer_method | string |  | Yes |
| type | string |  | Yes |
| upload_file_id | string |  | No |
| url | string |  | No |

#### MessageInfiniteScrollPaginationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [MessageDetailResponse](#messagedetailresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |

#### MessageListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation UUID | Yes |
| first_id | string | First message ID for pagination | No |
| limit | integer, <br>**Default:** 20 | Number of messages to return (1-100) | No |

#### MetadataArgs

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |

#### MetadataDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| name | string |  | Yes |
| value | string<br>integer<br>number |  | No |

#### MetadataFilteringCondition

Metadata Filtering Condition.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conditions | [ [Condition](#condition) ] |  | No |
| logical_operator | string |  | No |

#### MetadataOperationData

Metadata operation data

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| operation_data | [ [DocumentMetadataOperation](#documentmetadataoperation) ] |  | Yes |

#### MetadataUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |

#### ModelConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| completion_params | object |  | No |
| mode | [LLMMode](#llmmode) |  | Yes |
| name | string |  | Yes |
| provider | string |  | Yes |

#### ModelConfigPartial

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by | string |  | No |
| model_dict | [JSONValue](#jsonvalue) |  | No |
| pre_prompt | string |  | No |
| updated_at | integer |  | No |
| updated_by | string |  | No |

#### ModelConfigRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_mode | object | Agent mode configuration | No |
| configs | object | Model configuration parameters | No |
| dataset_configs | object | Dataset configurations | No |
| model | string | Model name | No |
| more_like_this | object | More like this configuration | No |
| opening_statement | string | Opening statement | No |
| provider | string | Model provider | No |
| retrieval_model | object | Retrieval model configuration | No |
| speech_to_text | object | Speech to text configuration | No |
| suggested_questions | [ string ] | Suggested questions | No |
| text_to_speech | object | Text to speech configuration | No |
| tools | [ object ] | Available tools | No |

#### ModelType

Enum class for model type.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ModelType | string | Enum class for model type. |  |

#### MoreLikeThisQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| response_mode | string, <br>**Available values:** "blocking", "streaming" | *Enum:* `"blocking"`, `"streaming"` | Yes |

#### NewAppResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_app_id | string |  | Yes |

#### NodeIdQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string |  | Yes |

#### NodeOutputStatus

Lifecycle status of a single declared output within a run.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NodeOutputStatus | string | Lifecycle status of a single declared output within a run. |  |

#### NodeOutputView

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| output_check | [CheckResultView](#checkresultview) |  | No |
| retried | integer |  | No |
| status | [NodeOutputStatus](#nodeoutputstatus) |  | Yes |
| type | [DeclaredOutputType](#declaredoutputtype) |  | No |
| type_check | [CheckResultView](#checkresultview) |  | No |
| value_preview |  |  | No |

#### NodeOutputsView

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_completed_at | string |  | No |
| node_display_name | string |  | Yes |
| node_id | string |  | Yes |
| node_kind | string |  | Yes |
| node_started_at | string |  | No |
| node_status | [NodeStatus](#nodestatus) |  | Yes |
| outputs | [ [NodeOutputView](#nodeoutputview) ] |  | No |

#### NodeRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | No |

#### NodeRunRequiredPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | Yes |

#### NodeStatus

Coarse node-level status used by Inspector to pick a banner.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NodeStatus | string | Coarse node-level status used by Inspector to pick a banner. |  |

#### NotionEstimatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| doc_form | string, <br>**Default:** text_model |  | No |
| doc_language | string, <br>**Default:** English |  | No |
| notion_info_list | [ object ] |  | Yes |
| process_rule | object |  | Yes |

#### NotionIcon

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emoji | string |  | No |
| type | string |  | Yes |
| url | string |  | No |

#### NotionInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| pages | [ [NotionPage](#notionpage) ] |  | Yes |
| workspace_id | string |  | Yes |

#### NotionIntegrateInfoListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| notion_info | [ [NotionIntegrateWorkspaceResponse](#notionintegrateworkspaceresponse) ] |  | Yes |

#### NotionIntegratePageResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| is_bound | boolean |  | Yes |
| page_icon | [DataSourceIntegrateIconResponse](#datasourceintegrateiconresponse) |  | Yes |
| page_id | string |  | Yes |
| page_name | string |  | Yes |
| parent_id | string |  | Yes |
| type | string |  | Yes |

#### NotionIntegrateWorkspaceResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pages | [ [NotionIntegratePageResponse](#notionintegratepageresponse) ] |  | Yes |
| workspace_icon | string |  | Yes |
| workspace_id | string |  | Yes |
| workspace_name | string |  | Yes |

#### NotionPage

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| page_icon | [NotionIcon](#notionicon) |  | No |
| page_id | string |  | Yes |
| page_name | string |  | Yes |
| type | string |  | Yes |

#### OAuthDataSourceBindingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result | Yes |

#### OAuthDataSourceResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | string | Authorization URL or 'internal' for internal setup | Yes |

#### OAuthDataSourceSyncResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result | Yes |

#### OutputErrorStrategy

Per-output failure handling strategy.

Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of
a Workflow Agent Node. The runtime applies the strategy after type check or
output check fails and any configured retry attempts have been exhausted.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| OutputErrorStrategy | string | Per-output failure handling strategy.  Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of a Workflow Agent Node. The runtime applies the strategy after type check or output check fails and any configured retry attempts have been exhausted. |  |

#### OutputPreviewView

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string |  | Yes |
| output_name | string |  | Yes |
| status | [NodeOutputStatus](#nodeoutputstatus) |  | Yes |
| type | [DeclaredOutputType](#declaredoutputtype) |  | No |
| value |  |  | No |

#### OwnerTransferCheckPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string |  | Yes |
| token | string |  | Yes |

#### OwnerTransferEmailPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string |  | No |

#### OwnerTransferPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| token | string |  | Yes |

#### Package

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_unique_identifier | string |  | Yes |
| version | string |  | No |

#### PaginatedConversationVariableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ConversationVariableResponse](#conversationvariableresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### ParagraphInputConfig

Form input definition.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default | [StringSource](#stringsource) |  | No |
| output_variable_name | string |  | Yes |
| type | string |  | No |

#### Parser

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | No |
| datasource_type | string |  | Yes |
| inputs | object |  | Yes |

#### ParserAsset

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file_name | string |  | Yes |
| plugin_unique_identifier | string |  | Yes |

#### ParserCreateCredential

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |
| name | string |  | No |

#### ParserCredentialCreate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| name | string |  | No |

#### ParserCredentialDelete

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |

#### ParserCredentialId

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | No |

#### ParserCredentialSwitch

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |

#### ParserCredentialUpdate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| credentials | object |  | Yes |
| name | string |  | No |

#### ParserCredentialValidate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |

#### ParserDeleteCredential

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### ParserDeleteModels

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### ParserDynamicOptions

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string |  | Yes |
| credential_id | string |  | No |
| parameter | string |  | Yes |
| plugin_id | string |  | Yes |
| provider | string |  | Yes |
| provider_type | string, <br>**Available values:** "tool", "trigger" | *Enum:* `"tool"`, `"trigger"` | Yes |

#### ParserDynamicOptionsWithCredentials

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string |  | Yes |
| credential_id | string |  | Yes |
| credentials | object |  | Yes |
| parameter | string |  | Yes |
| plugin_id | string |  | Yes |
| provider | string |  | Yes |

#### ParserEnable

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enable_trigger | boolean |  | Yes |
| trigger_id | string |  | Yes |

#### ParserExcludePlugin

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_id | string |  | Yes |

#### ParserGetCredentials

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| config_from | string |  | No |
| credential_id | string |  | No |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### ParserGetDefault

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model_type | [ModelType](#modeltype) |  | Yes |

#### ParserGithubInstall

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| package | string |  | Yes |
| plugin_unique_identifier | string |  | Yes |
| repo | string |  | Yes |
| version | string |  | Yes |

#### ParserGithubUpgrade

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_plugin_unique_identifier | string |  | Yes |
| original_plugin_unique_identifier | string |  | Yes |
| package | string |  | Yes |
| repo | string |  | Yes |
| version | string |  | Yes |

#### ParserGithubUpload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| package | string |  | Yes |
| repo | string |  | Yes |
| version | string |  | Yes |

#### ParserIcon

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| filename | string |  | Yes |
| tenant_id | string |  | Yes |

#### ParserLatest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_ids | [ string ] |  | Yes |

#### ParserList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| page | integer, <br>**Default:** 1 | Page number | No |
| page_size | integer, <br>**Default:** 256 | Page size (1-256) | No |

#### ParserMarketplaceUpgrade

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_plugin_unique_identifier | string |  | Yes |
| original_plugin_unique_identifier | string |  | Yes |

#### ParserModelList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model_type | [ModelType](#modeltype) |  | No |

#### ParserParameter

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model | string |  | Yes |

#### ParserPermissionChange

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| debug_permission | [DebugPermission](#debugpermission) |  | Yes |
| install_permission | [InstallPermission](#installpermission) |  | Yes |

#### ParserPluginIdentifierQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_unique_identifier | string |  | Yes |

#### ParserPluginIdentifiers

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_unique_identifiers | [ string ] |  | Yes |

#### ParserPostDefault

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model_settings | [ [Inner](#inner) ] |  | Yes |

#### ParserPostModels

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| config_from | string |  | No |
| credential_id | string |  | No |
| load_balancing | [LoadBalancingPayload](#loadbalancingpayload) |  | No |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### ParserPreferencesChange

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auto_upgrade | [PluginAutoUpgradeSettingsPayload](#pluginautoupgradesettingspayload) |  | Yes |
| permission | [PluginPermissionSettingsPayload](#pluginpermissionsettingspayload) |  | Yes |

#### ParserPreferredProviderType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| preferred_provider_type | string, <br>**Available values:** "custom", "system" | *Enum:* `"custom"`, `"system"` | Yes |

#### ParserReadme

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string, <br>**Default:** en-US |  | No |
| plugin_unique_identifier | string |  | Yes |

#### ParserSwitch

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### ParserTasks

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| page | integer, <br>**Default:** 1 | Page number | No |
| page_size | integer, <br>**Default:** 256 | Page size (1-256) | No |

#### ParserUninstall

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_installation_id | string |  | Yes |

#### ParserUpdateCredential

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string |  | Yes |
| credentials | object |  | Yes |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |
| name | string |  | No |

#### ParserValidate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |
| model | string |  | Yes |
| model_type | [ModelType](#modeltype) |  | Yes |

#### PartialMemberListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ string ] |  | Yes |

#### PartnerTenantsPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| click_id | string | Click Id from partner referral link | Yes |

#### PausedNodeResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string |  | Yes |
| node_title | string |  | Yes |
| pause_type | [HumanInputPauseTypeResponse](#humaninputpausetyperesponse) |  | Yes |

#### PermissionEnum

Shared permission levels for resources (datasets, credentials, etc.)

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PermissionEnum | string | Shared permission levels for resources (datasets, credentials, etc.) |  |

#### PipelineTemplateDetailQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string, <br>**Default:** built-in | Template source: built-in or customized | No |

#### PipelineTemplateDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chunk_structure | string |  | Yes |
| created_by | string |  | No |
| description | string |  | Yes |
| export_data | string |  | Yes |
| graph | object |  | Yes |
| icon_info | object |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |

#### PipelineTemplateItemResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chunk_structure | string |  | Yes |
| copyright | string |  | No |
| description | string |  | Yes |
| icon | object |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |
| position | integer |  | Yes |
| privacy_policy | string |  | No |

#### PipelineTemplateListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string, <br>**Default:** en-US | Template language | No |
| type | string, <br>**Default:** built-in | Template source: built-in or customized | No |

#### PipelineTemplateListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pipeline_templates | [ [PipelineTemplateItemResponse](#pipelinetemplateitemresponse) ] |  | Yes |

#### PipelineVariableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_file_extensions | [ string ] |  | No |
| allowed_file_types | [ string ] |  | No |
| allowed_file_upload_methods | [ string ] |  | No |
| belong_to_node_id | string |  | Yes |
| default_value | object |  | No |
| label | string |  | Yes |
| max_length | integer |  | No |
| options | [ string ] |  | No |
| placeholder | string |  | No |
| required | boolean |  | Yes |
| tooltips | string |  | No |
| type | string |  | Yes |
| unit | string |  | No |
| variable | string |  | Yes |

#### PluginAutoUpgradeSettingsPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| exclude_plugins | [ string ] |  | No |
| include_plugins | [ string ] |  | No |
| strategy_setting | [StrategySetting](#strategysetting) |  | No |
| upgrade_mode | [UpgradeMode](#upgrademode) |  | No |
| upgrade_time_of_day | integer |  | No |

#### PluginDebuggingKeyResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| host | string |  | Yes |
| key | string |  | Yes |
| port | integer |  | Yes |

#### PluginDependency

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| current_identifier | string |  | No |
| type | [Type](#type) |  | Yes |
| value | [Github](#github)<br>[Marketplace](#marketplace)<br>[Package](#package) |  | Yes |

#### PluginEndpointListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endpoints | [ object ] | Endpoint information | Yes |

#### PluginInstallationPermissionModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_installation_scope | [PluginInstallationScope](#plugininstallationscope) |  | Yes |
| restrict_to_marketplace_only | boolean |  | Yes |

#### PluginInstallationScope

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PluginInstallationScope | string |  |  |

#### PluginManagerModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | Yes |

#### PluginPermissionSettingsPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| debug_permission | [DebugPermission](#debugpermission) |  | No |
| install_permission | [InstallPermission](#installpermission) |  | No |

#### PreProcessingRule

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | Yes |
| id | string |  | Yes |

#### PreviewDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| child_chunks | [ string ] |  | No |
| content | string |  | Yes |
| summary | string |  | No |

#### ProcessRule

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mode | [ProcessRuleMode](#processrulemode) |  | Yes |
| rules | [Rule](#rule) |  | No |

#### ProcessRuleMode

Dataset Process Rule Mode

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProcessRuleMode | string | Dataset Process Rule Mode |  |

#### PublishWorkflowPayload

Payload for publishing snippet workflow.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| knowledge_base_setting | object |  | No |

#### PublishedWorkflowRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| datasource_info_list | [ object ] |  | Yes |
| datasource_type | string |  | Yes |
| inputs | object |  | Yes |
| is_preview | boolean |  | No |
| original_document_id | string |  | No |
| response_mode | string, <br>**Available values:** "blocking", "streaming", <br>**Default:** streaming | *Enum:* `"blocking"`, `"streaming"` | No |
| start_node_id | string |  | Yes |

#### QAPreviewDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | Yes |
| question | string |  | Yes |

#### Quota

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer |  | Yes |
| reset_date | integer, <br>**Default:** -1 |  | Yes |
| usage | integer |  | Yes |

#### RagPipelineDatasetImportPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| yaml_content | string |  | Yes |

#### RagPipelineImportCheckDependenciesResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] |  | No |

#### RagPipelineImportPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| mode | string |  | Yes |
| name | string |  | No |
| pipeline_id | string |  | No |
| yaml_content | string |  | No |
| yaml_url | string |  | No |

#### RagPipelineImportResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| current_dsl_version | string |  | Yes |
| dataset_id | string |  | No |
| error | string |  | No |
| id | string |  | Yes |
| imported_dsl_version | string |  | Yes |
| pipeline_id | string |  | No |
| status | [ImportStatus](#importstatus) |  | Yes |

#### RagPipelineRecommendedPluginQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string, <br>**Default:** all |  | No |

#### RagPipelineWorkflowPublishResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | Yes |
| result | string |  | Yes |

#### RagPipelineWorkflowSyncResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| hash | string |  | Yes |
| result | string |  | Yes |
| updated_at | integer |  | Yes |

#### RecommendedAppInfoResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| id | string |  | Yes |
| mode | string |  | No |
| name | string |  | No |

#### RecommendedAppListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| categories | [ string ] |  | Yes |
| recommended_apps | [ [RecommendedAppResponse](#recommendedappresponse) ] |  | Yes |

#### RecommendedAppResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app | [RecommendedAppInfoResponse](#recommendedappinforesponse) |  | No |
| app_id | string |  | Yes |
| can_trial | boolean |  | No |
| categories | [ string ] |  | No |
| copyright | string |  | No |
| custom_disclaimer | string |  | No |
| description | string |  | No |
| is_listed | boolean |  | No |
| position | integer |  | No |
| privacy_policy | string |  | No |

#### RecommendedAppsQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string | Language code for recommended app localization | No |

#### RedirectUrlResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| redirect_url | string |  | Yes |

#### RelatedAppListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [RelatedAppResponse](#relatedappresponse) ] |  | Yes |
| total | integer |  | Yes |

#### RelatedAppResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | Yes |
| icon | string |  | Yes |
| icon_background | string |  | Yes |
| icon_type | string |  | Yes |
| icon_url | string |  | No |
| id | string |  | Yes |
| mode | string |  | Yes |
| name | string |  | Yes |

#### RemoteFileInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file_length | integer |  | Yes |
| file_type | string |  | Yes |

#### RemoteFileUploadPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| url | string | URL to fetch | Yes |

#### RerankingModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_model_name | string |  | No |
| reranking_provider_name | string |  | No |

#### ResultResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string |  | Yes |

#### RetrievalMethod

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RetrievalMethod | string |  |  |

#### RetrievalModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| metadata_filtering_conditions | [MetadataFilteringCondition](#metadatafilteringcondition) |  | No |
| reranking_enable | boolean |  | Yes |
| reranking_mode | string |  | No |
| reranking_model | [RerankingModel](#rerankingmodel) |  | No |
| score_threshold | number |  | No |
| score_threshold_enabled | boolean |  | Yes |
| search_method | [RetrievalMethod](#retrievalmethod) |  | Yes |
| top_k | integer |  | Yes |
| weights | [WeightModel](#weightmodel) |  | No |

#### RetrievalSettingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| retrieval_method | [ string ] |  | Yes |

#### RosterAgentCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_soul | [AgentSoulConfig](#agentsoulconfig) |  | No |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | [AgentIconType](#agenticontype) |  | No |
| name | string |  | Yes |
| role | string |  | No |
| version_note | string |  | No |

#### RosterAgentUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | [AgentIconType](#agenticontype) |  | No |
| name | string |  | No |
| role | string |  | No |

#### RosterListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer, <br>**Default:** 1 |  | No |

#### Rule

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| parent_mode | string |  | No |
| pre_processing_rules | [ [PreProcessingRule](#preprocessingrule) ] |  | No |
| segmentation | [Segmentation](#segmentation) |  | No |
| subchunk_segmentation | [Segmentation](#segmentation) |  | No |

#### RuleCodeGeneratePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code_language | string, <br>**Default:** javascript | Programming language for code generation | No |
| instruction | string | Rule generation instruction | Yes |
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
| no_variable | boolean | Whether to exclude variables | No |

#### RuleGeneratePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| instruction | string | Rule generation instruction | Yes |
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
| no_variable | boolean | Whether to exclude variables | No |

#### RuleStructuredOutputPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| instruction | string | Structured output generation instruction | Yes |
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |

#### SandboxFileEntryResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mtime | integer |  | No |
| name | string |  | Yes |
| size | integer |  | No |
| type | string, <br>**Available values:** "dir", "file", "other", "symlink" | *Enum:* `"dir"`, `"file"`, `"other"`, `"symlink"` | Yes |

#### SandboxListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| entries | [ [SandboxFileEntryResponse](#sandboxfileentryresponse) ] |  | No |
| path | string |  | Yes |
| truncated | boolean |  | No |

#### SandboxReadResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| binary | boolean |  | Yes |
| path | string |  | Yes |
| size | integer |  | No |
| text | string |  | No |
| truncated | boolean |  | Yes |

#### SandboxToolFileResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reference | string |  | Yes |
| transfer_method | string, <br>**Default:** tool_file |  | No |

#### SandboxUploadResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| file | [SandboxToolFileResponse](#sandboxtoolfileresponse) |  | Yes |
| path | string |  | Yes |

#### SavedMessageCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message_id | string |  | Yes |

#### SavedMessageListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| last_id | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |

#### SegmentAttachmentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| extension | string |  | Yes |
| id | string |  | Yes |
| mime_type | string |  | Yes |
| name | string |  | Yes |
| size | integer |  | Yes |
| source_url | string |  | Yes |

#### SegmentBatchImportStatusResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| job_id | string |  | Yes |
| job_status | string |  | Yes |

#### SegmentCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | No |
| attachment_ids | [ string ] |  | No |
| content | string |  | Yes |
| keywords | [ string ] |  | No |

#### SegmentDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [SegmentResponse](#segmentresponse) |  | Yes |
| doc_form | string |  | Yes |

#### SegmentIdListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| segment_id | [ string ] | Segment IDs | No |

#### SegmentListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | string, <br>**Default:** all |  | No |
| hit_count_gte | integer |  | No |
| keyword | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer, <br>**Default:** 1 |  | No |
| status | [ string ] |  | No |

#### SegmentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | Yes |
| attachments | [ [SegmentAttachmentResponse](#segmentattachmentresponse) ] |  | Yes |
| child_chunks | [ [ChildChunkResponse](#childchunkresponse) ] |  | Yes |
| completed_at | integer |  | Yes |
| content | string |  | Yes |
| created_at | integer |  | Yes |
| created_by | string |  | Yes |
| disabled_at | integer |  | Yes |
| disabled_by | string |  | Yes |
| document_id | string |  | Yes |
| enabled | boolean |  | Yes |
| error | string |  | Yes |
| hit_count | integer |  | Yes |
| id | string |  | Yes |
| index_node_hash | string |  | Yes |
| index_node_id | string |  | Yes |
| indexing_at | integer |  | Yes |
| keywords | [ string ] |  | Yes |
| position | integer |  | Yes |
| sign_content | string |  | Yes |
| status | string |  | Yes |
| stopped_at | integer |  | Yes |
| summary | string |  | Yes |
| tokens | integer |  | Yes |
| updated_at | integer |  | Yes |
| updated_by | string |  | Yes |
| word_count | integer |  | Yes |

#### SegmentUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | No |
| attachment_ids | [ string ] |  | No |
| content | string |  | Yes |
| keywords | [ string ] |  | No |
| regenerate_child_chunks | boolean |  | No |
| summary | string |  | No |

#### Segmentation

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chunk_overlap | integer |  | No |
| max_tokens | integer |  | Yes |
| separator | string, <br>**Default:** 
 |  | No |

#### SelectInputConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| option_source | [StringListSource](#stringlistsource) |  | Yes |
| output_variable_name | string |  | Yes |
| type | string |  | No |

#### SimpleAccount

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |

#### SimpleDataResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | string |  | Yes |

#### SimpleEndUser

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| is_anonymous | boolean |  | Yes |
| session_id | string |  | No |
| type | string |  | Yes |

#### SimpleMessageDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string |  | Yes |
| inputs | object |  | Yes |
| message | string |  | Yes |
| query | string |  | Yes |

#### SimpleMessageResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message | string |  | Yes |

#### SimpleModelConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model_dict | [JSONValue](#jsonvalue) |  | No |
| pre_prompt | string |  | No |

#### SimpleResultDataResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | string |  | Yes |
| result | string |  | Yes |

#### SimpleResultMessageResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message | string |  | Yes |
| result | string |  | Yes |

#### SimpleResultOptionalDataResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | string |  | No |
| result | string |  | Yes |

#### SimpleResultResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string |  | Yes |

#### Site

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_base_url | string |  | No |
| chat_color_theme | string |  | No |
| chat_color_theme_inverted | boolean |  | No |
| code | string |  | No |
| copyright | string |  | No |
| created_at | integer |  | No |
| created_by | string |  | No |
| custom_disclaimer | string |  | No |
| customize_domain | string |  | No |
| customize_token_strategy | string |  | No |
| default_language | string |  | No |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string<br>[IconType](#icontype) |  | No |
| privacy_policy | string |  | No |
| prompt_public | boolean |  | No |
| show_workflow_steps | boolean |  | No |
| title | string |  | No |
| updated_at | integer |  | No |
| updated_by | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |

#### Snippet

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | object |  | No |
| created_by | [_AnonymousInlineModel_b0fd3f86d9d5](#_anonymousinlinemodel_b0fd3f86d9d5) |  | No |
| description | string |  | No |
| graph | object |  | No |
| icon_info | object |  | No |
| id | string |  | No |
| input_fields | object |  | No |
| is_published | boolean |  | No |
| name | string |  | No |
| tags | [ [_AnonymousInlineModel_7b8b49ca164e](#_anonymousinlinemodel_7b8b49ca164e) ] |  | No |
| type | string |  | No |
| updated_at | object |  | No |
| updated_by | [_AnonymousInlineModel_b0fd3f86d9d5](#_anonymousinlinemodel_b0fd3f86d9d5) |  | No |
| use_count | integer |  | No |
| version | integer |  | No |

#### SnippetDraftNodeRunPayload

Payload for running a single node in snippet draft workflow.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |
| query | string |  | No |

#### SnippetDraftRunPayload

Payload for running snippet draft workflow.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |

#### SnippetDraftSyncPayload

Payload for syncing snippet draft workflow.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ object ] | Ignored. Snippet workflows do not persist conversation variables. | No |
| graph | object |  | Yes |
| hash | string |  | No |
| input_fields | [ object ] |  | No |

#### SnippetImportPayload

Payload for importing snippet from DSL.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Override snippet description | No |
| mode | string | Import mode: yaml-content or yaml-url | Yes |
| name | string | Override snippet name | No |
| snippet_id | string | Snippet ID to update (optional) | No |
| yaml_content | string | YAML content (required for yaml-content mode) | No |
| yaml_url | string | YAML URL (required for yaml-url mode) | No |

#### SnippetIterationNodeRunPayload

Payload for running an iteration node in snippet draft workflow.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | No |

#### SnippetList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| author_name | string |  | No |
| created_at | object |  | No |
| created_by | string |  | No |
| description | string |  | No |
| icon_info | object |  | No |
| id | string |  | No |
| is_published | boolean |  | No |
| name | string |  | No |
| tags | [ [_AnonymousInlineModel_7b8b49ca164e](#_anonymousinlinemodel_7b8b49ca164e) ] |  | No |
| type | string |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |
| use_count | integer |  | No |
| version | integer |  | No |

#### SnippetListQuery

Query parameters for listing snippets.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| creators | [ string ] | Filter by creator account IDs | No |
| is_published | boolean | Filter by published status | No |
| keyword | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer, <br>**Default:** 1 |  | No |
| tag_ids | [ string ] | Filter by tag IDs | No |

#### SnippetLoopNodeRunPayload

Payload for running a loop node in snippet draft workflow.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | No |

#### SnippetPagination

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [_AnonymousInlineModel_7b67ac8a4db8](#_anonymousinlinemodel_7b67ac8a4db8) ] |  | No |
| has_more | boolean |  | No |
| limit | integer |  | No |
| page | integer |  | No |
| total | integer |  | No |

#### SnippetWorkflowListQuery

Query parameters for listing snippet published workflows.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer, <br>**Default:** 10 |  | No |
| page | integer, <br>**Default:** 1 |  | No |

#### SnippetWorkflowResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ [WorkflowConversationVariableResponse](#workflowconversationvariableresponse) ] |  | Yes |
| created_at | integer |  | Yes |
| created_by | [SimpleAccount](#simpleaccount) |  | No |
| environment_variables | [ [WorkflowEnvironmentVariableResponse](#workflowenvironmentvariableresponse) ] |  | Yes |
| features | object |  | Yes |
| graph | object |  | Yes |
| hash | string |  | Yes |
| id | string |  | Yes |
| input_fields | [ object ] |  | No |
| marked_comment | string |  | Yes |
| marked_name | string |  | Yes |
| rag_pipeline_variables | [ [PipelineVariableResponse](#pipelinevariableresponse) ] |  | Yes |
| tool_published | boolean |  | Yes |
| updated_at | integer |  | Yes |
| updated_by | [SimpleAccount](#simpleaccount) |  | No |
| version | string |  | Yes |

#### StatisticTimeRangeQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| end | string | End date (YYYY-MM-DD HH:MM) | No |
| start | string | Start date (YYYY-MM-DD HH:MM) | No |

#### StatusCount

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| failed | integer |  | Yes |
| partial_success | integer |  | Yes |
| paused | integer |  | Yes |
| success | integer |  | Yes |

#### StrategySetting

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| StrategySetting | string |  |  |

#### StringListSource

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| selector | [ string ] |  | No |
| type | [ValueSourceType](#valuesourcetype) |  | Yes |
| value | [ string ] |  | No |

#### StringSource

Default configuration for form inputs.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| selector | [ string ] |  | No |
| type | [ValueSourceType](#valuesourcetype) |  | Yes |
| value | string |  | No |

#### SubscriptionModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interval | string |  | Yes |
| plan | string, <br>**Default:** sandbox |  | Yes |

#### SubscriptionQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interval | string, <br>**Available values:** "month", "year" | Billing interval<br>*Enum:* `"month"`, `"year"` | Yes |
| plan | string, <br>**Available values:** "professional", "team" | Subscription plan<br>*Enum:* `"professional"`, `"team"` | Yes |

#### SuccessResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| success | boolean |  | Yes |

#### SuggestedQuestionsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ string ] | Suggested question | Yes |

#### SwitchWorkspacePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tenant_id | string |  | Yes |

#### SyncDraftWorkflowPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ object ] |  | No |
| environment_variables | [ object ] |  | No |
| features | object |  | Yes |
| graph | object |  | Yes |
| hash | string |  | No |

#### SyncDraftWorkflowResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| hash | string |  | No |
| result | string |  | No |
| updated_at | string |  | No |

#### SystemFeatureModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| branding | [BrandingModel](#brandingmodel) |  | Yes |
| enable_change_email | boolean, <br>**Default:** true |  | Yes |
| enable_collaboration_mode | boolean, <br>**Default:** true |  | Yes |
| enable_creators_platform | boolean |  | Yes |
| enable_email_code_login | boolean |  | Yes |
| enable_email_password_login | boolean, <br>**Default:** true |  | Yes |
| enable_explore_banner | boolean |  | Yes |
| enable_marketplace | boolean |  | Yes |
| enable_social_oauth_login | boolean |  | Yes |
| enable_trial_app | boolean |  | Yes |
| is_allow_create_workspace | boolean |  | Yes |
| is_allow_register | boolean |  | Yes |
| is_email_setup | boolean |  | Yes |
| license | [LicenseModel](#licensemodel) |  | Yes |
| max_plugin_package_size | integer, <br>**Default:** 15728640 |  | Yes |
| plugin_installation_permission | [PluginInstallationPermissionModel](#plugininstallationpermissionmodel) |  | Yes |
| plugin_manager | [PluginManagerModel](#pluginmanagermodel) |  | Yes |
| sso_enforced_for_signin | boolean |  | Yes |
| sso_enforced_for_signin_protocol | string |  | Yes |
| webapp_auth | [WebAppAuthModel](#webappauthmodel) |  | Yes |

#### Tag

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | Yes |

#### TagBasePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Tag name | Yes |
| type | [TagType](#tagtype) |  | Yes |

#### TagBindingPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tag_ids | [ string ] | Tag IDs to bind | Yes |
| target_id | string | Target ID to bind tags to | Yes |
| type | [TagType](#tagtype) |  | Yes |

#### TagBindingRemovePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tag_ids | [ string ] | Tag IDs to remove | Yes |
| target_id | string | Target ID to unbind tag from | Yes |
| type | [TagType](#tagtype) |  | Yes |

#### TagListQueryParam

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword | string | Search keyword | No |
| type | string, <br>**Available values:** "", "app", "knowledge", "snippet" | Tag type filter<br>*Enum:* `""`, `"app"`, `"knowledge"`, `"snippet"` | No |

#### TagResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| binding_count | string |  | No |
| id | string |  | Yes |
| name | string |  | Yes |
| type | string |  | No |

#### TagType

Tag type

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TagType | string | Tag type |  |

#### TagUpdateRequestPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Tag name | Yes |

#### TenantAccountRole

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TenantAccountRole | string |  |  |

#### TenantInfoResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| custom_config | [WorkspaceCustomConfigResponse](#workspacecustomconfigresponse) |  | No |
| id | string |  | Yes |
| in_trial | boolean |  | No |
| name | string |  | No |
| next_credit_reset_date | integer |  | No |
| plan | string |  | No |
| role | string |  | No |
| status | string |  | No |
| trial_credits | integer |  | No |
| trial_credits_used | integer |  | No |
| trial_end_reason | string |  | No |

#### TextContentResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |

#### TextToAudioPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message_id | string | Message ID | No |
| streaming | boolean | Enable streaming response | No |
| text | string | Text to convert to audio | No |
| voice | string | Voice to use for TTS | No |

#### TextToSpeechPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message_id | string | Message ID | No |
| streaming | boolean | Whether to stream audio | No |
| text | string | Text to convert | Yes |
| voice | string | Voice name | No |

#### TextToSpeechRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message_id | string |  | No |
| streaming | boolean |  | No |
| text | string |  | No |
| voice | string |  | No |

#### TextToSpeechVoiceQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string | Language code | Yes |

#### ToolOAuthCustomClientPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| client_params | object |  | No |
| enable_oauth_custom_client | boolean |  | No |

#### ToolParameterForm

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ToolParameterForm | string |  |  |

#### TraceConfigPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tracing_config | object | Tracing configuration data | Yes |
| tracing_provider | string | Tracing provider name | Yes |

#### TraceProviderQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tracing_provider | string | Tracing provider name | Yes |

#### TrialAppDetailWithSite

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| access_mode | string |  | No |
| api_base_url | string |  | No |
| created_at | object |  | No |
| created_by | string |  | No |
| deleted_tools | [ [TrialDeletedTool](#trialdeletedtool) ] |  | No |
| description | string |  | No |
| enable_api | boolean |  | No |
| enable_site | boolean |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| icon_url | object |  | No |
| id | string |  | No |
| max_active_requests | integer |  | No |
| mode | string |  | No |
| model_config | [TrialAppModelConfig](#trialappmodelconfig) |  | No |
| name | string |  | No |
| site | [TrialSite](#trialsite) |  | No |
| tags | [ [TrialTag](#trialtag) ] |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |
| workflow | [TrialWorkflowPartial](#trialworkflowpartial) |  | No |

#### TrialAppModelConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_mode | object |  | No |
| annotation_reply | object |  | No |
| chat_prompt_config | object |  | No |
| completion_prompt_config | object |  | No |
| created_at | object |  | No |
| created_by | string |  | No |
| dataset_configs | object |  | No |
| dataset_query_variable | string |  | No |
| external_data_tools | object |  | No |
| file_upload | object |  | No |
| model | object |  | No |
| more_like_this | object |  | No |
| opening_statement | string |  | No |
| pre_prompt | string |  | No |
| prompt_type | string |  | No |
| retriever_resource | object |  | No |
| sensitive_word_avoidance | object |  | No |
| speech_to_text | object |  | No |
| suggested_questions | object |  | No |
| suggested_questions_after_answer | object |  | No |
| text_to_speech | object |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |
| user_input_form | object |  | No |

#### TrialConversationVariable

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| id | string |  | No |
| name | string |  | No |
| value | object |  | No |
| value_type | string |  | No |

#### TrialDeletedTool

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider_id | string |  | No |
| tool_name | string |  | No |
| type | string |  | No |

#### TrialModelsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| trial_models | [ string ] |  | Yes |

#### TrialPipelineVariable

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_file_extension | [ string ] |  | No |
| allow_file_upload_methods | [ string ] |  | No |
| allowed_file_types | [ string ] |  | No |
| belong_to_node_id | string |  | No |
| default_value | object |  | No |
| label | string |  | No |
| max_length | integer |  | No |
| options | [ string ] |  | No |
| placeholder | string |  | No |
| required | boolean |  | No |
| tooltips | string |  | No |
| type | string |  | No |
| unit | string |  | No |
| variable | string |  | No |

#### TrialSimpleAccount

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | No |
| id | string |  | No |
| name | string |  | No |

#### TrialSite

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| access_token | string |  | No |
| app_base_url | string |  | No |
| chat_color_theme | string |  | No |
| chat_color_theme_inverted | boolean |  | No |
| code | string |  | No |
| copyright | string |  | No |
| created_at | object |  | No |
| created_by | string |  | No |
| custom_disclaimer | string |  | No |
| customize_domain | string |  | No |
| customize_token_strategy | string |  | No |
| default_language | string |  | No |
| description | string |  | No |
| icon | string |  | No |
| icon_background | string |  | No |
| icon_type | string |  | No |
| icon_url | object |  | No |
| privacy_policy | string |  | No |
| prompt_public | boolean |  | No |
| show_workflow_steps | boolean |  | No |
| title | string |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |
| use_icon_as_answer_icon | boolean |  | No |

#### TrialTag

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| name | string |  | No |
| type | string |  | No |

#### TrialWorkflow

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ [TrialConversationVariable](#trialconversationvariable) ] |  | No |
| created_at | object |  | No |
| created_by | [TrialSimpleAccount](#trialsimpleaccount) |  | No |
| environment_variables | [ object ] |  | No |
| features | object |  | No |
| graph | object |  | No |
| hash | string |  | No |
| id | string |  | No |
| marked_comment | string |  | No |
| marked_name | string |  | No |
| rag_pipeline_variables | [ [TrialPipelineVariable](#trialpipelinevariable) ] |  | No |
| tool_published | boolean |  | No |
| updated_at | object |  | No |
| updated_by | [TrialSimpleAccount](#trialsimpleaccount) |  | No |
| version | string |  | No |

#### TrialWorkflowPartial

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | object |  | No |
| created_by | string |  | No |
| id | string |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |

#### TriggerOAuthClientPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| client_params | object |  | No |
| enabled | boolean |  | No |

#### TriggerSubscriptionBuilderCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_type | string, <br>**Default:** unauthorized |  | No |

#### TriggerSubscriptionBuilderUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | No |
| name | string |  | No |
| parameters | object |  | No |
| properties | object |  | No |

#### TriggerSubscriptionBuilderVerifyPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object |  | Yes |

#### Type

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Type | string |  |  |

#### UpdateAnnotationPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_reply | object |  | No |
| answer | string |  | No |
| content | string |  | No |
| question | string |  | No |

#### UpdateAppPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | App description (max 400 chars) | No |
| icon | string | Icon | No |
| icon_background | string | Icon background color | No |
| icon_type | [IconType](#icontype) | Icon type | No |
| max_active_requests | integer | Maximum active requests | No |
| name | string | App name | Yes |
| use_icon_as_answer_icon | boolean | Use icon as answer icon | No |

#### UpdateSnippetPayload

Payload for updating a snippet.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| icon_info | [IconInfo](#iconinfo) |  | No |
| name | string |  | No |

#### UpgradeMode

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| UpgradeMode | string |  |  |

#### UploadConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| attachment_image_file_size_limit | integer |  | No |
| audio_file_size_limit | integer |  | Yes |
| batch_count_limit | integer |  | Yes |
| file_size_limit | integer |  | Yes |
| file_upload_limit | integer |  | No |
| image_file_batch_limit | integer |  | Yes |
| image_file_size_limit | integer |  | Yes |
| single_chunk_attachment_limit | integer |  | Yes |
| video_file_size_limit | integer |  | Yes |
| workflow_file_upload_limit | integer |  | Yes |

#### UrlResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| url | string |  | Yes |

#### UsageCheckResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| is_using | boolean |  | Yes |

#### UsageCountResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| count | integer |  | Yes |
| is_using | boolean |  | Yes |

#### UserActionConfig

User action configuration.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| button_style | [ButtonStyle](#buttonstyle) |  | No |
| id | string |  | Yes |
| title | string |  | Yes |

#### ValueSourceType

ValueSourceType records whether the value comes from a static setting
in form definiton, or a variable while the workflow is running.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ValueSourceType | string | ValueSourceType records whether the value comes from a static setting in form definiton, or a variable while the workflow is running. |  |

#### VerificationTokenResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |
| is_valid | boolean |  | Yes |
| token | string |  | Yes |

#### WebAppAuthModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_email_code_login | boolean |  | Yes |
| allow_email_password_login | boolean |  | Yes |
| allow_sso | boolean |  | Yes |
| enabled | boolean |  | Yes |
| sso_config | [WebAppAuthSSOModel](#webappauthssomodel) |  | Yes |

#### WebAppAuthSSOModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| protocol | string |  | Yes |

#### WebhookTriggerResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | string |  | No |
| id | string |  | Yes |
| node_id | string |  | Yes |
| webhook_debug_url | string |  | Yes |
| webhook_id | string |  | Yes |
| webhook_url | string |  | Yes |

#### WebsiteCrawlPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| options | object |  | Yes |
| provider | string, <br>**Available values:** "firecrawl", "jinareader", "watercrawl" | *Enum:* `"firecrawl"`, `"jinareader"`, `"watercrawl"` | Yes |
| url | string |  | Yes |

#### WebsiteCrawlStatusQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | string, <br>**Available values:** "firecrawl", "jinareader", "watercrawl" | *Enum:* `"firecrawl"`, `"jinareader"`, `"watercrawl"` | Yes |

#### WebsiteInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| job_id | string |  | Yes |
| only_main_content | boolean, <br>**Default:** true |  | No |
| provider | string |  | Yes |
| urls | [ string ] |  | Yes |

#### WeightKeywordSetting

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_weight | number |  | Yes |

#### WeightModel

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_setting | [WeightKeywordSetting](#weightkeywordsetting) |  | No |
| vector_setting | [WeightVectorSetting](#weightvectorsetting) |  | No |
| weight_type | string |  | No |

#### WeightVectorSetting

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model_name | string |  | Yes |
| embedding_provider_name | string |  | Yes |
| vector_weight | number |  | Yes |

#### WorkflowAgentBindingType

How a workflow node is bound to an Agent.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkflowAgentBindingType | string | How a workflow node is bound to an Agent. |  |

#### WorkflowAgentComposerResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) |  | No |
| agent | [AgentComposerAgentResponse](#agentcomposeragentresponse) |  | No |
| agent_soul | [AgentSoulConfig](#agentsoulconfig) |  | Yes |
| app_id | string |  | No |
| binding | [AgentComposerBindingResponse](#agentcomposerbindingresponse) |  | No |
| effective_declared_outputs | [ [DeclaredOutputConfig](#declaredoutputconfig) ] |  | No |
| impact_summary | [AgentComposerImpactResponse](#agentcomposerimpactresponse) |  | No |
| node_id | string |  | No |
| node_job | [WorkflowNodeJobConfig](#workflownodejobconfig) |  | Yes |
| save_options | [ [ComposerSaveStrategy](#composersavestrategy) ] |  | Yes |
| soul_lock | [AgentComposerSoulLockResponse](#agentcomposersoullockresponse) |  | Yes |
| validation | [ComposerValidationFindingsResponse](#composervalidationfindingsresponse) |  | No |
| variant | string |  | Yes |
| workflow_id | string |  | No |

#### WorkflowAgentSandboxUploadPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_execution_id | string | Optional workflow node execution ID. When omitted, the latest active session for the node is used. | No |
| path | string | File path relative to the sandbox workspace | Yes |

#### WorkflowAppLogPaginationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowAppLogPartialResponse](#workflowapplogpartialresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### WorkflowAppLogPartialResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by_account | [SimpleAccount](#simpleaccount) |  | No |
| created_by_end_user | [SimpleEndUser](#simpleenduser) |  | No |
| created_by_role | string |  | No |
| created_from | string |  | No |
| details |  |  | No |
| id | string |  | Yes |
| workflow_run | [WorkflowRunForLogResponse](#workflowrunforlogresponse) |  | No |

#### WorkflowAppLogQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at__after | string | Filter logs created after this timestamp | No |
| created_at__before | string | Filter logs created before this timestamp | No |
| created_by_account | string | Filter by account | No |
| created_by_end_user_session_id | string | Filter by end user session ID | No |
| detail | boolean | Whether to return detailed logs | No |
| keyword | string | Search keyword for filtering logs | No |
| limit | integer, <br>**Default:** 20 | Number of items per page (1-100) | No |
| page | integer, <br>**Default:** 1 | Page number (1-99999) | No |
| status | [WorkflowExecutionStatus](#workflowexecutionstatus) | Execution status filter (succeeded, failed, stopped, partial-succeeded) | No |

#### WorkflowArchivedLogPaginationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowArchivedLogPartialResponse](#workflowarchivedlogpartialresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |
| total | integer |  | Yes |

#### WorkflowArchivedLogPartialResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by_account | [SimpleAccount](#simpleaccount) |  | No |
| created_by_end_user | [SimpleEndUser](#simpleenduser) |  | No |
| id | string |  | Yes |
| trigger_metadata |  |  | No |
| workflow_run | [WorkflowRunForArchivedLogResponse](#workflowrunforarchivedlogresponse) |  | No |

#### WorkflowCommentAccount

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar_url | string |  | Yes |
| email | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |

#### WorkflowCommentBasic

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| created_at | integer |  | No |
| created_by | string |  | Yes |
| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) |  | No |
| id | string |  | Yes |
| mention_count | integer |  | Yes |
| participants | [ [WorkflowCommentAccount](#workflowcommentaccount) ] |  | Yes |
| position_x | number |  | Yes |
| position_y | number |  | Yes |
| reply_count | integer |  | Yes |
| resolved | boolean |  | Yes |
| resolved_at | integer |  | No |
| resolved_by | string |  | No |
| resolved_by_account | [WorkflowCommentAccount](#workflowcommentaccount) |  | No |
| updated_at | integer |  | No |

#### WorkflowCommentBasicList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowCommentBasic](#workflowcommentbasic) ] |  | Yes |

#### WorkflowCommentCreate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| id | string |  | Yes |

#### WorkflowCommentCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | Comment content | Yes |
| mentioned_user_ids | [ string ] | Mentioned user IDs | No |
| position_x | number | Comment X position | Yes |
| position_y | number | Comment Y position | Yes |

#### WorkflowCommentDetail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| created_at | integer |  | No |
| created_by | string |  | Yes |
| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) |  | No |
| id | string |  | Yes |
| mentions | [ [WorkflowCommentMention](#workflowcommentmention) ] |  | Yes |
| position_x | number |  | Yes |
| position_y | number |  | Yes |
| replies | [ [WorkflowCommentReply](#workflowcommentreply) ] |  | Yes |
| resolved | boolean |  | Yes |
| resolved_at | integer |  | No |
| resolved_by | string |  | No |
| resolved_by_account | [WorkflowCommentAccount](#workflowcommentaccount) |  | No |
| updated_at | integer |  | No |

#### WorkflowCommentMention

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mentioned_user_account | [WorkflowCommentAccount](#workflowcommentaccount) |  | No |
| mentioned_user_id | string |  | Yes |
| reply_id | string |  | No |

#### WorkflowCommentMentionUsersPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| users | [ [AccountWithRole](#accountwithrole) ] |  | Yes |

#### WorkflowCommentReply

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string |  | Yes |
| created_at | integer |  | No |
| created_by | string |  | Yes |
| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) |  | No |
| id | string |  | Yes |

#### WorkflowCommentReplyCreate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| id | string |  | Yes |

#### WorkflowCommentReplyPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | Reply content | Yes |
| mentioned_user_ids | [ string ] | Mentioned user IDs | No |

#### WorkflowCommentReplyUpdate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| updated_at | integer |  | No |

#### WorkflowCommentResolve

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| resolved | boolean |  | Yes |
| resolved_at | integer |  | No |
| resolved_by | string |  | No |

#### WorkflowCommentUpdate

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | Yes |
| updated_at | integer |  | No |

#### WorkflowCommentUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | Comment content | Yes |
| mentioned_user_ids | [ string ] | Mentioned user IDs. Omit to keep existing mentions. | No |
| position_x | number | Comment X position | No |
| position_y | number | Comment Y position | No |

#### WorkflowConversationVariableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |
| value | object |  | Yes |
| value_type | string |  | Yes |

#### WorkflowDraftEnvVariable

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| edited | boolean |  | No |
| id | string |  | No |
| name | string |  | No |
| selector | [ string ] |  | No |
| type | string |  | No |
| value_type | string |  | No |
| visible | boolean |  | No |

#### WorkflowDraftEnvVariableList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| items | [ [WorkflowDraftEnvVariable](#workflowdraftenvvariable) ] |  | No |

#### WorkflowDraftVariable

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| edited | boolean |  | No |
| full_content | object |  | No |
| id | string |  | No |
| is_truncated | boolean |  | No |
| name | string |  | No |
| selector | [ string ] |  | No |
| type | string |  | No |
| value | object |  | No |
| value_type | string |  | No |
| visible | boolean |  | No |

#### WorkflowDraftVariableList

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| items | [ [WorkflowDraftVariable](#workflowdraftvariable) ] |  | No |

#### WorkflowDraftVariableListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer, <br>**Default:** 20 | Items per page | No |
| page | integer, <br>**Default:** 1 | Page number | No |

#### WorkflowDraftVariableListWithoutValue

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| items | [ [WorkflowDraftVariableWithoutValue](#workflowdraftvariablewithoutvalue) ] |  | No |
| total | object |  | No |

#### WorkflowDraftVariablePatchPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | No |
| value |  |  | No |

#### WorkflowDraftVariableUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Variable name | No |
| value |  | Variable value | No |

#### WorkflowDraftVariableWithoutValue

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| edited | boolean |  | No |
| id | string |  | No |
| is_truncated | boolean |  | No |
| name | string |  | No |
| selector | [ string ] |  | No |
| type | string |  | No |
| value_type | string |  | No |
| visible | boolean |  | No |

#### WorkflowEnvironmentVariableResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | Yes |
| id | string |  | Yes |
| name | string |  | Yes |
| value | object |  | Yes |
| value_type | string |  | Yes |

#### WorkflowExecutionStatus

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkflowExecutionStatus | string |  |  |

#### WorkflowFeaturesPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| features | object | Workflow feature configuration | Yes |

#### WorkflowGeneratePayload

Payload for the cmd+k `/create` and `/refine` workflow generator endpoint.

See ``services/workflow_generator_service.py`` for behaviour. Errors are
surfaced through the same envelope as ``/rule-generate`` so the frontend
can reuse its existing handler.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| current_graph | object | Existing draft graph to refine (cmd+k `/refine`); omit for create-from-scratch | No |
| ideal_output | string | Optional sample output for grounding | No |
| instruction | string | Natural-language workflow description | Yes |
| mode | string, <br>**Available values:** "advanced-chat", "workflow" | Target app mode for the generated graph<br>*Enum:* `"advanced-chat"`, `"workflow"` | Yes |
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |

#### WorkflowListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer, <br>**Default:** 10 |  | No |
| named_only | boolean |  | No |
| page | integer, <br>**Default:** 1 |  | No |
| user_id | string |  | No |

#### WorkflowNodeJobConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| declared_outputs | [ [DeclaredOutputConfig](#declaredoutputconfig) ] |  | No |
| human_contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] |  | No |
| metadata | [WorkflowNodeJobMetadata](#workflownodejobmetadata) |  | No |
| mode | [WorkflowNodeJobMode](#workflownodejobmode) |  | No |
| previous_node_output_refs | [ [WorkflowPreviousNodeOutputRef](#workflowpreviousnodeoutputref) ] |  | No |
| schema_version | integer, <br>**Default:** 1 |  | No |
| workflow_prompt | string |  | No |

#### WorkflowNodeJobMetadata

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_soul | object |  | No |
| file_refs | [ [AgentFileRefConfig](#agentfilerefconfig) ] |  | No |

#### WorkflowNodeJobMode

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkflowNodeJobMode | string |  |  |

#### WorkflowOnlineUser

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| avatar | string |  | No |
| user_id | string |  | Yes |
| username | string |  | Yes |

#### WorkflowOnlineUsersByApp

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | Yes |
| users | [ [WorkflowOnlineUser](#workflowonlineuser) ] |  | Yes |

#### WorkflowOnlineUsersPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_ids | [ string ] | App IDs | No |

#### WorkflowOnlineUsersResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowOnlineUsersByApp](#workflowonlineusersbyapp) ] |  | Yes |

#### WorkflowPaginationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_more | boolean |  | Yes |
| items | [ [WorkflowResponse](#workflowresponse) ] |  | Yes |
| limit | integer |  | Yes |
| page | integer |  | Yes |

#### WorkflowPartial

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by | string |  | No |
| id | string |  | Yes |
| updated_at | integer |  | No |
| updated_by | string |  | No |

#### WorkflowPauseDetailsResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paused_at | string |  | No |
| paused_nodes | [ [PausedNodeResponse](#pausednoderesponse) ] |  | Yes |

#### WorkflowPreviousNodeOutputRef

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| key | string |  | No |
| name | string |  | No |
| node_id | string |  | No |
| output | string |  | No |
| selector | [ string<br>integer<br>number<br>boolean ] |  | No |
| value_selector | [ string<br>integer<br>number<br>boolean ] |  | No |
| variable | string |  | No |
| variable_selector | [ string<br>integer<br>number<br>boolean ] |  | No |

#### WorkflowResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_variables | [ [WorkflowConversationVariableResponse](#workflowconversationvariableresponse) ] |  | Yes |
| created_at | integer |  | Yes |
| created_by | [SimpleAccount](#simpleaccount) |  | No |
| environment_variables | [ [WorkflowEnvironmentVariableResponse](#workflowenvironmentvariableresponse) ] |  | Yes |
| features | object |  | Yes |
| graph | object |  | Yes |
| hash | string |  | Yes |
| id | string |  | Yes |
| marked_comment | string |  | Yes |
| marked_name | string |  | Yes |
| rag_pipeline_variables | [ [PipelineVariableResponse](#pipelinevariableresponse) ] |  | Yes |
| tool_published | boolean |  | Yes |
| updated_at | integer |  | Yes |
| updated_by | [SimpleAccount](#simpleaccount) |  | No |
| version | string |  | Yes |

#### WorkflowRunCountQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Workflow run status filter | No |
| time_range | string | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No |
| triggered_from | string | Filter by trigger source: debugging or app-run. Default: debugging | No |

#### WorkflowRunCountResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| failed | integer |  | Yes |
| partial_succeeded | integer |  | Yes |
| running | integer |  | Yes |
| stopped | integer |  | Yes |
| succeeded | integer |  | Yes |
| total | integer |  | Yes |

#### WorkflowRunDetailResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by_account | [SimpleAccount](#simpleaccount) |  | No |
| created_by_end_user | [SimpleEndUser](#simpleenduser) |  | No |
| created_by_role | string |  | No |
| elapsed_time | number |  | No |
| error | string |  | No |
| exceptions_count | integer |  | No |
| finished_at | integer |  | No |
| graph |  |  | Yes |
| id | string |  | Yes |
| inputs |  |  | Yes |
| outputs |  |  | Yes |
| status | string |  | No |
| total_steps | integer |  | No |
| total_tokens | integer |  | No |
| version | string |  | No |

#### WorkflowRunExportResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| presigned_url | string | Pre-signed URL for download | No |
| presigned_url_expires_at | string | Pre-signed URL expiration time | No |
| status | string | Export status: success/failed | Yes |

#### WorkflowRunForArchivedLogResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| elapsed_time | number |  | No |
| id | string |  | Yes |
| status | string |  | No |
| total_tokens | integer |  | No |
| triggered_from | string |  | No |

#### WorkflowRunForListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by_account | [SimpleAccount](#simpleaccount) |  | No |
| elapsed_time | number |  | No |
| exceptions_count | integer |  | No |
| finished_at | integer |  | No |
| id | string |  | Yes |
| retry_index | integer |  | No |
| status | string |  | No |
| total_steps | integer |  | No |
| total_tokens | integer |  | No |
| version | string |  | No |

#### WorkflowRunForLogResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| elapsed_time | number |  | No |
| error | string |  | No |
| exceptions_count | integer |  | No |
| finished_at | integer |  | No |
| id | string |  | Yes |
| status | string |  | No |
| total_steps | integer |  | No |
| total_tokens | integer |  | No |
| triggered_from | string |  | No |
| version | string |  | No |

#### WorkflowRunListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| last_id | string | Last run ID for pagination | No |
| limit | integer, <br>**Default:** 20 | Number of items per page (1-100) | No |
| status | string | Workflow run status filter | No |
| triggered_from | string | Filter by trigger source: debugging or app-run. Default: debugging | No |

#### WorkflowRunNodeExecutionListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) ] |  | Yes |

#### WorkflowRunNodeExecutionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer |  | No |
| created_by_account | [SimpleAccount](#simpleaccount) |  | No |
| created_by_end_user | [SimpleEndUser](#simpleenduser) |  | No |
| created_by_role | string |  | No |
| elapsed_time | number |  | No |
| error | string |  | No |
| execution_metadata |  |  | No |
| extras |  |  | No |
| finished_at | integer |  | No |
| id | string |  | Yes |
| index | integer |  | No |
| inputs |  |  | No |
| inputs_truncated | boolean |  | No |
| node_id | string |  | No |
| node_type | string |  | No |
| outputs |  |  | No |
| outputs_truncated | boolean |  | No |
| predecessor_node_id | string |  | No |
| process_data |  |  | No |
| process_data_truncated | boolean |  | No |
| status | string |  | No |
| title | string |  | No |

#### WorkflowRunPaginationResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowRunForListResponse](#workflowrunforlistresponse) ] |  | Yes |
| has_more | boolean |  | Yes |
| limit | integer |  | Yes |

#### WorkflowRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |

#### WorkflowRunQuery

Query parameters for workflow runs.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| last_id | string |  | No |
| limit | integer, <br>**Default:** 20 |  | No |

#### WorkflowRunRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object ] |  | No |
| inputs | object |  | Yes |

#### WorkflowRunSnapshotView

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_outputs | [ [NodeOutputsView](#nodeoutputsview) ] |  | No |
| workflow_run_id | string |  | Yes |
| workflow_run_status | [WorkflowExecutionStatus](#workflowexecutionstatus) |  | Yes |

#### WorkflowStatisticQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| end | string | End date and time (YYYY-MM-DD HH:MM) | No |
| start | string | Start date and time (YYYY-MM-DD HH:MM) | No |

#### WorkflowToolCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | Yes |
| icon | object |  | Yes |
| label | string |  | Yes |
| labels | [ string ] |  | No |
| name | string |  | Yes |
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] |  | No |
| privacy_policy | string |  | No |
| workflow_app_id | string |  | Yes |

#### WorkflowToolDeletePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflow_tool_id | string |  | Yes |

#### WorkflowToolParameterConfiguration

Workflow tool configuration

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | The description of the parameter | Yes |
| form | [ToolParameterForm](#toolparameterform) | The form of the parameter | Yes |
| name | string | The name of the parameter | Yes |

#### WorkflowToolUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | Yes |
| icon | object |  | Yes |
| label | string |  | Yes |
| labels | [ string ] |  | No |
| name | string |  | Yes |
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] |  | No |
| privacy_policy | string |  | No |
| workflow_tool_id | string |  | Yes |

#### WorkflowTriggerListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowTriggerResponse](#workflowtriggerresponse) ] |  | Yes |

#### WorkflowTriggerResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | string |  | No |
| icon | string |  | Yes |
| id | string |  | Yes |
| node_id | string |  | Yes |
| provider_name | string |  | Yes |
| status | string |  | Yes |
| title | string |  | Yes |
| trigger_type | string |  | Yes |
| updated_at | string |  | No |

#### WorkflowUpdatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| marked_comment | string |  | No |
| marked_name | string |  | No |

#### WorkspaceCustomConfigPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| remove_webapp_brand | boolean |  | No |
| replace_webapp_logo | string |  | No |

#### WorkspaceCustomConfigResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| remove_webapp_brand | boolean |  | No |
| replace_webapp_logo | string |  | No |

#### WorkspaceInfoPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |

#### WorkspaceListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer, <br>**Default:** 20 |  | No |
| page | integer, <br>**Default:** 1 |  | No |

#### WorkspacePermissionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_member_invite | boolean |  | Yes |
| allow_owner_transfer | boolean |  | Yes |
| workspace_id | string |  | Yes |

#### _AnonymousInlineModel_7b67ac8a4db8

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| author_name | string |  | No |
| created_at | object |  | No |
| created_by | string |  | No |
| description | string |  | No |
| icon_info | object |  | No |
| id | string |  | No |
| is_published | boolean |  | No |
| name | string |  | No |
| tags | [ [_AnonymousInlineModel_7b8b49ca164e](#_anonymousinlinemodel_7b8b49ca164e) ] |  | No |
| type | string |  | No |
| updated_at | object |  | No |
| updated_by | string |  | No |
| use_count | integer |  | No |
| version | integer |  | No |

#### _AnonymousInlineModel_7b8b49ca164e

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| name | string |  | No |
| type | string |  | No |

#### _AnonymousInlineModel_b0fd3f86d9d5

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | No |
| id | string |  | No |
| name | string |  | No |

#### _AnonymousInlineModel_b1954337d565

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enable | boolean |  | No |
| model_name | string |  | No |
| model_provider_name | string |  | No |
| summary_prompt | string |  | No |

## FastOpenAPI Preview (OpenAPI 3.1)

### Dify API (FastOpenAPI PoC)
FastOpenAPI proof of concept for Dify API

#### Version: 1.0

---

##### [GET] /console/api/init
**Get initialization validation status.**

###### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: [InitStatusResponse](#initstatusresponse)<br> |

##### [POST] /console/api/init
**Validate initialization password.**

###### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [InitValidatePayload](#initvalidatepayload)<br> |

###### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Created | **application/json**: [InitValidateResponse](#initvalidateresponse)<br> |

##### [GET] /console/api/ping
**Health check endpoint for connection testing.**

###### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: [PingResponse](#pingresponse)<br> |

##### [GET] /console/api/setup
**Get system setup status.

    NOTE: This endpoint is unauthenticated by design.

    During first-time bootstrap there is no admin account yet, so frontend initialization must be
    able to query setup progress before any login flow exists.

    Only bootstrap-safe status information should be returned by this endpoint.
    **

###### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: [SetupStatusResponse](#setupstatusresponse)<br> |

##### [POST] /console/api/setup
**Initialize system setup with admin account.

    NOTE: This endpoint is unauthenticated by design for first-time bootstrap.
    Access is restricted by deployment mode (`SELF_HOSTED`), one-time setup guards,
    and init-password validation rather than user session authentication.
    **

###### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: [SetupRequestPayload](#setuprequestpayload)<br> |

###### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Created | **application/json**: [SetupResponse](#setupresponse)<br> |

##### [GET] /console/api/version
**Check for application version updates.**

###### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| current_version | query |  | Yes | string |

###### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: [VersionResponse](#versionresponse)<br> |

---
##### Schemas

###### ErrorSchema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| error | { **"details"**: string, **"message"**: string, **"status"**: integer, **"type"**: string } |  | Yes |

###### InitStatusResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "finished", "not_started" | Initialization status<br>*Enum:* `"finished"`, `"not_started"` | Yes |

###### InitValidatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| password | string | Initialization password | Yes |

###### InitValidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result | Yes |

###### PingResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Health check result | Yes |

###### SetupRequestPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | Admin email address | Yes |
| language | string | Admin language | No |
| name | string | Admin name (max 30 characters) | Yes |
| password | string | Admin password | Yes |

###### SetupResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Setup result | Yes |

###### SetupStatusResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| setup_at | string | Setup completion time (ISO format) | No |
| step | string, <br>**Available values:** "finished", "not_started" | Setup step status<br>*Enum:* `"finished"`, `"not_started"` | Yes |

###### VersionFeatures

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| can_replace_logo | boolean | Whether logo replacement is supported | Yes |
| model_load_balancing_enabled | boolean | Whether model load balancing is enabled | Yes |

###### VersionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| can_auto_update | boolean | Whether auto-update is supported | Yes |
| features | [VersionFeatures](#versionfeatures) | Feature flags and capabilities | Yes |
| release_date | string | Release date of latest version | Yes |
| release_notes | string | Release notes for latest version | Yes |
| version | string | Latest version number | Yes |