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

## Version: 1.0

### Security
**Bearer**  

| apiKey | *API Key* |
| ------ | --------- |
| Description | Type: Bearer {your-api-key} |
| In | header |
| Name | Authorization |

---
## console
Console management API operations

### /account/avatar

#### GET
##### Description

Get account avatar url

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AvatarUrlResponse](#avatarurlresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountAvatarPayload](#accountavatarpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/change-email

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChangeEmailSendPayload](#changeemailsendpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultDataResponse](#simpleresultdataresponse) |

### /account/change-email/check-email-unique

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [CheckEmailUniquePayload](#checkemailuniquepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /account/change-email/reset

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChangeEmailResetPayload](#changeemailresetpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/change-email/validity

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChangeEmailValidityPayload](#changeemailvaliditypayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [VerificationTokenResponse](#verificationtokenresponse) |

### /account/delete

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountDeletePayload](#accountdeletepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /account/delete/feedback

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountDeletionFeedbackPayload](#accountdeletionfeedbackpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /account/delete/verify

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultDataResponse](#simpleresultdataresponse) |

### /account/education

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [EducationStatusResponse](#educationstatusresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EducationActivatePayload](#educationactivatepayload) |

##### Responses

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

### /account/education/autocomplete

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EducationAutocompleteQuery](#educationautocompletequery) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [EducationAutocompleteResponse](#educationautocompleteresponse) |

### /account/education/verify

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [EducationVerifyResponse](#educationverifyresponse) |

### /account/init

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountInitPayload](#accountinitpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /account/integrates

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AccountIntegrateListResponse](#accountintegratelistresponse) |

### /account/interface-language

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountInterfaceLanguagePayload](#accountinterfacelanguagepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/interface-theme

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountInterfaceThemePayload](#accountinterfacethemepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/name

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountNamePayload](#accountnamepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/password

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountPasswordPayload](#accountpasswordpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/profile

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /account/timezone

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AccountTimezonePayload](#accounttimezonepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [Account](#account) |

### /activate

#### POST
##### Description

Activate account with invitation token

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ActivatePayload](#activatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Account activated successfully | [ActivationResponse](#activationresponse) |
| 400 | Already activated or invalid token |  |

### /activate/check

#### GET
##### Description

Check if activation token is valid

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ActivateCheckQuery](#activatecheckquery) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ActivationCheckResponse](#activationcheckresponse) |

### /agents

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| keyword | query |  | No | string |
| limit | query |  | No | integer |
| page | query |  | No | integer |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent roster list | [AgentRosterListResponse](#agentrosterlistresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RosterAgentCreatePayload](#rosteragentcreatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Agent created | [AgentRosterResponse](#agentrosterresponse) |

### /agents/invite-options

#### GET
##### 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 |
| page | query |  | No | integer |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent invite options | [AgentInviteOptionsResponse](#agentinviteoptionsresponse) |

### /agents/{agent_id}

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent detail | [AgentRosterResponse](#agentrosterresponse) |

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| agent_id | path |  | Yes | string |
| payload | body |  | Yes | [RosterAgentUpdatePayload](#rosteragentupdatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent updated | [AgentRosterResponse](#agentrosterresponse) |

### /agents/{agent_id}/versions

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent versions | [AgentConfigSnapshotListResponse](#agentconfigsnapshotlistresponse) |

### /agents/{agent_id}/versions/{version_id}

#### GET
##### 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 | [AgentConfigSnapshotDetailResponse](#agentconfigsnapshotdetailresponse) |

### /all-workspaces

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkspaceListQuery](#workspacelistquery) |

##### Responses

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

### /api-based-extension

#### GET
##### Description

Get all API-based extensions for current tenant

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [APIBasedExtensionListResponse](#apibasedextensionlistresponse) |

#### POST
##### Description

Create a new API-based extension

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [APIBasedExtensionPayload](#apibasedextensionpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Extension created successfully | [APIBasedExtensionResponse](#apibasedextensionresponse) |

### /api-based-extension/{id}

#### DELETE
##### Description

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
##### Description

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 | [APIBasedExtensionResponse](#apibasedextensionresponse) |

#### POST
##### Description

Update API-based extension

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [APIBasedExtensionPayload](#apibasedextensionpayload) |
| id | path | Extension ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Extension updated successfully | [APIBasedExtensionResponse](#apibasedextensionresponse) |

### /api-key-auth/data-source

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ApiKeyAuthDataSourceListResponse](#apikeyauthdatasourcelistresponse) |

### /api-key-auth/data-source/binding

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ApiKeyAuthBindingPayload](#apikeyauthbindingpayload) |

##### Responses

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

### /api-key-auth/data-source/{binding_id}

#### DELETE
##### Parameters

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

##### Responses

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

### /app-dsl-version

#### GET
##### Summary

Get current app DSL version for workflow clipboard compatibility

##### Description

Get current app DSL version

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AppDslVersionResponse](#appdslversionresponse) |

### /app/prompt-templates

#### GET
##### Description

Get advanced prompt templates based on app mode and model configuration

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AdvancedPromptTemplateQuery](#advancedprompttemplatequery) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Prompt templates retrieved successfully | [ object ] |
| 400 | Invalid request parameters |  |

### /apps

#### GET
##### Summary

Get app list

##### Description

Get list of applications with pagination and filtering

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppListQuery](#applistquery) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AppPagination](#apppagination) |

#### POST
##### Summary

Create app

##### Description

Create a new application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [CreateAppPayload](#createapppayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | App created successfully | [AppDetail](#appdetail) |
| 400 | Invalid request parameters |  |
| 403 | Insufficient permissions |  |

### /apps/imports

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppImportPayload](#appimportpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import completed | [Import](#import) |
| 202 | Import pending confirmation | [Import](#import) |
| 400 | Import failed | [Import](#import) |

### /apps/imports/{app_id}/check-dependencies

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dependencies checked | [CheckDependenciesResult](#checkdependenciesresult) |

### /apps/imports/{import_id}/confirm

#### POST
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import confirmed | [Import](#import) |
| 400 | Import failed | [Import](#import) |

### /apps/workflows/online-users

#### POST
##### Description

Get workflow online users

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowOnlineUsersPayload](#workflowonlineuserspayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow online users retrieved successfully | [WorkflowOnlineUsersResponse](#workflowonlineusersresponse) |

### /apps/{app_id}

#### DELETE
##### Summary

Delete app

##### Description

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
##### Summary

Get app detail

##### Description

Get application details

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AppDetailWithSite](#appdetailwithsite) |

#### PUT
##### Summary

Update app

##### Description

Update application details

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [UpdateAppPayload](#updateapppayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | App updated successfully | [AppDetailWithSite](#appdetailwithsite) |
| 400 | Invalid request parameters |  |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/advanced-chat/workflow-runs

#### GET
##### Summary

Get advanced chat app workflow run list

##### Description

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 |
| status | query | Workflow run status filter | No | string |
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs retrieved successfully | [AdvancedChatWorkflowRunPaginationResponse](#advancedchatworkflowrunpaginationresponse) |

### /apps/{app_id}/advanced-chat/workflow-runs/count

#### GET
##### Summary

Get advanced chat workflow runs count statistics

##### Description

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 |
| 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 |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs count retrieved successfully | [WorkflowRunCountResponse](#workflowruncountresponse) |

### /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/preview

#### POST
##### Summary

Preview human input form content and placeholders

##### Description

Get human input form preview for advanced chat workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [HumanInputFormPreviewPayload](#humaninputformpreviewpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/run

#### POST
##### Summary

Submit human input form preview

##### Description

Submit human input form preview for advanced chat workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [HumanInputFormSubmitPayload](#humaninputformsubmitpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/advanced-chat/workflows/draft/iteration/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow iteration node

##### Description

Run draft workflow iteration node for advanced chat

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [IterationNodeRunPayload](#iterationnoderunpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/advanced-chat/workflows/draft/loop/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow loop node

##### Description

Run draft workflow loop node for advanced chat

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [LoopNodeRunPayload](#loopnoderunpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/advanced-chat/workflows/draft/run

#### POST
##### Summary

Run draft workflow

##### Description

Run draft workflow for advanced chat application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AdvancedChatWorkflowRunPayload](#advancedchatworkflowrunpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/agent-composer

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer state | [AgentAppComposerResponse](#agentappcomposerresponse) |

#### PUT
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [ComposerSavePayload](#composersavepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer saved | [AgentAppComposerResponse](#agentappcomposerresponse) |

### /apps/{app_id}/agent-composer/candidates

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer candidates | [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse) |

### /apps/{app_id}/agent-composer/validate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [ComposerSavePayload](#composersavepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent app composer validation result | [AgentComposerValidateResponse](#agentcomposervalidateresponse) |

### /apps/{app_id}/agent-features

#### POST
##### Description

Update an Agent App's presentation features (opener, follow-up, citations, ...)

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AgentAppFeaturesPayload](#agentappfeaturespayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Features updated successfully | [SimpleResultResponse](#simpleresultresponse) |
| 400 | Invalid configuration |  |
| 404 | App not found |  |

### /apps/{app_id}/agent-referencing-workflows

#### GET
##### Description

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 | [AgentReferencingWorkflowsResponse](#agentreferencingworkflowsresponse) |
| 404 | App not found |  |

### /apps/{app_id}/agent-workspace/files

#### GET
##### Description

List a directory in an Agent App conversation's sandbox workspace (read-only)

##### 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 |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Listing returned | [WorkspaceListResponse](#workspacelistresponse) |

### /apps/{app_id}/agent-workspace/files/download

#### GET
##### Description

Download a file from an Agent App conversation's sandbox workspace (read-only)

##### 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 | File bytes | binary |
| 413 | File exceeds the workspace download limit |  |

### /apps/{app_id}/agent-workspace/files/preview

#### GET
##### Description

Preview a text/binary file in an Agent App conversation's sandbox workspace

##### 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 | [WorkspacePreviewResponse](#workspacepreviewresponse) |

### /apps/{app_id}/agent/logs

#### GET
##### Summary

Get agent logs

##### Description

Get agent execution logs for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AgentLogQuery](#agentlogquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent logs retrieved successfully | [ object ] |
| 400 | Invalid request parameters |  |

### /apps/{app_id}/annotation-reply/{action}

#### POST
##### Description

Enable or disable annotation reply for an app

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AnnotationReplyPayload](#annotationreplypayload) |
| action | path | Action to perform (enable/disable) | Yes | string |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/annotation-reply/{action}/status/{job_id}

#### GET
##### Description

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 |

### /apps/{app_id}/annotation-setting

#### GET
##### Description

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 |

### /apps/{app_id}/annotation-settings/{annotation_setting_id}

#### POST
##### Description

Update annotation settings for an app

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AnnotationSettingUpdatePayload](#annotationsettingupdatepayload) |
| annotation_setting_id | path | Annotation setting ID | Yes | string |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/annotations

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Description

Get annotations for an app with pagination

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AnnotationListQuery](#annotationlistquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

#### POST
##### Description

Create a new annotation for an app

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [CreateAnnotationPayload](#createannotationpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Annotation created successfully | [Annotation](#annotation) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/annotations/batch-import

#### POST
##### Description

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 |

### /apps/{app_id}/annotations/batch-import-status/{job_id}

#### GET
##### Description

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 |

### /apps/{app_id}/annotations/count

#### GET
##### Description

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 | [AnnotationCountResponse](#annotationcountresponse) |

### /apps/{app_id}/annotations/export

#### GET
##### Description

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 | [AnnotationExportList](#annotationexportlist) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/annotations/{annotation_id}

#### DELETE
##### Parameters

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

##### Responses

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

#### POST
##### Description

Update or delete an annotation

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [UpdateAnnotationPayload](#updateannotationpayload) |
| annotation_id | path | Annotation ID | Yes | string |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Annotation updated successfully | [Annotation](#annotation) |
| 204 | Annotation deleted successfully |  |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/annotations/{annotation_id}/hit-histories

#### GET
##### Description

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 |
| page | query | Page number | No | integer |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Hit histories retrieved successfully | [AnnotationHitHistoryList](#annotationhithistorylist) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/api-enable

#### POST
##### Description

Enable or disable app API

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppApiStatusPayload](#appapistatuspayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API status updated successfully | [AppDetail](#appdetail) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/audio-to-text

#### POST
##### Description

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 | [AudioTranscriptResponse](#audiotranscriptresponse) |
| 400 | Bad request - No audio uploaded or unsupported type |  |
| 413 | Audio file too large |  |

### /apps/{app_id}/chat-conversations

#### GET
##### Description

Get chat conversations with pagination, filtering and summary

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChatConversationQuery](#chatconversationquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ConversationWithSummaryPagination](#conversationwithsummarypagination) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/chat-conversations/{conversation_id}

#### DELETE
##### Description

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
##### Description

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 | [ConversationDetail](#conversationdetail) |
| 403 | Insufficient permissions |  |
| 404 | Conversation not found |  |

### /apps/{app_id}/chat-messages

#### GET
##### Description

Get chat messages for a conversation with pagination

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChatMessagesQuery](#chatmessagesquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [MessageInfiniteScrollPaginationResponse](#messageinfinitescrollpaginationresponse) |
| 404 | Conversation not found |  |

### /apps/{app_id}/chat-messages/{message_id}/suggested-questions

#### GET
##### Description

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 | [SuggestedQuestionsResponse](#suggestedquestionsresponse) |
| 404 | Message or conversation not found |  |

### /apps/{app_id}/chat-messages/{task_id}/stop

#### POST
##### Description

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 | [SimpleResultResponse](#simpleresultresponse) |

### /apps/{app_id}/completion-conversations

#### GET
##### Description

Get completion conversations with pagination and filtering

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [CompletionConversationQuery](#completionconversationquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ConversationPagination](#conversationpagination) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/completion-conversations/{conversation_id}

#### DELETE
##### Description

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
##### Description

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 | [ConversationMessageDetail](#conversationmessagedetail) |
| 403 | Insufficient permissions |  |
| 404 | Conversation not found |  |

### /apps/{app_id}/completion-messages

#### POST
##### Description

Generate completion message for debugging

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [CompletionMessagePayload](#completionmessagepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/completion-messages/{task_id}/stop

#### POST
##### Description

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 | [SimpleResultResponse](#simpleresultresponse) |

### /apps/{app_id}/conversation-variables

#### GET
##### Description

Get conversation variables for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ConversationVariablesQuery](#conversationvariablesquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Conversation variables retrieved successfully | [PaginatedConversationVariableResponse](#paginatedconversationvariableresponse) |

### /apps/{app_id}/convert-to-workflow

#### POST
##### Summary

Convert basic mode of chatbot app to workflow mode

##### Description

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 |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ConvertToWorkflowPayload](#converttoworkflowpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Application converted to workflow successfully | [NewAppResponse](#newappresponse) |
| 400 | Application cannot be converted |  |
| 403 | Permission denied |  |

### /apps/{app_id}/copy

#### POST
##### Summary

Copy app

##### Description

Create a copy of an existing application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [CopyAppPayload](#copyapppayload) |
| app_id | path | Application ID to copy | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | App copied successfully | [AppDetailWithSite](#appdetailwithsite) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/export

#### GET
##### Summary

Export app

##### Description

Export application configuration as DSL

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppExportQuery](#appexportquery) |
| app_id | path | Application ID to export | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | App exported successfully | [AppExportResponse](#appexportresponse) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/feedbacks

#### POST
##### Description

Create or update message feedback (like/dislike)

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MessageFeedbackPayload](#messagefeedbackpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Feedback updated successfully | [SimpleResultResponse](#simpleresultresponse) |
| 403 | Insufficient permissions |  |
| 404 | Message not found |  |

### /apps/{app_id}/feedbacks/export

#### GET
##### Description

Export user feedback data for Google Sheets

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [FeedbackExportQuery](#feedbackexportquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/icon

#### POST
##### Description

Update application icon

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppIconPayload](#appiconpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/messages/{message_id}

#### GET
##### Description

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 | [MessageDetailResponse](#messagedetailresponse) |
| 404 | Message not found |  |

### /apps/{app_id}/model-config

#### POST
##### Summary

Modify app model config

##### Description

Update application model configuration

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ModelConfigRequest](#modelconfigrequest) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/name

#### POST
##### Description

Check if app name is available

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppNamePayload](#appnamepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Name availability checked | [AppDetail](#appdetail) |

### /apps/{app_id}/publish-to-creators-platform

#### POST
##### Summary

Publish app to Creators Platform

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [RedirectUrlResponse](#redirecturlresponse) |

### /apps/{app_id}/server

#### GET
##### Description

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 | [AppMCPServerResponse](#appmcpserverresponse) |

#### POST
##### Description

Create MCP server configuration for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MCPServerCreatePayload](#mcpservercreatepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | MCP server configuration created successfully | [AppMCPServerResponse](#appmcpserverresponse) |
| 403 | Insufficient permissions |  |

#### PUT
##### Description

Update MCP server configuration for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MCPServerUpdatePayload](#mcpserverupdatepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | MCP server configuration updated successfully | [AppMCPServerResponse](#appmcpserverresponse) |
| 403 | Insufficient permissions |  |
| 404 | Server not found |  |

### /apps/{app_id}/site

#### POST
##### Description

Update application site configuration

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppSiteUpdatePayload](#appsiteupdatepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Site configuration updated successfully | [AppSiteResponse](#appsiteresponse) |
| 403 | Insufficient permissions |  |
| 404 | App not found |  |

### /apps/{app_id}/site-enable

#### POST
##### Description

Enable or disable app site

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppSiteStatusPayload](#appsitestatuspayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Site status updated successfully | [AppDetail](#appdetail) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/site/access-token-reset

#### POST
##### Description

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 | [AppSiteResponse](#appsiteresponse) |
| 403 | Insufficient permissions (admin/owner required) |  |
| 404 | App or site not found |  |

### /apps/{app_id}/statistics/average-response-time

#### GET
##### Description

Get average response time statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Average response time statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/average-session-interactions

#### GET
##### Description

Get average session interaction statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Average session interaction statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/daily-conversations

#### GET
##### Description

Get daily conversation statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily conversation statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/daily-end-users

#### GET
##### Description

Get daily terminal/end-user statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily terminal statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/daily-messages

#### GET
##### Description

Get daily message statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily message statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/token-costs

#### GET
##### Description

Get daily token cost statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Daily token cost statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/tokens-per-second

#### GET
##### Description

Get tokens per second statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tokens per second statistics retrieved successfully | [ object ] |

### /apps/{app_id}/statistics/user-satisfaction-rate

#### GET
##### Description

Get user satisfaction rate statistics for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [StatisticTimeRangeQuery](#statistictimerangequery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | User satisfaction rate statistics retrieved successfully | [ object ] |

### /apps/{app_id}/text-to-audio

#### POST
##### Description

Convert text to speech for chat messages

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TextToSpeechPayload](#texttospeechpayload) |
| app_id | path | App ID | Yes | string |

##### Responses

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

### /apps/{app_id}/text-to-audio/voices

#### GET
##### Description

Get available TTS voices for a specific language

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TextToSpeechVoiceQuery](#texttospeechvoicequery) |
| app_id | path | App ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | TTS voices retrieved successfully | [ object ] |
| 400 | Invalid language parameter |  |

### /apps/{app_id}/trace

#### GET
##### Summary

Get app trace

##### Description

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
##### Description

Update app tracing configuration

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [AppTracePayload](#apptracepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Trace configuration updated successfully | [SimpleResultResponse](#simpleresultresponse) |
| 403 | Insufficient permissions |  |

### /apps/{app_id}/trace-config

#### DELETE
##### Summary

Delete an existing trace app configuration

##### Description

Delete an existing tracing configuration for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TraceProviderQuery](#traceproviderquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

#### GET
##### Description

Get tracing configuration for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TraceProviderQuery](#traceproviderquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tracing configuration retrieved successfully | object |
| 400 | Invalid request parameters |  |

#### PATCH
##### Summary

Update an existing trace app configuration

##### Description

Update an existing tracing configuration for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TraceConfigPayload](#traceconfigpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tracing configuration updated successfully | object |
| 400 | Invalid request parameters or configuration not found |  |

#### POST
##### Summary

Create a new trace app configuration

##### Description

Create a new tracing configuration for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TraceConfigPayload](#traceconfigpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Tracing configuration created successfully | object |
| 400 | Invalid request parameters or configuration already exists |  |

### /apps/{app_id}/trigger-enable

#### POST
##### Summary

Update app trigger (enable/disable)

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [ParserEnable](#parserenable) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [WorkflowTriggerResponse](#workflowtriggerresponse) |

### /apps/{app_id}/triggers

#### GET
##### Summary

Get app triggers list

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [WorkflowTriggerListResponse](#workflowtriggerlistresponse) |

### /apps/{app_id}/workflow-app-logs

#### GET
##### Summary

Get workflow app logs

##### Description

Get workflow application execution logs

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowAppLogQuery](#workflowapplogquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow app logs retrieved successfully | [WorkflowAppLogPaginationResponse](#workflowapplogpaginationresponse) |

### /apps/{app_id}/workflow-archived-logs

#### GET
##### Summary

Get workflow archived logs

##### Description

Get workflow archived execution logs

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowAppLogQuery](#workflowapplogquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow archived logs retrieved successfully | [WorkflowArchivedLogPaginationResponse](#workflowarchivedlogpaginationresponse) |

### /apps/{app_id}/workflow-runs

#### GET
##### Summary

Get workflow run list

##### Description

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 |
| status | query | Workflow run status filter | No | string |
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs retrieved successfully | [WorkflowRunPaginationResponse](#workflowrunpaginationresponse) |

### /apps/{app_id}/workflow-runs/count

#### GET
##### Summary

Get workflow runs count statistics

##### Description

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 |
| 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 |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow runs count retrieved successfully | [WorkflowRunCountResponse](#workflowruncountresponse) |

### /apps/{app_id}/workflow-runs/tasks/{task_id}/stop

#### POST
##### Summary

Stop workflow task

##### Description

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 | [SimpleResultResponse](#simpleresultresponse) |
| 403 | Permission denied |  |
| 404 | Task not found |  |

### /apps/{app_id}/workflow-runs/{run_id}

#### GET
##### Summary

Get workflow run detail

##### Description

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 | [WorkflowRunDetailResponse](#workflowrundetailresponse) |
| 404 | Workflow run not found |  |

### /apps/{app_id}/workflow-runs/{run_id}/export

#### GET
##### Description

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 | [WorkflowRunExportResponse](#workflowrunexportresponse) |

### /apps/{app_id}/workflow-runs/{run_id}/node-executions

#### GET
##### Summary

Get workflow run node execution list

##### Description

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 | [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse) |
| 404 | Workflow run not found |  |

### /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/workspace/files

#### GET
##### Description

List a directory in a Workflow Agent node's sandbox workspace (read-only)

##### 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 |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Listing returned | [WorkspaceListResponse](#workspacelistresponse) |

### /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/workspace/files/download

#### GET
##### Description

Download a file from a Workflow Agent node's sandbox workspace (read-only)

##### 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 | File bytes | binary |
| 413 | File exceeds the workspace download limit |  |

### /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/workspace/files/preview

#### GET
##### Description

Preview a text/binary file in a Workflow Agent node's sandbox workspace

##### 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 | [WorkspacePreviewResponse](#workspacepreviewresponse) |

### /apps/{app_id}/workflow/comments

#### GET
##### Summary

Get all comments for a workflow

##### Description

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 | [WorkflowCommentBasicList](#workflowcommentbasiclist) |

#### POST
##### Summary

Create a new workflow comment

##### Description

Create a new workflow comment

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowCommentCreatePayload](#workflowcommentcreatepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Comment created successfully | [WorkflowCommentCreate](#workflowcommentcreate) |

### /apps/{app_id}/workflow/comments/mention-users

#### GET
##### Summary

Get all users in current tenant for mentions

##### Description

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 | [WorkflowCommentMentionUsersPayload](#workflowcommentmentionuserspayload) |

### /apps/{app_id}/workflow/comments/{comment_id}

#### DELETE
##### Summary

Delete a workflow comment

##### Description

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
##### Summary

Get a specific workflow comment

##### Description

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 | [WorkflowCommentDetail](#workflowcommentdetail) |

#### PUT
##### Summary

Update a workflow comment

##### Description

Update a workflow comment

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowCommentUpdatePayload](#workflowcommentupdatepayload) |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Comment updated successfully | [WorkflowCommentUpdate](#workflowcommentupdate) |

### /apps/{app_id}/workflow/comments/{comment_id}/replies

#### POST
##### Summary

Add a reply to a workflow comment

##### Description

Add a reply to a workflow comment

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowCommentReplyPayload](#workflowcommentreplypayload) |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Reply created successfully | [WorkflowCommentReplyCreate](#workflowcommentreplycreate) |

### /apps/{app_id}/workflow/comments/{comment_id}/replies/{reply_id}

#### DELETE
##### Summary

Delete a comment reply

##### Description

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
##### Summary

Update a comment reply

##### Description

Update a comment reply

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowCommentReplyPayload](#workflowcommentreplypayload) |
| app_id | path | Application ID | Yes | string |
| comment_id | path | Comment ID | Yes | string |
| reply_id | path | Reply ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Reply updated successfully | [WorkflowCommentReplyUpdate](#workflowcommentreplyupdate) |

### /apps/{app_id}/workflow/comments/{comment_id}/resolve

#### POST
##### Summary

Resolve a workflow comment

##### Description

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 | [WorkflowCommentResolve](#workflowcommentresolve) |

### /apps/{app_id}/workflow/statistics/average-app-interactions

#### GET
##### Description

Get workflow average app interaction statistics

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowStatisticQuery](#workflowstatisticquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflow/statistics/daily-conversations

#### GET
##### Description

Get workflow daily runs statistics

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowStatisticQuery](#workflowstatisticquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflow/statistics/daily-terminals

#### GET
##### Description

Get workflow daily terminals statistics

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowStatisticQuery](#workflowstatisticquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflow/statistics/token-costs

#### GET
##### Description

Get workflow daily token cost statistics

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowStatisticQuery](#workflowstatisticquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows

#### GET
##### Summary

Get published workflows

##### Description

Get all published workflows for an application

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowListQuery](#workflowlistquery) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | [WorkflowPaginationResponse](#workflowpaginationresponse) |

### /apps/{app_id}/workflows/default-workflow-block-configs

#### GET
##### Summary

Get default block config

##### Description

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 |

### /apps/{app_id}/workflows/default-workflow-block-configs/{block_type}

#### GET
##### Summary

Get default block config

##### Description

Get default block configuration by type

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DefaultBlockConfigQuery](#defaultblockconfigquery) |
| app_id | path | Application ID | Yes | string |
| block_type | path | Block type | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft

#### GET
##### Summary

Get draft workflow

##### Description

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 | [WorkflowResponse](#workflowresponse) |
| 404 | Draft workflow not found |  |

#### POST
##### Summary

Sync draft workflow

##### Description

Sync draft workflow configuration

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [SyncDraftWorkflowPayload](#syncdraftworkflowpayload) |
| app_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Draft workflow synced successfully | [SyncDraftWorkflowResponse](#syncdraftworkflowresponse) |
| 400 | Invalid workflow configuration |  |
| 403 | Permission denied |  |

### /apps/{app_id}/workflows/draft/conversation-variables

#### GET
##### Description

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 | [WorkflowDraftVariableList](#workflowdraftvariablelist) |
| 404 | Draft workflow not found |  |

#### POST
##### Description

Update conversation variables for workflow draft

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ConversationVariableUpdatePayload](#conversationvariableupdatepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/environment-variables

#### GET
##### Summary

Get draft workflow

##### Description

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
##### Description

Update environment variables for workflow draft

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EnvironmentVariableUpdatePayload](#environmentvariableupdatepayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/features

#### POST
##### Description

Update draft workflow features

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowFeaturesPayload](#workflowfeaturespayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow features updated successfully | [SimpleResultResponse](#simpleresultresponse) |

### /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/delivery-test

#### POST
##### Summary

Test human input delivery

##### Description

Test human input delivery for workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [HumanInputDeliveryTestPayload](#humaninputdeliverytestpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/preview

#### POST
##### Summary

Preview human input form content and placeholders

##### Description

Get human input form preview for workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [HumanInputFormPreviewPayload](#humaninputformpreviewpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/run

#### POST
##### Summary

Submit human input form preview

##### Description

Submit human input form preview for workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [HumanInputFormSubmitPayload](#humaninputformsubmitpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/iteration/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow iteration node

##### Description

Run draft workflow iteration node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [IterationNodeRunPayload](#iterationnoderunpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/loop/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow loop node

##### Description

Run draft workflow loop node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [LoopNodeRunPayload](#loopnoderunpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer

#### GET
##### 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 | [WorkflowAgentComposerResponse](#workflowagentcomposerresponse) |

#### PUT
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |
| payload | body |  | Yes | [ComposerSavePayload](#composersavepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer saved | [WorkflowAgentComposerResponse](#workflowagentcomposerresponse) |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/candidates

#### GET
##### 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 | [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse) |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/impact

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |
| payload | body |  | Yes | [ComposerSavePayload](#composersavepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer impact | [AgentComposerImpactResponse](#agentcomposerimpactresponse) |

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |
| payload | body |  | Yes | [ComposerSavePayload](#composersavepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer saved to roster | [WorkflowAgentComposerResponse](#workflowagentcomposerresponse) |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/validate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| node_id | path |  | Yes | string |
| payload | body |  | Yes | [ComposerSavePayload](#composersavepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow agent composer validation result | [AgentComposerValidateResponse](#agentcomposervalidateresponse) |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/last-run

#### GET
##### Description

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 | [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) |
| 403 | Permission denied |  |
| 404 | Node last run not found |  |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow node

##### Description

Run draft workflow node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DraftWorkflowNodeRunPayload](#draftworkflownoderunpayload) |
| app_id | path | Application ID | Yes | string |
| node_id | path | Node ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node run started successfully | [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) |
| 403 | Permission denied |  |
| 404 | Node not found |  |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/trigger/run

#### POST
##### Summary

Poll for trigger events and execute single node when event arrives

##### Description

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 |

### /apps/{app_id}/workflows/draft/nodes/{node_id}/variables

#### DELETE
##### Description

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
##### Description

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 | [WorkflowDraftVariableList](#workflowdraftvariablelist) |

### /apps/{app_id}/workflows/draft/run

#### POST
##### Summary

Run draft workflow

##### Description

Run draft workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DraftWorkflowRunPayload](#draftworkflowrunpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run not found |

### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/events

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run not found |

### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run / node not found |

### /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run / node / output not found |

### /apps/{app_id}/workflows/draft/system-variables

#### GET
##### Description

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 | [WorkflowDraftVariableList](#workflowdraftvariablelist) |

### /apps/{app_id}/workflows/draft/trigger/run

#### POST
##### Summary

Poll for trigger events and execute full workflow when event arrives

##### Description

Poll for trigger events and execute full workflow when event arrives

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DraftWorkflowTriggerRunRequest](#draftworkflowtriggerrunrequest) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/trigger/run-all

#### POST
##### Summary

Full workflow debug when the start node is a trigger

##### Description

Full workflow debug when the start node is a trigger

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DraftWorkflowTriggerRunAllPayload](#draftworkflowtriggerrunallpayload) |
| app_id | path | Application ID | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/draft/variables

#### DELETE
##### Description

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
##### Summary

Get draft workflow

##### Description

Get draft workflow variables

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowDraftVariableListQuery](#workflowdraftvariablelistquery) |
| app_id | path | Application ID | Yes | string |
| limit | query | Number of items per page (1-100) | No | string |
| page | query | Page number (1-100000) | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow variables retrieved successfully | [WorkflowDraftVariableListWithoutValue](#workflowdraftvariablelistwithoutvalue) |

### /apps/{app_id}/workflows/draft/variables/{variable_id}

#### DELETE
##### Description

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
##### Description

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 | [WorkflowDraftVariable](#workflowdraftvariable) |
| 404 | Variable not found |  |

#### PATCH
##### Description

Update a workflow variable

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowDraftVariableUpdatePayload](#workflowdraftvariableupdatepayload) |
| app_id | path |  | Yes | string |
| variable_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable updated successfully | [WorkflowDraftVariable](#workflowdraftvariable) |
| 404 | Variable not found |  |

### /apps/{app_id}/workflows/draft/variables/{variable_id}/reset

#### PUT
##### Description

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 | [WorkflowDraftVariable](#workflowdraftvariable) |
| 204 | Variable reset (no content) |  |
| 404 | Variable not found |  |

### /apps/{app_id}/workflows/publish

#### GET
##### Summary

Get published workflow

##### Description

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 | [WorkflowResponse](#workflowresponse) |

#### POST
##### Summary

Publish workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [PublishWorkflowPayload](#publishworkflowpayload) |
| app_id | path |  | Yes | string |

##### Responses

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

### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run not found |

### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/events

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run not found |

### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run / node not found |

### /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview

#### GET
##### Description

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 |
| ---- | ----------- |
| 404 | Workflow run / node / output not found |

### /apps/{app_id}/workflows/triggers/webhook

#### GET
##### Summary

Get webhook trigger for a node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [Parser](#parser) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [WebhookTriggerResponse](#webhooktriggerresponse) |

### /apps/{app_id}/workflows/{workflow_id}

#### DELETE
##### Summary

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
##### Summary

Update workflow attributes

##### Description

Update workflow by ID

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowUpdatePayload](#workflowupdatepayload) |
| app_id | path | Application ID | Yes | string |
| workflow_id | path | Workflow ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Workflow updated successfully | [WorkflowResponse](#workflowresponse) |
| 403 | Permission denied |  |
| 404 | Workflow not found |  |

### /apps/{app_id}/workflows/{workflow_id}/restore

#### POST
##### Description

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 |

### /apps/{resource_id}/api-keys

#### GET
##### Summary

Get all API keys for an app

##### Description

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 | [ApiKeyList](#apikeylist) |

#### POST
##### Summary

Create a new API key for an app

##### Description

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 | [ApiKeyItem](#apikeyitem) |
| 400 | Maximum keys exceeded |  |

### /apps/{resource_id}/api-keys/{api_key_id}

#### DELETE
##### Summary

Delete an API key for an app

##### Description

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 |

### /apps/{server_id}/server/refresh

#### GET
##### Description

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 | [AppMCPServerResponse](#appmcpserverresponse) |
| 403 | Insufficient permissions |  |
| 404 | Server not found |  |

### /auth/plugin/datasource/default-list

#### GET
##### Responses

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

### /auth/plugin/datasource/list

#### GET
##### Responses

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

### /auth/plugin/datasource/{provider_id}

#### GET
##### Parameters

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

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceCredentialPayload](#datasourcecredentialpayload) |

##### Responses

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

### /auth/plugin/datasource/{provider_id}/custom-client

#### DELETE
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceCustomClientPayload](#datasourcecustomclientpayload) |

##### Responses

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

### /auth/plugin/datasource/{provider_id}/default

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceDefaultPayload](#datasourcedefaultpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /auth/plugin/datasource/{provider_id}/delete

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceCredentialDeletePayload](#datasourcecredentialdeletepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /auth/plugin/datasource/{provider_id}/update

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceCredentialUpdatePayload](#datasourcecredentialupdatepayload) |

##### Responses

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

### /auth/plugin/datasource/{provider_id}/update-name

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceUpdateNamePayload](#datasourceupdatenamepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /billing/invoices

#### GET
##### Responses

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

### /billing/partners/{partner_key}/tenants

#### PUT
##### Description

Sync partner tenants bindings

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [PartnerTenantsPayload](#partnertenantspayload) |
| partner_key | path | Partner key | Yes | string |

##### Responses

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

### /billing/subscription

#### GET
##### Responses

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

### /code-based-extension

#### GET
##### Description

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 | [CodeBasedExtensionResponse](#codebasedextensionresponse) |

### /compliance/download

#### GET
##### Description

Get compliance document download link

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ComplianceDownloadQuery](#compliancedownloadquery) |

##### Responses

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

### /data-source/integrates

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [DataSourceIntegrateListResponse](#datasourceintegratelistresponse) |

#### PATCH
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /data-source/integrates/{binding_id}/{action}

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [DataSourceIntegrateListResponse](#datasourceintegratelistresponse) |

#### PATCH
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /datasets

#### GET
##### Description

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 |
| page | query | Page number | No | integer |
| tag_ids | query | Filter by tag IDs | No | [ string ] |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Datasets retrieved successfully | [DatasetListResponse](#datasetlistresponse) |

#### POST
##### Description

Create a new dataset

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DatasetCreatePayload](#datasetcreatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Dataset created successfully | [DatasetDetailResponse](#datasetdetailresponse) |
| 400 | Invalid request parameters |  |

### /datasets/api-base-info

#### GET
##### Description

Get dataset API base information

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API base info retrieved successfully | [ApiBaseUrlResponse](#apibaseurlresponse) |

### /datasets/api-keys

#### GET
##### Description

Get dataset API keys

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API keys retrieved successfully | [ApiKeyList](#apikeylist) |

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | API key created successfully | [ApiKeyItem](#apikeyitem) |
| 400 | Maximum keys exceeded |  |

### /datasets/api-keys/{api_key_id}

#### DELETE
##### Description

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 |

### /datasets/batch_import_status/{job_id}

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import status | [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| job_id | path |  | Yes | string |
| payload | body |  | Yes | [BatchImportPayload](#batchimportpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import started | [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse) |

### /datasets/external

#### POST
##### Description

Create external knowledge dataset

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ExternalDatasetCreatePayload](#externaldatasetcreatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | External dataset created successfully | [DatasetDetail](#datasetdetail) |
| 400 | Invalid parameters |  |
| 403 | Permission denied |  |

### /datasets/external-knowledge-api

#### GET
##### Description

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
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ExternalKnowledgeApiPayload](#externalknowledgeapipayload) |

##### Responses

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

### /datasets/external-knowledge-api/{external_knowledge_api_id}

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Description

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
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ExternalKnowledgeApiPayload](#externalknowledgeapipayload) |
| external_knowledge_api_id | path |  | Yes | string |

##### Responses

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

### /datasets/external-knowledge-api/{external_knowledge_api_id}/use-check

#### GET
##### Description

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 | [UsageCountResponse](#usagecountresponse) |

### /datasets/indexing-estimate

#### POST
##### Description

Estimate dataset indexing cost

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [IndexingEstimatePayload](#indexingestimatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Indexing estimate calculated successfully | [IndexingEstimateResponse](#indexingestimateresponse) |

### /datasets/init

#### POST
##### Description

Initialize dataset with documents

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [KnowledgeConfig](#knowledgeconfig) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Dataset initialized successfully | [DatasetAndDocumentResponse](#datasetanddocumentresponse) |
| 400 | Invalid request parameters |  |

### /datasets/metadata/built-in

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Built-in fields retrieved successfully | [DatasetMetadataBuiltInFieldsResponse](#datasetmetadatabuiltinfieldsresponse) |

### /datasets/notion-indexing-estimate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [NotionEstimatePayload](#notionestimatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [IndexingEstimate](#indexingestimate) |

### /datasets/process-rule

#### GET
##### Description

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 |

### /datasets/retrieval-setting

#### GET
##### Description

Get dataset retrieval settings

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Retrieval settings retrieved successfully | [RetrievalSettingResponse](#retrievalsettingresponse) |

### /datasets/retrieval-setting/{vector_type}

#### GET
##### Description

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 | [RetrievalSettingResponse](#retrievalsettingresponse) |

### /datasets/{dataset_id}

#### DELETE
##### Parameters

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

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Dataset deleted successfully |

#### GET
##### Description

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 | [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse) |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

#### PATCH
##### Description

Update dataset details

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DatasetUpdatePayload](#datasetupdatepayload) |
| dataset_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dataset updated successfully | [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse) |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### /datasets/{dataset_id}/api-keys/{status}

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| status | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /datasets/{dataset_id}/auto-disable-logs

#### GET
##### Description

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 | [AutoDisableLogsResponse](#autodisablelogsresponse) |
| 404 | Dataset not found |  |

### /datasets/{dataset_id}/batch/{batch}/indexing-estimate

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| batch | path |  | Yes | string |
| dataset_id | path |  | Yes | string |

##### Responses

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

### /datasets/{dataset_id}/batch/{batch}/indexing-status

#### GET
##### 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 | [DocumentStatusListResponse](#documentstatuslistresponse) |

### /datasets/{dataset_id}/documents

#### DELETE
##### Parameters

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

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Documents deleted successfully |

#### GET
##### Description

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 | [DocumentWithSegmentsListResponse](#documentwithsegmentslistresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [KnowledgeConfig](#knowledgeconfig) |
| dataset_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Documents created successfully | [DatasetAndDocumentResponse](#datasetanddocumentresponse) |

### /datasets/{dataset_id}/documents/download-zip

#### POST
##### Summary

Stream a ZIP archive containing the requested uploaded documents

##### Description

Download selected dataset documents as a single ZIP archive (upload-file only)

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| payload | body |  | Yes | [DocumentBatchDownloadZipPayload](#documentbatchdownloadzippayload) |

##### Responses

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

### /datasets/{dataset_id}/documents/generate-summary

#### POST
##### Summary

Generate summary index for specified documents

##### Description

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 |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [GenerateSummaryPayload](#generatesummarypayload) |
| dataset_id | path | Dataset ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Summary generation started successfully | [SimpleResultResponse](#simpleresultresponse) |
| 400 | Invalid request or dataset configuration |  |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### /datasets/{dataset_id}/documents/metadata

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| payload | body |  | Yes | [MetadataOperationData](#metadataoperationdata) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Documents metadata updated successfully |

### /datasets/{dataset_id}/documents/status/{action}/batch

#### PATCH
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /datasets/{dataset_id}/documents/{document_id}

#### DELETE
##### 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
##### Description

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 |

### /datasets/{dataset_id}/documents/{document_id}/download

#### GET
##### Description

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 | [UrlResponse](#urlresponse) |

### /datasets/{dataset_id}/documents/{document_id}/indexing-estimate

#### GET
##### Description

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 |

### /datasets/{dataset_id}/documents/{document_id}/indexing-status

#### GET
##### Description

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 | [DocumentStatusResponse](#documentstatusresponse) |
| 404 | Document not found |  |

### /datasets/{dataset_id}/documents/{document_id}/metadata

#### PUT
##### Description

Update document metadata

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [DocumentMetadataUpdatePayload](#documentmetadataupdatepayload) |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document metadata updated successfully | [SimpleResultMessageResponse](#simpleresultmessageresponse) |
| 403 | Permission denied |  |
| 404 | Document not found |  |

### /datasets/{dataset_id}/documents/{document_id}/notion/sync

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /datasets/{dataset_id}/documents/{document_id}/pipeline-execution-log

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |

##### Responses

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

### /datasets/{dataset_id}/documents/{document_id}/processing/pause

#### PATCH
##### Summary

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 |

### /datasets/{dataset_id}/documents/{document_id}/processing/resume

#### PATCH
##### Summary

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 |

### /datasets/{dataset_id}/documents/{document_id}/processing/{action}

#### PATCH
##### Description

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 | [SimpleResultResponse](#simpleresultresponse) |
| 400 | Invalid action |  |
| 404 | Document not found |  |

### /datasets/{dataset_id}/documents/{document_id}/rename

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |
| payload | body |  | Yes | [DocumentRenamePayload](#documentrenamepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document renamed successfully | [DocumentResponse](#documentresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segment

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [SegmentCreatePayload](#segmentcreatepayload) |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Segment created successfully | [SegmentDetailResponse](#segmentdetailresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segment/{action}

#### PATCH
##### 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 | [SimpleResultResponse](#simpleresultresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segments

#### DELETE
##### 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
##### 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 |
| hit_count_gte | query |  | No | integer |
| keyword | query |  | No | string |
| limit | query |  | No | integer |
| page | query |  | No | integer |
| status | query |  | No | [ string ] |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Segments retrieved successfully | [ConsoleSegmentListResponse](#consolesegmentlistresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segments/batch_import

#### GET
##### 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 | [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| document_id | path |  | Yes | string |
| payload | body |  | Yes | [BatchImportPayload](#batchimportpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Batch import started | [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}

#### DELETE
##### 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
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [SegmentUpdatePayload](#segmentupdatepayload) |
| dataset_id | path | Dataset ID | Yes | string |
| document_id | path | Document ID | Yes | string |
| segment_id | path | Segment ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Segment updated successfully | [SegmentDetailResponse](#segmentdetailresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks

#### GET
##### 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 |
| page | query |  | No | integer |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunks retrieved successfully | [ChildChunkListResponse](#childchunklistresponse) |

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChildChunkBatchUpdatePayload](#childchunkbatchupdatepayload) |
| 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 | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunks updated successfully | [ChildChunkBatchUpdateResponse](#childchunkbatchupdateresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChildChunkCreatePayload](#childchunkcreatepayload) |
| 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 | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunk created successfully | [ChildChunkDetailResponse](#childchunkdetailresponse) |

### /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}

#### DELETE
##### 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
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ChildChunkUpdatePayload](#childchunkupdatepayload) |
| 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 | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunk updated successfully | [ChildChunkDetailResponse](#childchunkdetailresponse) |

### /datasets/{dataset_id}/documents/{document_id}/summary-status

#### GET
##### Summary

Get summary index generation status for a document

##### Description

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 |

### /datasets/{dataset_id}/documents/{document_id}/website-sync

#### GET
##### Summary

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 | [SimpleResultResponse](#simpleresultresponse) |

### /datasets/{dataset_id}/error-docs

#### GET
##### Description

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 | [ErrorDocsResponse](#errordocsresponse) |
| 404 | Dataset not found |  |

### /datasets/{dataset_id}/external-hit-testing

#### POST
##### Description

Test external knowledge retrieval for dataset

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ExternalHitTestingPayload](#externalhittestingpayload) |
| dataset_id | path | Dataset ID | Yes | string |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | External hit testing completed successfully |
| 400 | Invalid parameters |
| 404 | Dataset not found |

### /datasets/{dataset_id}/hit-testing

#### POST
##### Description

Test dataset knowledge retrieval

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [HitTestingPayload](#hittestingpayload) |
| dataset_id | path | Dataset ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Hit testing completed successfully | [HitTestingResponse](#hittestingresponse) |
| 400 | Invalid parameters |  |
| 404 | Dataset not found |  |

### /datasets/{dataset_id}/indexing-status

#### GET
##### Description

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 | [DocumentStatusListResponse](#documentstatuslistresponse) |

### /datasets/{dataset_id}/metadata

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Metadata retrieved successfully | [DatasetMetadataListResponse](#datasetmetadatalistresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| payload | body |  | Yes | [MetadataArgs](#metadataargs) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Metadata created successfully | [DatasetMetadataResponse](#datasetmetadataresponse) |

### /datasets/{dataset_id}/metadata/built-in/{action}

#### POST
##### Parameters

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

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Action completed successfully |

### /datasets/{dataset_id}/metadata/{metadata_id}

#### DELETE
##### 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
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| metadata_id | path |  | Yes | string |
| payload | body |  | Yes | [MetadataUpdatePayload](#metadataupdatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Metadata updated successfully | [DatasetMetadataResponse](#datasetmetadataresponse) |

### /datasets/{dataset_id}/notion/sync

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /datasets/{dataset_id}/permission-part-users

#### GET
##### Description

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 | [PartialMemberListResponse](#partialmemberlistresponse) |
| 403 | Permission denied |  |
| 404 | Dataset not found |  |

### /datasets/{dataset_id}/queries

#### GET
##### Description

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 | [DatasetQueryListResponse](#datasetquerylistresponse) |

### /datasets/{dataset_id}/related-apps

#### GET
##### Description

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 | [RelatedAppListResponse](#relatedapplistresponse) |

### /datasets/{dataset_id}/retry

#### POST
##### Summary

retry document

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path |  | Yes | string |
| payload | body |  | Yes | [DocumentRetryPayload](#documentretrypayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Documents retry started successfully |

### /datasets/{dataset_id}/use-check

#### GET
##### Description

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 | [UsageCheckResponse](#usagecheckresponse) |

### /datasets/{resource_id}/api-keys

#### GET
##### Summary

Get all API keys for a dataset

##### Description

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 | [ApiKeyList](#apikeylist) |

#### POST
##### Summary

Create a new API key for a dataset

##### Description

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 | [ApiKeyItem](#apikeyitem) |
| 400 | Maximum keys exceeded |  |

### /datasets/{resource_id}/api-keys/{api_key_id}

#### DELETE
##### Summary

Delete an API key for a dataset

##### Description

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 |

### /email-code-login

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EmailPayload](#emailpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultDataResponse](#simpleresultdataresponse) |

### /email-code-login/validity

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EmailCodeLoginPayload](#emailcodeloginpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /email-register

#### POST
##### Responses

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

### /email-register/send-email

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultDataResponse](#simpleresultdataresponse) |

### /email-register/validity

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [VerificationTokenResponse](#verificationtokenresponse) |

### /explore/apps

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| language | query | Language code for recommended app localization | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [RecommendedAppListResponse](#recommendedapplistresponse) |

### /explore/apps/{app_id}

#### GET
##### Parameters

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

##### Responses

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

### /features

#### GET
##### Summary

Get feature configuration for current tenant

##### Description

Get feature configuration for current tenant

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [FeatureModel](#featuremodel) |

### /features/vector-space

#### GET
##### Summary

Get vector-space usage and limit for current tenant

##### Description

Get vector-space usage and limit for current tenant

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [LimitationModel](#limitationmodel) |

### /files/support-type

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AllowedExtensionsResponse](#allowedextensionsresponse) |

### /files/upload

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [UploadConfig](#uploadconfig) |

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | File uploaded successfully | [FileResponse](#fileresponse) |

### /files/{file_id}/preview

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TextContentResponse](#textcontentresponse) |

### /forgot-password

#### POST
##### Description

Send password reset email

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ForgotPasswordSendPayload](#forgotpasswordsendpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Email sent successfully | [ForgotPasswordEmailResponse](#forgotpasswordemailresponse) |
| 400 | Invalid email or rate limit exceeded |  |

### /forgot-password/resets

#### POST
##### Description

Reset password with verification token

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ForgotPasswordResetPayload](#forgotpasswordresetpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Password reset successfully | [ForgotPasswordResetResponse](#forgotpasswordresetresponse) |
| 400 | Invalid token or password mismatch |  |

### /forgot-password/validity

#### POST
##### Description

Verify password reset code

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ForgotPasswordCheckPayload](#forgotpasswordcheckpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Code verified successfully | [ForgotPasswordCheckResponse](#forgotpasswordcheckresponse) |
| 400 | Invalid code or token |  |

### /form/human_input/{form_token}

#### GET
##### Summary

Get human input form definition by form token

##### Description

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
##### Summary

Submit human input form by form token

##### Description

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 |
| payload | body |  | Yes | [HumanInputFormSubmitPayload](#humaninputformsubmitpayload) |

##### Responses

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

### /info

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TenantInfoResponse](#tenantinforesponse) |

### /installed-apps

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [InstalledAppListResponse](#installedapplistresponse) |

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleMessageResponse](#simplemessageresponse) |

### /installed-apps/{installed_app_id}

#### DELETE
##### Parameters

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

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | App uninstalled successfully |

#### PATCH
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultMessageResponse](#simpleresultmessageresponse) |

### /installed-apps/{installed_app_id}/audio-to-text

#### POST
##### Parameters

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

##### Responses

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

### /installed-apps/{installed_app_id}/chat-messages

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [ChatMessagePayload](#chatmessagepayload) |

##### Responses

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

### /installed-apps/{installed_app_id}/chat-messages/{task_id}/stop

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /installed-apps/{installed_app_id}/completion-messages

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [CompletionMessageExplorePayload](#completionmessageexplorepayload) |

##### Responses

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

### /installed-apps/{installed_app_id}/completion-messages/{task_id}/stop

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| task_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /installed-apps/{installed_app_id}/conversations

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [ConversationListQuery](#conversationlistquery) |

##### Responses

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

### /installed-apps/{installed_app_id}/conversations/{c_id}

#### DELETE
##### 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 |

### /installed-apps/{installed_app_id}/conversations/{c_id}/name

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [ConversationRenamePayload](#conversationrenamepayload) |

##### Responses

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

### /installed-apps/{installed_app_id}/conversations/{c_id}/pin

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ResultResponse](#resultresponse) |

### /installed-apps/{installed_app_id}/conversations/{c_id}/unpin

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path |  | Yes | string |
| installed_app_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ResultResponse](#resultresponse) |

### /installed-apps/{installed_app_id}/messages

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [MessageListQuery](#messagelistquery) |

##### Responses

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

### /installed-apps/{installed_app_id}/messages/{message_id}/feedbacks

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |
| payload | body |  | Yes | [MessageFeedbackPayload](#messagefeedbackpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Feedback submitted successfully | [ResultResponse](#resultresponse) |

### /installed-apps/{installed_app_id}/messages/{message_id}/more-like-this

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |
| payload | body |  | Yes | [MoreLikeThisQuery](#morelikethisquery) |

##### Responses

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

### /installed-apps/{installed_app_id}/messages/{message_id}/suggested-questions

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| message_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SuggestedQuestionsResponse](#suggestedquestionsresponse) |

### /installed-apps/{installed_app_id}/meta

#### GET
##### Summary

Get app meta

##### Parameters

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

##### Responses

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

### /installed-apps/{installed_app_id}/parameters

#### GET
##### Summary

Retrieve app parameters

##### Parameters

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

##### Responses

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

### /installed-apps/{installed_app_id}/saved-messages

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [SavedMessageListQuery](#savedmessagelistquery) |

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [SavedMessageCreatePayload](#savedmessagecreatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ResultResponse](#resultresponse) |

### /installed-apps/{installed_app_id}/saved-messages/{message_id}

#### DELETE
##### 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 |

### /installed-apps/{installed_app_id}/text-to-audio

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [TextToAudioPayload](#texttoaudiopayload) |

##### Responses

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

### /installed-apps/{installed_app_id}/workflows/run

#### POST
##### Summary

Run workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| installed_app_id | path |  | Yes | string |
| payload | body |  | Yes | [WorkflowRunPayload](#workflowrunpayload) |

##### Responses

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

### /installed-apps/{installed_app_id}/workflows/tasks/{task_id}/stop

#### POST
##### Summary

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 | [SimpleResultResponse](#simpleresultresponse) |

### /instruction-generate

#### POST
##### Description

Generate instruction for workflow nodes or general use

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [InstructionGeneratePayload](#instructiongeneratepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Instruction generated successfully |
| 400 | Invalid request parameters or flow/workflow not found |
| 402 | Provider quota exceeded |

### /instruction-generate/template

#### POST
##### Description

Get instruction generation template

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [InstructionTemplatePayload](#instructiontemplatepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Template retrieved successfully |
| 400 | Invalid request parameters |

### /login

#### POST
##### Summary

Authenticate user and login

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [LoginPayload](#loginpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultOptionalDataResponse](#simpleresultoptionaldataresponse) |

### /logout

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /mcp/oauth/callback

#### GET
##### Responses

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

### /notification

#### GET
##### Description

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 |

### /notification/dismiss

#### POST
##### Description

Mark a notification as dismissed for the current user.

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |
| 401 | Unauthorized |  |

### /notion/pages/{page_id}/{page_type}/preview

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| page_id | path |  | Yes | string |
| page_type | path |  | Yes | string |
| credential_id | query | Credential ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TextContentResponse](#textcontentresponse) |

### /notion/pre-import/pages

#### GET
##### 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 | [NotionIntegrateInfoListResponse](#notionintegrateinfolistresponse) |

### /oauth/authorize/{provider}

#### GET
##### Description

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 |

### /oauth/data-source/binding/{provider}

#### GET
##### Description

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 | [OAuthDataSourceBindingResponse](#oauthdatasourcebindingresponse) |
| 400 | Invalid provider or code |  |

### /oauth/data-source/callback/{provider}

#### GET
##### Description

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 |

### /oauth/data-source/{provider}

#### GET
##### Description

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 | [OAuthDataSourceResponse](#oauthdatasourceresponse) |
| 400 | Invalid provider |  |
| 403 | Admin privileges required |  |

### /oauth/data-source/{provider}/{binding_id}/sync

#### GET
##### Description

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 | [OAuthDataSourceSyncResponse](#oauthdatasourcesyncresponse) |
| 400 | Invalid provider or sync failed |  |

### /oauth/login/{provider}

#### GET
##### Description

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 |

### /oauth/plugin/{provider_id}/datasource/callback

#### GET
##### Parameters

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

##### Responses

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

### /oauth/plugin/{provider_id}/datasource/get-authorization-url

#### GET
##### Parameters

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

##### Responses

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

### /oauth/plugin/{provider}/tool/authorization-url

#### GET
##### Parameters

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

##### Responses

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

### /oauth/plugin/{provider}/tool/callback

#### GET
##### Parameters

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

##### Responses

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

### /oauth/plugin/{provider}/trigger/callback

#### GET
##### Summary

Handle OAuth callback for trigger provider

##### Parameters

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

##### Responses

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

### /oauth/provider

#### POST
##### Responses

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

### /oauth/provider/account

#### POST
##### Responses

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

### /oauth/provider/authorize

#### POST
##### Responses

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

### /oauth/provider/token

#### POST
##### Responses

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

### /rag/pipeline/customized/templates/{template_id}

#### DELETE
##### Parameters

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

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Pipeline template deleted |

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| template_id | path |  | Yes | string |
| payload | body |  | Yes | [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Pipeline template updated |

#### POST
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleDataResponse](#simpledataresponse) |

### /rag/pipeline/dataset

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RagPipelineDatasetImportPayload](#ragpipelinedatasetimportpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | RAG pipeline dataset import started | [RagPipelineImportResponse](#ragpipelineimportresponse) |

### /rag/pipeline/empty-dataset

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | RAG pipeline dataset created | [DatasetDetailResponse](#datasetdetailresponse) |

### /rag/pipeline/templates

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| language | query | Template language | No | string |
| type | query | Template source: built-in or customized | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline templates | [PipelineTemplateListResponse](#pipelinetemplatelistresponse) |

### /rag/pipeline/templates/{template_id}

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| template_id | path |  | Yes | string |
| type | query | Template source: built-in or customized | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline template | [PipelineTemplateDetailResponse](#pipelinetemplatedetailresponse) |

### /rag/pipelines/datasource-plugins

#### GET
##### Responses

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

### /rag/pipelines/imports

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RagPipelineImportPayload](#ragpipelineimportpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import completed | [RagPipelineImportResponse](#ragpipelineimportresponse) |
| 202 | Import pending confirmation | [RagPipelineImportResponse](#ragpipelineimportresponse) |
| 400 | Import failed | [RagPipelineImportResponse](#ragpipelineimportresponse) |

### /rag/pipelines/imports/{import_id}/confirm

#### POST
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Import confirmed | [RagPipelineImportResponse](#ragpipelineimportresponse) |
| 400 | Import failed | [RagPipelineImportResponse](#ragpipelineimportresponse) |

### /rag/pipelines/imports/{pipeline_id}/check-dependencies

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Dependencies checked | [RagPipelineImportCheckDependenciesResponse](#ragpipelineimportcheckdependenciesresponse) |

### /rag/pipelines/recommended-plugins

#### GET
##### Responses

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

### /rag/pipelines/transform/datasets/{dataset_id}

#### POST
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/customized/publish

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Pipeline template published |

### /rag/pipelines/{pipeline_id}/exports

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| include_secret | query | Whether to include secret values in the exported DSL | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline exported | [SimpleDataResponse](#simpledataresponse) |

### /rag/pipelines/{pipeline_id}/workflow-runs

#### GET
##### Summary

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 | [WorkflowRunPaginationResponse](#workflowrunpaginationresponse) |

### /rag/pipelines/{pipeline_id}/workflow-runs/tasks/{task_id}/stop

#### POST
##### Summary

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 | [SimpleResultResponse](#simpleresultresponse) |

### /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}

#### GET
##### Summary

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 | [WorkflowRunDetailResponse](#workflowrundetailresponse) |

### /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}/node-executions

#### GET
##### Summary

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 | [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse) |

### /rag/pipelines/{pipeline_id}/workflows

#### GET
##### Summary

Get published workflows

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Published workflows retrieved successfully | [WorkflowPaginationResponse](#workflowpaginationresponse) |
| 403 | Permission denied |  |

### /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs

#### GET
##### Summary

Get default block config

##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs/{block_type}

#### GET
##### Summary

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 |

### /rag/pipelines/{pipeline_id}/workflows/draft

#### GET
##### Summary

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 | [WorkflowResponse](#workflowresponse) |
| 404 | Draft workflow not found |  |

#### POST
##### Summary

Sync draft workflow

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [RagPipelineWorkflowSyncResponse](#ragpipelineworkflowsyncresponse) |

### /rag/pipelines/{pipeline_id}/workflows/draft/datasource/nodes/{node_id}/run

#### POST
##### Summary

Run rag pipeline datasource

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceNodeRunPayload](#datasourcenoderunpayload) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/datasource/variables-inspect

#### POST
##### Summary

Set datasource variables

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceVariablesPayload](#datasourcevariablespayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Datasource variables set successfully | [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) |

### /rag/pipelines/{pipeline_id}/workflows/draft/environment-variables

#### GET
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/iteration/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow iteration node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [NodeRunPayload](#noderunpayload) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/loop/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow loop node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [NodeRunPayload](#noderunpayload) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/last-run

#### GET
##### 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 | [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) |

### /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/run

#### POST
##### Summary

Run draft workflow node

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [NodeRunRequiredPayload](#noderunrequiredpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Node run started successfully | [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) |

### /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/pre-processing/parameters

#### GET
##### Summary

Get first step parameters of rag pipeline

##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/processing/parameters

#### GET
##### Summary

Get second step parameters of rag pipeline

##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/run

#### POST
##### Summary

Run draft workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [DraftWorkflowRunPayload](#draftworkflowrunpayload) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/system-variables

#### GET
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/variables

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Parameters

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

##### Responses

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

#### PATCH
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}/reset

#### PUT
##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/publish

#### GET
##### Summary

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 | [WorkflowResponse](#workflowresponse) |

#### POST
##### Summary

Publish workflow

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [RagPipelineWorkflowPublishResponse](#ragpipelineworkflowpublishresponse) |

### /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/preview

#### POST
##### Summary

Run datasource content preview

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [Parser](#parser) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/run

#### POST
##### Summary

Run rag pipeline datasource

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| node_id | path |  | Yes | string |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [DatasourceNodeRunPayload](#datasourcenoderunpayload) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/published/pre-processing/parameters

#### GET
##### Summary

Get first step parameters of rag pipeline

##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/published/processing/parameters

#### GET
##### Summary

Get second step parameters of rag pipeline

##### Parameters

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

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/published/run

#### POST
##### Summary

Run published workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| pipeline_id | path |  | Yes | string |
| payload | body |  | Yes | [PublishedWorkflowRunPayload](#publishedworkflowrunpayload) |

##### Responses

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

### /rag/pipelines/{pipeline_id}/workflows/{workflow_id}

#### DELETE
##### Summary

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
##### Summary

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 | [WorkflowResponse](#workflowresponse) |
| 400 | No valid fields to update |  |
| 403 | Permission denied |  |
| 404 | Workflow not found |  |

### /rag/pipelines/{pipeline_id}/workflows/{workflow_id}/restore

#### POST
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [RagPipelineWorkflowSyncResponse](#ragpipelineworkflowsyncresponse) |

### /refresh-token

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /remote-files/upload

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RemoteFileUploadPayload](#remotefileuploadpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | File uploaded successfully | [FileWithSignedUrl](#filewithsignedurl) |

### /remote-files/{url}

#### GET
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [RemoteFileInfo](#remotefileinfo) |

### /reset-password

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EmailPayload](#emailpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultDataResponse](#simpleresultdataresponse) |

### /rule-code-generate

#### POST
##### Description

Generate code rules using LLM

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RuleCodeGeneratePayload](#rulecodegeneratepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Code rules generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### /rule-generate

#### POST
##### Description

Generate rule configuration using LLM

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RuleGeneratePayload](#rulegeneratepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Rule configuration generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### /rule-structured-output-generate

#### POST
##### Description

Generate structured output rules using LLM

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [RuleStructuredOutputPayload](#rulestructuredoutputpayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Structured output generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### /spec/schema-definitions

#### GET
##### Summary

Get system JSON Schema definitions specification

##### Description

Used for frontend component type mapping

##### Responses

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

### /system-features

#### GET
##### Summary

Get system-wide feature configuration

##### Description

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 | [SystemFeatureModel](#systemfeaturemodel) |

### /tag-bindings

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TagBindingPayload](#tagbindingpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /tag-bindings/remove

#### POST
##### Description

Remove one or more tag bindings from a target.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TagBindingRemovePayload](#tagbindingremovepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /tags

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| keyword | query | Search keyword for tag name. | No | string |
| type | query | Tag type filter. Can be "knowledge" or "app". | No | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ [TagResponse](#tagresponse) ] |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [TagBasePayload](#tagbasepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TagResponse](#tagresponse) |

### /tags/{tag_id}

#### DELETE
##### Parameters

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

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Tag deleted successfully |

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| tag_id | path |  | Yes | string |
| payload | body |  | Yes | [TagUpdateRequestPayload](#tagupdaterequestpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TagResponse](#tagresponse) |

### /test/retrieval

#### POST
##### Description

Bedrock retrieval test (internal use only)

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [BedrockRetrievalPayload](#bedrockretrievalpayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Bedrock retrieval test completed |

### /trial-apps/{app_id}

#### GET
##### Summary

Get app detail

##### Parameters

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

##### Responses

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

### /trial-apps/{app_id}/audio-to-text

#### POST
##### Parameters

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

##### Responses

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

### /trial-apps/{app_id}/chat-messages

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [ChatRequest](#chatrequest) |

##### Responses

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

### /trial-apps/{app_id}/completion-messages

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [CompletionRequest](#completionrequest) |

##### Responses

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

### /trial-apps/{app_id}/datasets

#### GET
##### Parameters

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

##### Responses

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

### /trial-apps/{app_id}/messages/{message_id}/suggested-questions

#### GET
##### Parameters

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

##### Responses

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

### /trial-apps/{app_id}/parameters

#### GET
##### Summary

Retrieve app parameters

##### Parameters

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

##### Responses

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

### /trial-apps/{app_id}/site

#### GET
##### Summary

Retrieve app site info

##### Description

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 |

### /trial-apps/{app_id}/text-to-audio

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [TextToSpeechRequest](#texttospeechrequest) |

##### Responses

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

### /trial-apps/{app_id}/workflows

#### GET
##### Summary

Get workflow detail

##### Parameters

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

##### Responses

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

### /trial-apps/{app_id}/workflows/run

#### POST
##### Summary

Run workflow

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| app_id | path |  | Yes | string |
| payload | body |  | Yes | [WorkflowRunRequest](#workflowrunrequest) |

##### Responses

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

### /trial-apps/{app_id}/workflows/tasks/{task_id}/stop

#### POST
##### Summary

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 |

### /trial-models

#### GET
##### Summary

Get hosted trial model provider configuration for model-provider pages

##### Description

Get hosted trial model provider configuration

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TrialModelsResponse](#trialmodelsresponse) |

### /website/crawl

#### POST
##### Description

Crawl website content

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WebsiteCrawlPayload](#websitecrawlpayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Website crawl initiated successfully |
| 400 | Invalid crawl parameters |

### /website/crawl/status/{job_id}

#### GET
##### Description

Get website crawl status

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WebsiteCrawlStatusQuery](#websitecrawlstatusquery) |
| job_id | path | Crawl job ID | Yes | string |
| provider | query | Crawl provider (firecrawl/watercrawl/jinareader) | No | string |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Crawl status retrieved successfully |
| 400 | Invalid provider |
| 404 | Crawl job not found |

### /workflow-generate

#### POST
##### Description

Generate a Dify workflow graph from natural language

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowGeneratePayload](#workflowgeneratepayload) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 200 | Workflow graph generated successfully |
| 400 | Invalid request parameters |
| 402 | Provider quota exceeded |

### /workflow/{workflow_run_id}/events

#### GET
##### Summary

Get workflow execution events stream after resume

##### Description

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 |

### /workflow/{workflow_run_id}/pause-details

#### GET
##### Summary

Get workflow pause details

##### Description

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 | [WorkflowPauseDetailsResponse](#workflowpausedetailsresponse) |
| 404 | Workflow run not found |  |

### /workspaces

#### GET
##### Responses

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

### /workspaces/current

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [TenantInfoResponse](#tenantinforesponse) |

### /workspaces/current/agent-provider/{provider_name}

#### GET
##### Description

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 | object |

### /workspaces/current/agent-providers

#### GET
##### Description

Get list of available agent providers

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [ object ] |

### /workspaces/current/dataset-operators

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AccountWithRoleList](#accountwithrolelist) |

### /workspaces/current/default-model

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserGetDefault](#parsergetdefault) |

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPostDefault](#parserpostdefault) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/endpoints

#### POST
##### Description

Create a new plugin endpoint

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointCreatePayload](#endpointcreatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint created successfully | [EndpointCreateResponse](#endpointcreateresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/endpoints/create

#### POST
***DEPRECATED***
##### Description

Deprecated legacy alias for creating a plugin endpoint. Use POST /workspaces/current/endpoints instead.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointCreatePayload](#endpointcreatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint created successfully | [EndpointCreateResponse](#endpointcreateresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/endpoints/delete

#### POST
***DEPRECATED***
##### Description

Deprecated legacy alias for deleting a plugin endpoint. Use DELETE /workspaces/current/endpoints/{id} instead.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointIdPayload](#endpointidpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint deleted successfully | [EndpointDeleteResponse](#endpointdeleteresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/endpoints/disable

#### POST
##### Description

Disable a plugin endpoint

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointIdPayload](#endpointidpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint disabled successfully | [EndpointDisableResponse](#endpointdisableresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/endpoints/enable

#### POST
##### Description

Enable a plugin endpoint

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointIdPayload](#endpointidpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint enabled successfully | [EndpointEnableResponse](#endpointenableresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/endpoints/list

#### GET
##### Description

List plugin endpoints with pagination

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointListQuery](#endpointlistquery) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [EndpointListResponse](#endpointlistresponse) |

### /workspaces/current/endpoints/list/plugin

#### GET
##### Description

List endpoints for a specific plugin

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointListForPluginQuery](#endpointlistforpluginquery) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [PluginEndpointListResponse](#pluginendpointlistresponse) |

### /workspaces/current/endpoints/update

#### POST
***DEPRECATED***
##### Description

Deprecated legacy alias for updating a plugin endpoint. Use PATCH /workspaces/current/endpoints/{id} instead.

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [LegacyEndpointUpdatePayload](#legacyendpointupdatepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint updated successfully | [EndpointUpdateResponse](#endpointupdateresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/endpoints/{id}

#### DELETE
##### Description

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 | [EndpointDeleteResponse](#endpointdeleteresponse) |
| 403 | Admin privileges required |  |

#### PATCH
##### Description

Update a plugin endpoint

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [EndpointUpdatePayload](#endpointupdatepayload) |
| id | path | Endpoint ID | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Endpoint updated successfully | [EndpointUpdateResponse](#endpointupdateresponse) |
| 403 | Admin privileges required |  |

### /workspaces/current/members

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [AccountWithRoleList](#accountwithrolelist) |

### /workspaces/current/members/invite-email

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MemberInvitePayload](#memberinvitepayload) |

##### Responses

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

### /workspaces/current/members/owner-transfer-check

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [OwnerTransferCheckPayload](#ownertransfercheckpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [VerificationTokenResponse](#verificationtokenresponse) |

### /workspaces/current/members/send-owner-transfer-confirm-email

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [OwnerTransferEmailPayload](#ownertransferemailpayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultDataResponse](#simpleresultdataresponse) |

### /workspaces/current/members/{member_id}

#### DELETE
##### Parameters

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

##### Responses

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

### /workspaces/current/members/{member_id}/owner-transfer

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| member_id | path |  | Yes | string |
| payload | body |  | Yes | [OwnerTransferPayload](#ownertransferpayload) |

##### Responses

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

### /workspaces/current/members/{member_id}/update-role

#### PUT
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| member_id | path |  | Yes | string |
| payload | body |  | Yes | [MemberRoleUpdatePayload](#memberroleupdatepayload) |

##### Responses

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

### /workspaces/current/model-providers

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserModelList](#parsermodellist) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/checkout-url

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/model-providers/{provider}/credentials

#### DELETE
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCredentialDelete](#parsercredentialdelete) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Credential deleted successfully |

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCredentialId](#parsercredentialid) |

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCredentialCreate](#parsercredentialcreate) |

##### Responses

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

#### PUT
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCredentialUpdate](#parsercredentialupdate) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/credentials/switch

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCredentialSwitch](#parsercredentialswitch) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/model-providers/{provider}/credentials/validate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCredentialValidate](#parsercredentialvalidate) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/models

#### DELETE
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserDeleteModels](#parserdeletemodels) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Model deleted successfully |

#### GET
##### Parameters

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

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserPostModels](#parserpostmodels) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/models/credentials

#### DELETE
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserDeleteCredential](#parserdeletecredential) |

##### Responses

| Code | Description |
| ---- | ----------- |
| 204 | Credential deleted successfully |

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserGetCredentials](#parsergetcredentials) |

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserCreateCredential](#parsercreatecredential) |

##### Responses

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

#### PUT
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserUpdateCredential](#parserupdatecredential) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/models/credentials/switch

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserSwitch](#parserswitch) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/model-providers/{provider}/models/credentials/validate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserValidate](#parservalidate) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/models/disable

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserDeleteModels](#parserdeletemodels) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/model-providers/{provider}/models/enable

#### PATCH
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserDeleteModels](#parserdeletemodels) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/model-providers/{provider}/models/load-balancing-configs/credentials-validate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [LoadBalancingCredentialPayload](#loadbalancingcredentialpayload) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/models/load-balancing-configs/{config_id}/credentials-validate

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| config_id | path |  | Yes | string |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [LoadBalancingCredentialPayload](#loadbalancingcredentialpayload) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/models/parameter-rules

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserParameter](#parserparameter) |

##### Responses

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

### /workspaces/current/model-providers/{provider}/preferred-provider-type

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ParserPreferredProviderType](#parserpreferredprovidertype) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/models/model-types/{model_type}

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/permission

#### GET
##### Summary

Get workspace permission settings

##### Description

Returns permission flags that control workspace features like member invitations and owner transfer.

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [WorkspacePermissionResponse](#workspacepermissionresponse) |

### /workspaces/current/plugin/asset

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserAsset](#parserasset) |

##### Responses

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

### /workspaces/current/plugin/debugging-key

#### GET
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [PluginDebuggingKeyResponse](#plugindebuggingkeyresponse) |

### /workspaces/current/plugin/fetch-manifest

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPluginIdentifierQuery](#parserpluginidentifierquery) |

##### Responses

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

### /workspaces/current/plugin/icon

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserIcon](#parsericon) |

##### Responses

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

### /workspaces/current/plugin/install/github

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserGithubInstall](#parsergithubinstall) |

##### Responses

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

### /workspaces/current/plugin/install/marketplace

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPluginIdentifiers](#parserpluginidentifiers) |

##### Responses

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

### /workspaces/current/plugin/install/pkg

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPluginIdentifiers](#parserpluginidentifiers) |

##### Responses

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

### /workspaces/current/plugin/list

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserList](#parserlist) |

##### Responses

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

### /workspaces/current/plugin/list/installations/ids

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserLatest](#parserlatest) |

##### Responses

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

### /workspaces/current/plugin/list/latest-versions

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserLatest](#parserlatest) |

##### Responses

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

### /workspaces/current/plugin/marketplace/pkg

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPluginIdentifierQuery](#parserpluginidentifierquery) |

##### Responses

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

### /workspaces/current/plugin/parameters/dynamic-options

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserDynamicOptions](#parserdynamicoptions) |

##### Responses

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

### /workspaces/current/plugin/parameters/dynamic-options-with-credentials

#### POST
##### Summary

Fetch dynamic options using credentials directly (for edit mode)

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserDynamicOptionsWithCredentials](#parserdynamicoptionswithcredentials) |

##### Responses

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

### /workspaces/current/plugin/permission/change

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPermissionChange](#parserpermissionchange) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SuccessResponse](#successresponse) |

### /workspaces/current/plugin/permission/fetch

#### GET
##### Responses

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

### /workspaces/current/plugin/preferences/autoupgrade/exclude

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserExcludePlugin](#parserexcludeplugin) |

##### Responses

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

### /workspaces/current/plugin/preferences/change

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserPreferencesChange](#parserpreferenceschange) |

##### Responses

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

### /workspaces/current/plugin/preferences/fetch

#### GET
##### Responses

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

### /workspaces/current/plugin/readme

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserReadme](#parserreadme) |

##### Responses

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

### /workspaces/current/plugin/tasks

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserTasks](#parsertasks) |

##### Responses

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

### /workspaces/current/plugin/tasks/delete_all

#### POST
##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SuccessResponse](#successresponse) |

### /workspaces/current/plugin/tasks/{task_id}

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/plugin/tasks/{task_id}/delete

#### POST
##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SuccessResponse](#successresponse) |

### /workspaces/current/plugin/tasks/{task_id}/delete/{identifier}

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| identifier | path |  | Yes | string |
| task_id | path |  | Yes | string |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SuccessResponse](#successresponse) |

### /workspaces/current/plugin/uninstall

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserUninstall](#parseruninstall) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SuccessResponse](#successresponse) |

### /workspaces/current/plugin/upgrade/github

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserGithubUpgrade](#parsergithubupgrade) |

##### Responses

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

### /workspaces/current/plugin/upgrade/marketplace

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserMarketplaceUpgrade](#parsermarketplaceupgrade) |

##### Responses

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

### /workspaces/current/plugin/upload/bundle

#### POST
##### Responses

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

### /workspaces/current/plugin/upload/github

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ParserGithubUpload](#parsergithubupload) |

##### Responses

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

### /workspaces/current/plugin/upload/pkg

#### POST
##### Responses

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

### /workspaces/current/tool-labels

#### GET
##### Responses

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

### /workspaces/current/tool-provider/api/add

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ApiToolProviderAddPayload](#apitoolprovideraddpayload) |

##### Responses

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

### /workspaces/current/tool-provider/api/delete

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ApiToolProviderDeletePayload](#apitoolproviderdeletepayload) |

##### Responses

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

### /workspaces/current/tool-provider/api/get

#### GET
##### Responses

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

### /workspaces/current/tool-provider/api/remote

#### GET
##### Responses

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

### /workspaces/current/tool-provider/api/schema

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ApiToolSchemaPayload](#apitoolschemapayload) |

##### Responses

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

### /workspaces/current/tool-provider/api/test/pre

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ApiToolTestPayload](#apitooltestpayload) |

##### Responses

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

### /workspaces/current/tool-provider/api/tools

#### GET
##### Responses

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

### /workspaces/current/tool-provider/api/update

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [ApiToolProviderUpdatePayload](#apitoolproviderupdatepayload) |

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/add

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [BuiltinToolAddPayload](#builtintooladdpayload) |

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/credential/info

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/credential/schema/{credential_type}

#### GET
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| credential_type | path |  | Yes | string |
| provider | path |  | Yes | string |

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/credentials

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/default-credential

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [BuiltinProviderDefaultCredentialPayload](#builtinproviderdefaultcredentialpayload) |

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/delete

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [BuiltinToolCredentialDeletePayload](#builtintoolcredentialdeletepayload) |

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/icon

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/info

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/oauth/client-schema

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client

#### DELETE
##### Parameters

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

##### Responses

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

#### GET
##### Parameters

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

##### Responses

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

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [ToolOAuthCustomClientPayload](#tooloauthcustomclientpayload) |

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/tools

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/builtin/{provider}/update

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [BuiltinToolUpdatePayload](#builtintoolupdatepayload) |

##### Responses

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

### /workspaces/current/tool-provider/mcp

#### DELETE
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MCPProviderDeletePayload](#mcpproviderdeletepayload) |

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MCPProviderCreatePayload](#mcpprovidercreatepayload) |

##### Responses

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

#### PUT
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MCPProviderUpdatePayload](#mcpproviderupdatepayload) |

##### Responses

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

### /workspaces/current/tool-provider/mcp/auth

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [MCPAuthPayload](#mcpauthpayload) |

##### Responses

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

### /workspaces/current/tool-provider/mcp/tools/{provider_id}

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/mcp/update/{provider_id}

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/tool-provider/workflow/create

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowToolCreatePayload](#workflowtoolcreatepayload) |

##### Responses

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

### /workspaces/current/tool-provider/workflow/delete

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowToolDeletePayload](#workflowtooldeletepayload) |

##### Responses

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

### /workspaces/current/tool-provider/workflow/get

#### GET
##### Responses

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

### /workspaces/current/tool-provider/workflow/tools

#### GET
##### Responses

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

### /workspaces/current/tool-provider/workflow/update

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkflowToolUpdatePayload](#workflowtoolupdatepayload) |

##### Responses

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

### /workspaces/current/tool-providers

#### GET
##### Responses

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

### /workspaces/current/tools/api

#### GET
##### Responses

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

### /workspaces/current/tools/builtin

#### GET
##### Responses

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

### /workspaces/current/tools/mcp

#### GET
##### Responses

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

### /workspaces/current/tools/workflow

#### GET
##### Responses

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

### /workspaces/current/trigger-provider/{provider}/icon

#### GET
##### Parameters

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

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/info

#### GET
##### Summary

Get info for a trigger provider

##### Parameters

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

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/oauth/client

#### DELETE
##### Summary

Remove custom OAuth client configuration

##### Parameters

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

##### Responses

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

#### GET
##### Summary

Get OAuth client configuration for a provider

##### Parameters

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

##### Responses

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

#### POST
##### Summary

Configure custom OAuth client for a provider

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [TriggerOAuthClientPayload](#triggeroauthclientpayload) |

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/subscriptions/builder/build/{subscription_builder_id}

#### POST
##### Summary

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 |
| payload | body |  | Yes | [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload) |

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/subscriptions/builder/create

#### POST
##### Summary

Add a new subscription instance for a trigger provider

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| provider | path |  | Yes | string |
| payload | body |  | Yes | [TriggerSubscriptionBuilderCreatePayload](#triggersubscriptionbuildercreatepayload) |

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/subscriptions/builder/logs/{subscription_builder_id}

#### GET
##### Summary

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 |

### /workspaces/current/trigger-provider/{provider}/subscriptions/builder/update/{subscription_builder_id}

#### POST
##### Summary

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 |
| payload | body |  | Yes | [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload) |

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/subscriptions/builder/verify-and-update/{subscription_builder_id}

#### POST
##### Summary

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 |
| payload | body |  | Yes | [TriggerSubscriptionBuilderVerifyPayload](#triggersubscriptionbuilderverifypayload) |

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/subscriptions/builder/{subscription_builder_id}

#### GET
##### Summary

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 |

### /workspaces/current/trigger-provider/{provider}/subscriptions/list

#### GET
##### Summary

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 |

### /workspaces/current/trigger-provider/{provider}/subscriptions/oauth/authorize

#### GET
##### Summary

Initiate OAuth authorization flow for a trigger provider

##### Parameters

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

##### Responses

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

### /workspaces/current/trigger-provider/{provider}/subscriptions/verify/{subscription_id}

#### POST
##### Summary

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 |
| payload | body |  | Yes | [TriggerSubscriptionBuilderVerifyPayload](#triggersubscriptionbuilderverifypayload) |

##### Responses

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

### /workspaces/current/trigger-provider/{subscription_id}/subscriptions/delete

#### POST
##### Summary

Delete a subscription instance

##### Parameters

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

##### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |

### /workspaces/current/trigger-provider/{subscription_id}/subscriptions/update

#### POST
##### Summary

Update a subscription instance

##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| subscription_id | path |  | Yes | string |
| payload | body |  | Yes | [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload) |

##### Responses

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

### /workspaces/current/triggers

#### GET
##### Summary

List all trigger providers for the current tenant

##### Responses

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

### /workspaces/custom-config

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkspaceCustomConfigPayload](#workspacecustomconfigpayload) |

##### Responses

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

### /workspaces/custom-config/webapp-logo/upload

#### POST
##### Responses

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

### /workspaces/info

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [WorkspaceInfoPayload](#workspaceinfopayload) |

##### Responses

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

### /workspaces/switch

#### POST
##### Parameters

| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| payload | body |  | Yes | [SwitchWorkspacePayload](#switchworkspacepayload) |

##### Responses

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

### /workspaces/{tenant_id}/model-providers/{provider}/{icon_type}/{lang}

#### GET
##### 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

### /explore/banners

#### GET
##### Summary

Get banner list

##### Responses

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

---
### Models

#### 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 | *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 | 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 |
| 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 |
| ---- | ---- | ----------- | -------- |
| authorization_status | [AgentCliToolAuthorizationStatus](#agentclitoolauthorizationstatus) |  | No |
| command | string |  | No |
| dangerous | boolean |  | No |
| dangerous_acknowledged | boolean |  | No |
| description | string |  | No |
| enabled | boolean |  | No |
| invoke_metadata | object |  | No |
| name | string |  | No |
| permission | object |  | No |
| pre_authorized | boolean |  | No |
| risk_level | [AgentCliToolRiskLevel](#agentclitoolrisklevel) |  | 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 |
| variant | [ComposerVariant](#composervariant) |  | Yes |

#### AgentComposerDifyToolCandidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| id | string |  | No |
| name | string |  | No |
| plugin_id | string |  | No |
| provider | string |  | No |
| provider_id | 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 |

#### 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 | [ [AgentSkillRefConfig](#agentskillrefconfig) ] |  | No |

#### AgentComposerSoulLockResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| can_unlock | boolean |  | No |
| locked | boolean |  | Yes |
| reason | string |  | No |

#### AgentComposerValidateResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errors | [ string ] |  | No |
| result | string |  | Yes |

#### 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 |
| ---- | ---- | ----------- | -------- |
| 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 |

#### AgentFeatureToggleConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean |  | No |

#### AgentFileRefConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| name | string |  | No |
| transfer_method | string |  | No |
| type | string |  | No |
| url | string |  | No |

#### AgentHumanContactConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contact_id | string |  | No |
| email | string |  | No |
| human_id | string |  | No |
| id | string |  | No |
| name | string |  | No |

#### AgentHumanToolConfig

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string |  | No |
| enabled | boolean |  | 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 |
| 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 |  | No |
| page | integer |  | 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 |

#### 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 |
| 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 |
| ---- | ---- | ----------- | -------- |
| env | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] |  | No |
| image | string |  | No |
| working_dir | string |  | No |

#### 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 |
| ---- | ---- | ----------- | -------- |
| id | string |  | No |
| name | string |  | No |
| permission | object |  | No |
| permission_status | string |  | No |
| provider | string |  | No |
| type | 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 |  | 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 | *Enum:* `"api-key"`, `"oauth2"`, `"unauthorized"` | No |
| description | string |  | No |
| enabled | boolean |  | No |
| name | string |  | No |
| plugin_id | string |  | No |
| provider | string |  | No |
| provider_id | string |  | No |
| provider_type | string |  | No |
| runtime_parameters | object |  | No |
| tool_name | string |  | Yes |

#### 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 | *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 |

#### 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 | Page size | No |
| page | integer | 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 | *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 |
| ---- | ---- | ----------- | -------- |
| is_created_by_me | boolean | Filter by creator | No |
| limit | integer | Page size (1-100) | No |
| mode | string | 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 | 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 | *Enum:* `"allow"`, `"must"`, `"not_allow"` | 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 | 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 | Page size (1-100) | No |
| page | integer | Page number | No |
| sort_by | string | 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 | [  ] | 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 | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | 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 | Number of messages to return (1-100) | No |

#### ChatRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string |  | No |
| files | [  ] |  | No |
| inputs | object |  | Yes |
| parent_message_id | string |  | No |
| query | string |  | Yes |
| retriever_from | string |  | No |

#### CheckDependenciesResult

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] |  | No |

#### CheckEmailUniquePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string |  | Yes |

#### 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 |  | No |
| page | integer |  | 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 | 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 | Page size (1-100) | No |
| page | integer | 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 | *Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string |  | No |

#### CompletionMessagePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [  ] | Uploaded files | No |
| inputs | object |  | Yes |
| model_config | object |  | No |
| query | string | Query text | No |
| response_mode | string | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | Retriever source | No |

#### CompletionRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [  ] |  | No |
| inputs | object |  | Yes |
| query | string |  | No |
| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string |  | 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 | *Enum:* `"inline_agent"`, `"roster_agent"` | Yes |
| current_snapshot_id | string |  | No |

#### ComposerCandidateCapabilities

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| human_roster_available | boolean |  | No |

#### 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 |  | No |
| unlocked_from_version_id | string |  | No |

#### ComposerVariant

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ComposerVariant | string |  |  |

#### Condition

Condition detail

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| comparison_operator | string | *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 | Number of items per page | No |
| page | integer | 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 |  | 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 | App mode<br>*Enum:* `"advanced-chat"`, `"agent"`, `"agent-chat"`, `"chat"`, `"completion"`, `"workflow"` | Yes |
| name | string | App name | Yes |

#### 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 |  | 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 |  | 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 |  | 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 | Number of items per page | No |
| page | integer | 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 |  | Yes |
| documents_upload_quota | [LimitationModel](#limitationmodel) |  | Yes |
| education | [EducationModel](#educationmodel) |  | Yes |
| human_input_email_delivery_enabled | boolean |  | Yes |
| is_allow_transfer_workspace | boolean |  | Yes |
| knowledge_pipeline | [KnowledgePipeline](#knowledgepipeline) |  | Yes |
| knowledge_rate_limit | integer |  | 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 | Export format<br>*Enum:* `"csv"`, `"json"` | No |
| from_source | string | Filter by feedback source<br>*Enum:* `"admin"`, `"user"` | No |
| has_comment | boolean | Only include feedback with comments | No |
| rating | string | Filter by rating<br>*Enum:* `"dislike"`, `"like"` | 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 |
| 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 |

#### IconType

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IconType | string |  |  |

#### Import

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string |  | No |
| app_mode | string |  | No |
| current_dsl_version | string |  | No |
| error | string |  | No |
| id | string |  | Yes |
| imported_dsl_version | string |  | No |
| status | [ImportStatus](#importstatus) |  | Yes |

#### ImportStatus

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ImportStatus | string |  |  |

#### IncludeSecretQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| include_secret | string | Whether to include secret values in the exported DSL | 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 |  | No |
| doc_language | string |  | 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 | *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 |

#### 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 | 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 |  | No |
| doc_language | string |  | No |
| duplicate | boolean |  | No |
| embedding_model | string |  | No |
| embedding_model_provider | string |  | No |
| indexing_technique | string | *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 |
| 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 |
| 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 | *Enum:* `"dislike"`, `"like"` | 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 | Number of messages to return (1-100) | No |

#### MetadataArgs

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |
| type | string | *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 | *Enum:* `"and"`, `"or"` | 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 | *Enum:* `"blocking"`, `"streaming"` | Yes |

#### NewAppResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_app_id | string |  | Yes |

#### NodeIdQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| node_id | string |  | Yes |

#### NodeRunPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | No |

#### NodeRunRequiredPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| inputs | object |  | Yes |

#### NotionEstimatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| doc_form | string |  | No |
| doc_language | string |  | 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. |  |

#### 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 | *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 | Page number | No |
| page_size | integer | 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 | *Enum:* `"custom"`, `"system"` | Yes |

#### ParserReadme

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| language | string |  | 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 | Page number | No |
| page_size | integer | 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 | 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 | Template language | No |
| type | string | 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 | string | *Enum:* `"automatic"`, `"custom"`, `"hierarchical"` | Yes |
| rules | [Rule](#rule) |  | No |

#### PublishWorkflowPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| marked_comment | string |  | No |
| marked_name | string |  | 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 | *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 |  | 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 |  | 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 |
| 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 |

#### RosterListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword | string |  | No |
| limit | integer |  | No |
| page | integer |  | No |

#### Rule

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| parent_mode | string | *Enum:* `"full-doc"`, `"paragraph"` | No |
| pre_processing_rules | [ [PreProcessingRule](#preprocessingrule) ] |  | No |
| segmentation | [Segmentation](#segmentation) |  | No |
| subchunk_segmentation | [Segmentation](#segmentation) |  | No |

#### RuleCodeGeneratePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code_language | string | 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 |

#### SavedMessageCreatePayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| message_id | string |  | Yes |

#### SavedMessageListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| last_id | string |  | No |
| limit | integer |  | 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 |  | No |
| hit_count_gte | integer |  | No |
| keyword | string |  | No |
| limit | integer |  | No |
| page | integer |  | 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 |  | 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 |

#### 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 |  | Yes |

#### SubscriptionQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interval | string | Billing interval<br>*Enum:* `"month"`, `"year"` | Yes |
| plan | string | 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 |  | Yes |
| enable_collaboration_mode | boolean |  | Yes |
| enable_creators_platform | boolean |  | Yes |
| enable_email_code_login | boolean |  | Yes |
| enable_email_password_login | boolean |  | 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 |  | 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 | Tag type filter<br>*Enum:* `""`, `"app"`, `"knowledge"` | 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 |  | 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 |

#### 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 | dateTime |  | 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 | *Enum:* `"firecrawl"`, `"jinareader"`, `"watercrawl"` | Yes |
| url | string |  | Yes |

#### WebsiteCrawlStatusQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| provider | string | *Enum:* `"firecrawl"`, `"jinareader"`, `"watercrawl"` | Yes |

#### WebsiteInfo

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| job_id | string |  | Yes |
| only_main_content | boolean |  | 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 | *Enum:* `"customized"`, `"keyword_first"`, `"semantic_first"` | 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 |
| variant | string |  | Yes |
| workflow_id | string |  | No |

#### 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 | dateTime | Filter logs created after this timestamp | No |
| created_at__before | dateTime | 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 | Number of items per page (1-100) | No |
| page | integer | 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 | Items per page | No |
| page | integer | 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 | 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 |  | No |
| named_only | boolean |  | No |
| page | integer |  | 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 |  | No |
| workflow_prompt | string |  | No |

#### WorkflowNodeJobMetadata

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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 | [  ] |  | No |
| value_selector | [  ] |  | No |
| variable | string |  | No |
| variable_selector | [  ] |  | 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<br>*Enum:* `"failed"`, `"partial-succeeded"`, `"running"`, `"stopped"`, `"succeeded"` | 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<br>*Enum:* `"app-run"`, `"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 | Number of items per page (1-100) | No |
| status | string | Workflow run status filter<br>*Enum:* `"failed"`, `"partial-succeeded"`, `"running"`, `"stopped"`, `"succeeded"` | No |
| triggered_from | string | Filter by trigger source: debugging or app-run. Default: debugging<br>*Enum:* `"app-run"`, `"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

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| last_id | string |  | No |
| limit | integer |  | No |

#### WorkflowRunRequest

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [  ] |  | No |
| inputs | object |  | 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 | dateTime |  | 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 | dateTime |  | 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 |

#### WorkspaceFileEntryResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mtime | integer |  | Yes |
| name | string |  | Yes |
| size | integer |  | Yes |
| type | string | *Enum:* `"dir"`, `"file"`, `"symlink"` | Yes |

#### WorkspaceInfoPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string |  | Yes |

#### WorkspaceListQuery

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| limit | integer |  | No |
| page | integer |  | No |

#### WorkspaceListResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| entries | [ [WorkspaceFileEntryResponse](#workspacefileentryresponse) ] |  | No |
| path | string |  | Yes |
| truncated | boolean |  | No |

#### WorkspacePermissionResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allow_member_invite | boolean |  | Yes |
| allow_owner_transfer | boolean |  | Yes |
| workspace_id | string |  | Yes |

#### WorkspacePreviewResponse

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| binary | boolean |  | Yes |
| path | string |  | Yes |
| size | integer |  | Yes |
| text | string |  | No |
| truncated | boolean |  | Yes |

#### _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.0)

### 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 |  | 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 |  | 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 |
