Skip to content

Instantly share code, notes, and snippets.

@hyoban
Created January 28, 2026 10:06
Show Gist options
  • Select an option

  • Save hyoban/2779870e631b91085a66eef074646d20 to your computer and use it in GitHub Desktop.

Select an option

Save hyoban/2779870e631b91085a66eef074646d20 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
{
"swagger": "2.0",
"basePath": "\/console\/api",
"paths": {
"\/account\/avatar": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_avatar_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountAvatarPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/change-email": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_change_email_send_email_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChangeEmailSendPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/change-email\/check-email-unique": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_check_email_unique",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CheckEmailUniquePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/change-email\/reset": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_change_email_reset_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChangeEmailResetPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/change-email\/validity": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_change_email_check_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChangeEmailValidityPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/delete": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountDeletePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/delete\/feedback": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_delete_update_feedback_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountDeletionFeedbackPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/delete\/verify": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_account_delete_verify_api",
"tags": [
"console"
]
}
},
"\/account\/education": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_education_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_education_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EducationActivatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/education\/autocomplete": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_education_auto_complete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EducationAutocompleteQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/education\/verify": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_education_verify_api",
"tags": [
"console"
]
}
},
"\/account\/init": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_init_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountInitPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/integrates": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_account_integrate_api",
"tags": [
"console"
]
}
},
"\/account\/interface-language": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_interface_language_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountInterfaceLanguagePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/interface-theme": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_interface_theme_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountInterfaceThemePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/name": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_name_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountNamePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/password": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_password_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountPasswordPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/account\/profile": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_account_profile_api",
"tags": [
"console"
]
}
},
"\/account\/timezone": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_account_timezone_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AccountTimezonePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/activate": {
"post": {
"responses": {
"400": {
"description": "Already activated or invalid token"
},
"200": {
"description": "Account activated successfully",
"schema": {
"$ref": "#\/definitions\/ActivationResponse"
}
}
},
"description": "Activate account with invitation token",
"operationId": "activate_account",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ActivatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/activate\/check": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ActivationCheckResponse"
}
}
},
"description": "Check if activation token is valid",
"operationId": "check_activation_token",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ActivateCheckQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/admin\/delete-explore-banner\/{banner_id}": {
"delete": {
"responses": {
"204": {
"description": "Banner deleted successfully"
}
},
"description": "Delete an explore banner",
"operationId": "delete_explore_banner",
"parameters": [
{
"name": "banner_id",
"in": "path",
"required": true,
"type": "string",
"description": "Banner ID to delete"
}
],
"tags": [
"console"
]
}
},
"\/admin\/insert-explore-apps": {
"post": {
"responses": {
"404": {
"description": "App not found"
},
"201": {
"description": "App inserted successfully"
},
"200": {
"description": "App updated successfully"
}
},
"description": "Insert or update an app in the explore list",
"operationId": "insert_explore_app",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/InsertExploreAppPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/admin\/insert-explore-apps\/{app_id}": {
"delete": {
"responses": {
"204": {
"description": "App removed successfully"
}
},
"description": "Remove an app from the explore list",
"operationId": "delete_explore_app",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID to remove"
}
],
"tags": [
"console"
]
}
},
"\/admin\/insert-explore-banner": {
"post": {
"responses": {
"201": {
"description": "Banner inserted successfully"
}
},
"description": "Insert an explore banner",
"operationId": "insert_explore_banner",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/InsertExploreBannerPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/all-workspaces": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_workspace_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkspaceListQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/api-based-extension": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ApiBasedExtensionModel"
}
}
}
},
"description": "Get all API-based extensions for current tenant",
"operationId": "get_api_based_extensions",
"tags": [
"console"
]
},
"post": {
"responses": {
"201": {
"description": "Extension created successfully",
"schema": {
"$ref": "#\/definitions\/ApiBasedExtensionModel"
}
}
},
"description": "Create a new API-based extension",
"operationId": "create_api_based_extension",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/APIBasedExtensionPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/api-based-extension\/{id}": {
"delete": {
"responses": {
"204": {
"description": "Extension deleted successfully"
}
},
"description": "Delete API-based extension",
"operationId": "delete_api_based_extension",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "Extension ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Extension updated successfully",
"schema": {
"$ref": "#\/definitions\/ApiBasedExtensionModel"
}
}
},
"description": "Update API-based extension",
"operationId": "update_api_based_extension",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "Extension ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/APIBasedExtensionPayload"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ApiBasedExtensionModel"
}
}
},
"description": "Get API-based extension by ID",
"operationId": "get_api_based_extension",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "Extension ID"
}
],
"tags": [
"console"
]
}
},
"\/api-key-auth\/data-source": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_api_key_auth_data_source",
"tags": [
"console"
]
}
},
"\/api-key-auth\/data-source\/binding": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_api_key_auth_data_source_binding",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ApiKeyAuthBindingPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/api-key-auth\/data-source\/{binding_id}": {
"parameters": [
{
"name": "binding_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_api_key_auth_data_source_binding_delete",
"tags": [
"console"
]
}
},
"\/app\/prompt-templates": {
"get": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Prompt templates retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Prompt template data"
}
}
}
},
"description": "Get advanced prompt templates based on app mode and model configuration",
"operationId": "get_advanced_prompt_templates",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AdvancedPromptTemplateQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/AppPagination"
}
}
},
"summary": "Get app list",
"description": "Get list of applications with pagination and filtering",
"operationId": "list_apps",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppListQuery"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"403": {
"description": "Insufficient permissions"
},
"201": {
"description": "App created successfully",
"schema": {
"$ref": "#\/definitions\/AppDetail"
}
}
},
"summary": "Create app",
"description": "Create a new application",
"operationId": "create_app",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CreateAppPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/imports": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_app_import_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppImportPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/imports\/{app_id}\/check-dependencies": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_app_import_check_dependencies_api",
"tags": [
"console"
]
}
},
"\/apps\/imports\/{import_id}\/confirm": {
"parameters": [
{
"name": "import_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_app_import_confirm_api",
"tags": [
"console"
]
}
},
"\/apps\/{app_id}": {
"delete": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"204": {
"description": "App deleted successfully"
}
},
"summary": "Delete app",
"description": "Delete application",
"operationId": "delete_app",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/AppDetailWithSite"
}
}
},
"summary": "Get app detail",
"description": "Get application details",
"operationId": "get_app_detail",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
},
"put": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "App updated successfully",
"schema": {
"$ref": "#\/definitions\/AppDetailWithSite"
}
}
},
"summary": "Update app",
"description": "Update application details",
"operationId": "update_app",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/UpdateAppPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/advanced-chat\/workflow-runs": {
"get": {
"responses": {
"200": {
"description": "Workflow runs retrieved successfully",
"schema": {
"$ref": "#\/definitions\/AdvancedChatWorkflowRunPagination"
}
}
},
"summary": "Get advanced chat app workflow run list",
"description": "Get advanced chat workflow run list",
"operationId": "get_advanced_chat_workflow_runs",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowRunListQuery"
}
},
{
"description": "Filter by trigger source (optional): debugging or app-run. Default: debugging",
"name": "triggered_from",
"type": "string",
"in": "query"
},
{
"description": "Filter by status (optional): running, succeeded, failed, stopped, partial-succeeded",
"name": "status",
"type": "string",
"in": "query"
},
{
"description": "Last run ID for pagination",
"name": "last_id",
"type": "string",
"in": "query"
},
{
"description": "Number of items per page (1-100)",
"name": "limit",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/advanced-chat\/workflow-runs\/count": {
"get": {
"responses": {
"200": {
"description": "Workflow runs count retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunCount"
}
}
},
"summary": "Get advanced chat workflow runs count statistics",
"description": "Get advanced chat workflow runs count statistics",
"operationId": "get_advanced_chat_workflow_runs_count",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowRunCountQuery"
}
},
{
"description": "Filter by trigger source (optional): debugging or app-run. Default: debugging",
"name": "triggered_from",
"type": "string",
"in": "query"
},
{
"description": "Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field.",
"name": "time_range",
"type": "string",
"in": "query"
},
{
"description": "Filter by status (optional): running, succeeded, failed, stopped, partial-succeeded",
"name": "status",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/advanced-chat\/workflows\/draft\/iteration\/nodes\/{node_id}\/run": {
"post": {
"responses": {
"404": {
"description": "Node not found"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Iteration node run started successfully"
}
},
"summary": "Run draft workflow iteration node",
"description": "Run draft workflow iteration node for advanced chat",
"operationId": "run_advanced_chat_draft_iteration_node",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/IterationNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/advanced-chat\/workflows\/draft\/loop\/nodes\/{node_id}\/run": {
"post": {
"responses": {
"404": {
"description": "Node not found"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Loop node run started successfully"
}
},
"summary": "Run draft workflow loop node",
"description": "Run draft workflow loop node for advanced chat",
"operationId": "run_advanced_chat_draft_loop_node",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/LoopNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/advanced-chat\/workflows\/draft\/run": {
"post": {
"responses": {
"403": {
"description": "Permission denied"
},
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Workflow run started successfully"
}
},
"summary": "Run draft workflow",
"description": "Run draft workflow for advanced chat application",
"operationId": "run_advanced_chat_draft_workflow",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AdvancedChatWorkflowRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/agent\/logs": {
"get": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Agent logs retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Agent log entries"
}
}
}
},
"summary": "Get agent logs",
"description": "Get agent execution logs for an application",
"operationId": "get_agent_logs",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AgentLogQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotation-reply\/{action}": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Action completed successfully"
}
},
"description": "Enable or disable annotation reply for an app",
"operationId": "annotation_reply_action",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string",
"description": "Action to perform (enable\/disable)"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AnnotationReplyPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotation-reply\/{action}\/status\/{job_id}": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Job status retrieved successfully"
}
},
"description": "Get status of annotation reply action job",
"operationId": "get_annotation_reply_action_status",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string",
"description": "Action type"
},
{
"name": "job_id",
"in": "path",
"required": true,
"type": "string",
"description": "Job ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotation-setting": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Annotation settings retrieved successfully"
}
},
"description": "Get annotation settings for an app",
"operationId": "get_annotation_setting",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotation-settings\/{annotation_setting_id}": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Settings updated successfully"
}
},
"description": "Update annotation settings for an app",
"operationId": "update_annotation_setting",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "annotation_setting_id",
"in": "path",
"required": true,
"type": "string",
"description": "Annotation setting ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AnnotationSettingUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_annotation_api",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"201": {
"description": "Annotation created successfully",
"schema": {
"$ref": "#\/definitions\/Annotation"
}
}
},
"description": "Create a new annotation for an app",
"operationId": "create_annotation",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CreateAnnotationPayload"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Annotations retrieved successfully"
}
},
"description": "Get annotations for an app with pagination",
"operationId": "list_annotations",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AnnotationListQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations\/batch-import": {
"post": {
"responses": {
"429": {
"description": "Too many requests or concurrent imports"
},
"413": {
"description": "File too large"
},
"400": {
"description": "No file uploaded or too many files"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Batch import started successfully"
}
},
"description": "Batch import annotations from CSV file with rate limiting and security checks",
"operationId": "batch_import_annotations",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations\/batch-import-status\/{job_id}": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Job status retrieved successfully"
}
},
"description": "Get status of batch import job",
"operationId": "get_batch_import_status",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "job_id",
"in": "path",
"required": true,
"type": "string",
"description": "Job ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations\/count": {
"get": {
"responses": {
"200": {
"description": "Annotation count retrieved successfully",
"schema": {
"$ref": "#\/definitions\/AnnotationCountResponse"
}
}
},
"description": "Get count of message annotations for the app",
"operationId": "get_annotation_count",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations\/export": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Annotations exported successfully",
"schema": {
"$ref": "#\/definitions\/AnnotationList"
}
}
},
"description": "Export all annotations for an app with CSV injection protection",
"operationId": "export_annotations",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations\/{annotation_id}": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_annotation_update_delete_api",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "annotation_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"204": {
"description": "Annotation deleted successfully"
},
"200": {
"description": "Annotation updated successfully",
"schema": {
"$ref": "#\/definitions\/Annotation"
}
}
},
"description": "Update or delete an annotation",
"operationId": "update_delete_annotation",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "annotation_id",
"in": "path",
"required": true,
"type": "string",
"description": "Annotation ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/UpdateAnnotationPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/annotations\/{annotation_id}\/hit-histories": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Hit histories retrieved successfully",
"schema": {
"$ref": "#\/definitions\/AnnotationHitHistoryList"
}
}
},
"description": "Get hit histories for an annotation",
"operationId": "list_annotation_hit_histories",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "annotation_id",
"in": "path",
"required": true,
"type": "string",
"description": "Annotation ID"
},
{
"name": "page",
"in": "query",
"type": "integer",
"description": "Page number",
"default": 1
},
{
"name": "limit",
"in": "query",
"type": "integer",
"description": "Page size",
"default": 20
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/api-enable": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "API status updated successfully",
"schema": {
"$ref": "#\/definitions\/AppDetail"
}
}
},
"description": "Enable or disable app API",
"operationId": "update_app_api_status",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppApiStatusPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/audio-to-text": {
"post": {
"responses": {
"413": {
"description": "Audio file too large"
},
"400": {
"description": "Bad request - No audio uploaded or unsupported type"
},
"200": {
"description": "Audio transcription successful",
"schema": {
"$ref": "#\/definitions\/AudioTranscriptResponse"
}
}
},
"description": "Transcript audio to text for chat messages",
"operationId": "chat_message_audio_transcript",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "App ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/chat-conversations": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ConversationWithSummaryPagination"
}
}
},
"description": "Get chat conversations with pagination, filtering and summary",
"operationId": "list_chat_conversations",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChatConversationQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/chat-conversations\/{conversation_id}": {
"delete": {
"responses": {
"404": {
"description": "Conversation not found"
},
"403": {
"description": "Insufficient permissions"
},
"204": {
"description": "Conversation deleted successfully"
}
},
"description": "Delete a chat conversation",
"operationId": "delete_chat_conversation",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"type": "string",
"description": "Conversation ID"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"404": {
"description": "Conversation not found"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ConversationDetail"
}
}
},
"description": "Get chat conversation details",
"operationId": "get_chat_conversation",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"type": "string",
"description": "Conversation ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/chat-messages": {
"get": {
"responses": {
"404": {
"description": "Conversation not found"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/MessageInfiniteScrollPagination"
}
}
},
"description": "Get chat messages for a conversation with pagination",
"operationId": "list_chat_messages",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChatMessagesQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/chat-messages\/{message_id}\/suggested-questions": {
"get": {
"responses": {
"404": {
"description": "Message or conversation not found"
},
"200": {
"description": "Suggested questions retrieved successfully",
"schema": {
"$ref": "#\/definitions\/SuggestedQuestionsResponse"
}
}
},
"description": "Get suggested questions for a message",
"operationId": "get_message_suggested_questions",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string",
"description": "Message ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/chat-messages\/{task_id}\/stop": {
"post": {
"responses": {
"200": {
"description": "Task stopped successfully"
}
},
"description": "Stop a running chat message generation",
"operationId": "stop_chat_message",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string",
"description": "Task ID to stop"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/completion-conversations": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ConversationPagination"
}
}
},
"description": "Get completion conversations with pagination and filtering",
"operationId": "list_completion_conversations",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CompletionConversationQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/completion-conversations\/{conversation_id}": {
"delete": {
"responses": {
"404": {
"description": "Conversation not found"
},
"403": {
"description": "Insufficient permissions"
},
"204": {
"description": "Conversation deleted successfully"
}
},
"description": "Delete a completion conversation",
"operationId": "delete_completion_conversation",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"type": "string",
"description": "Conversation ID"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"404": {
"description": "Conversation not found"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ConversationMessageDetail"
}
}
},
"description": "Get completion conversation details with messages",
"operationId": "get_completion_conversation",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "conversation_id",
"in": "path",
"required": true,
"type": "string",
"description": "Conversation ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/completion-messages": {
"post": {
"responses": {
"404": {
"description": "App not found"
},
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Completion generated successfully"
}
},
"description": "Generate completion message for debugging",
"operationId": "create_completion_message",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CompletionMessagePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/completion-messages\/{task_id}\/stop": {
"post": {
"responses": {
"200": {
"description": "Task stopped successfully"
}
},
"description": "Stop a running completion message generation",
"operationId": "stop_completion_message",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string",
"description": "Task ID to stop"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/conversation-variables": {
"get": {
"responses": {
"200": {
"description": "Conversation variables retrieved successfully",
"schema": {
"$ref": "#\/definitions\/PaginatedConversationVariable"
}
}
},
"description": "Get conversation variables for an application",
"operationId": "get_conversation_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ConversationVariablesQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/convert-to-workflow": {
"post": {
"responses": {
"403": {
"description": "Permission denied"
},
"400": {
"description": "Application cannot be converted"
},
"200": {
"description": "Application converted to workflow successfully"
}
},
"summary": "Convert basic mode of chatbot app to workflow mode",
"description": "Convert application to workflow mode\nConvert expert mode of chatbot app to workflow mode\nConvert Completion App to Workflow App",
"operationId": "convert_to_workflow",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ConvertToWorkflowPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/copy": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"201": {
"description": "App copied successfully",
"schema": {
"$ref": "#\/definitions\/AppDetailWithSite"
}
}
},
"summary": "Copy app",
"description": "Create a copy of an existing application",
"operationId": "copy_app",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID to copy"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CopyAppPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/export": {
"get": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "App exported successfully",
"schema": {
"$ref": "#\/definitions\/AppExportResponse"
}
}
},
"summary": "Export app",
"description": "Export application configuration as DSL",
"operationId": "export_app",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID to export"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppExportQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/feedbacks": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"404": {
"description": "Message not found"
},
"200": {
"description": "Feedback updated successfully"
}
},
"description": "Create or update message feedback (like\/dislike)",
"operationId": "create_message_feedback",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MessageFeedbackPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/feedbacks\/export": {
"get": {
"responses": {
"500": {
"description": "Internal server error"
},
"400": {
"description": "Invalid parameters"
},
"200": {
"description": "Feedback data exported successfully"
}
},
"description": "Export user feedback data for Google Sheets",
"operationId": "export_feedbacks",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/FeedbackExportQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/icon": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Icon updated successfully"
}
},
"description": "Update application icon",
"operationId": "update_app_icon",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppIconPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/messages\/{message_id}": {
"get": {
"responses": {
"404": {
"description": "Message not found"
},
"200": {
"description": "Message retrieved successfully",
"schema": {
"$ref": "#\/definitions\/MessageDetail"
}
}
},
"description": "Get message details by ID",
"operationId": "get_message",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string",
"description": "Message ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/model-config": {
"post": {
"responses": {
"404": {
"description": "App not found"
},
"400": {
"description": "Invalid configuration"
},
"200": {
"description": "Model configuration updated successfully"
}
},
"summary": "Modify app model config",
"description": "Update application model configuration",
"operationId": "update_app_model_config",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ModelConfigRequest"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/name": {
"post": {
"responses": {
"200": {
"description": "Name availability checked",
"schema": {
"$ref": "#\/definitions\/AppDetail"
}
}
},
"description": "Check if app name is available",
"operationId": "check_app_name",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppNamePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/server": {
"get": {
"responses": {
"200": {
"description": "MCP server configuration retrieved successfully",
"schema": {
"$ref": "#\/definitions\/AppServer"
}
}
},
"description": "Get MCP server configuration for an application",
"operationId": "get_app_mcp_server",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"201": {
"description": "MCP server configuration created successfully",
"schema": {
"$ref": "#\/definitions\/AppServer"
}
}
},
"description": "Create MCP server configuration for an application",
"operationId": "create_app_mcp_server",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MCPServerCreatePayload"
}
}
],
"tags": [
"console"
]
},
"put": {
"responses": {
"404": {
"description": "Server not found"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "MCP server configuration updated successfully",
"schema": {
"$ref": "#\/definitions\/AppServer"
}
}
},
"description": "Update MCP server configuration for an application",
"operationId": "update_app_mcp_server",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MCPServerUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/site": {
"post": {
"responses": {
"404": {
"description": "App not found"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Site configuration updated successfully",
"schema": {
"$ref": "#\/definitions\/AppSite"
}
}
},
"description": "Update application site configuration",
"operationId": "update_app_site",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppSiteUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/site-enable": {
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Site status updated successfully",
"schema": {
"$ref": "#\/definitions\/AppDetail"
}
}
},
"description": "Enable or disable app site",
"operationId": "update_app_site_status",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppSiteStatusPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/site\/access-token-reset": {
"post": {
"responses": {
"404": {
"description": "App or site not found"
},
"403": {
"description": "Insufficient permissions (admin\/owner required)"
},
"200": {
"description": "Access token reset successfully",
"schema": {
"$ref": "#\/definitions\/AppSite"
}
}
},
"description": "Reset access token for application site",
"operationId": "reset_app_site_access_token",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/average-response-time": {
"get": {
"responses": {
"200": {
"description": "Average response time statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Average response time data"
}
}
}
},
"description": "Get average response time statistics for an application",
"operationId": "get_average_response_time_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/average-session-interactions": {
"get": {
"responses": {
"200": {
"description": "Average session interaction statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Average session interaction data"
}
}
}
},
"description": "Get average session interaction statistics for an application",
"operationId": "get_average_session_interaction_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/daily-conversations": {
"get": {
"responses": {
"200": {
"description": "Daily conversation statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Daily conversation count data"
}
}
}
},
"description": "Get daily conversation statistics for an application",
"operationId": "get_daily_conversation_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/daily-end-users": {
"get": {
"responses": {
"200": {
"description": "Daily terminal statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Daily terminal count data"
}
}
}
},
"description": "Get daily terminal\/end-user statistics for an application",
"operationId": "get_daily_terminals_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/daily-messages": {
"get": {
"responses": {
"200": {
"description": "Daily message statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Daily message count data"
}
}
}
},
"description": "Get daily message statistics for an application",
"operationId": "get_daily_message_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/token-costs": {
"get": {
"responses": {
"200": {
"description": "Daily token cost statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Daily token cost data"
}
}
}
},
"description": "Get daily token cost statistics for an application",
"operationId": "get_daily_token_cost_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/tokens-per-second": {
"get": {
"responses": {
"200": {
"description": "Tokens per second statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Tokens per second data"
}
}
}
},
"description": "Get tokens per second statistics for an application",
"operationId": "get_tokens_per_second_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/statistics\/user-satisfaction-rate": {
"get": {
"responses": {
"200": {
"description": "User satisfaction rate statistics retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "User satisfaction rate data"
}
}
}
},
"description": "Get user satisfaction rate statistics for an application",
"operationId": "get_user_satisfaction_rate_statistics",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/StatisticTimeRangeQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/text-to-audio": {
"post": {
"responses": {
"400": {
"description": "Bad request - Invalid parameters"
},
"200": {
"description": "Text to speech conversion successful"
}
},
"description": "Convert text to speech for chat messages",
"operationId": "chat_message_text_to_speech",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "App ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TextToSpeechPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/text-to-audio\/voices": {
"get": {
"responses": {
"400": {
"description": "Invalid language parameter"
},
"200": {
"description": "TTS voices retrieved successfully",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Available voices"
}
}
}
},
"description": "Get available TTS voices for a specific language",
"operationId": "get_text_to_speech_voices",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "App ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TextToSpeechVoiceQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/trace": {
"get": {
"responses": {
"200": {
"description": "Trace configuration retrieved successfully"
}
},
"summary": "Get app trace",
"description": "Get app tracing configuration",
"operationId": "get_app_trace",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "Trace configuration updated successfully"
}
},
"description": "Update app tracing configuration",
"operationId": "update_app_trace",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/AppTracePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/trace-config": {
"delete": {
"responses": {
"400": {
"description": "Invalid request parameters or configuration not found"
},
"204": {
"description": "Tracing configuration deleted successfully"
}
},
"summary": "Delete an existing trace app configuration",
"description": "Delete an existing tracing configuration for an application",
"operationId": "delete_trace_app_config",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TraceProviderQuery"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"400": {
"description": "Invalid request parameters or configuration already exists"
},
"201": {
"description": "Tracing configuration created successfully",
"schema": {
"type": "object",
"description": "Created configuration data"
}
}
},
"summary": "Create a new trace app configuration",
"description": "Create a new tracing configuration for an application",
"operationId": "create_trace_app_config",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TraceConfigPayload"
}
}
],
"tags": [
"console"
]
},
"patch": {
"responses": {
"400": {
"description": "Invalid request parameters or configuration not found"
},
"200": {
"description": "Tracing configuration updated successfully",
"schema": {
"type": "object",
"description": "Success response"
}
}
},
"summary": "Update an existing trace app configuration",
"description": "Update an existing tracing configuration for an application",
"operationId": "update_trace_app_config",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TraceConfigPayload"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Tracing configuration retrieved successfully",
"schema": {
"type": "object",
"description": "Tracing configuration data"
}
}
},
"description": "Get tracing configuration for an application",
"operationId": "get_trace_app_config",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TraceProviderQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/trigger-enable": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Update app trigger (enable\/disable)",
"operationId": "post_app_trigger_enable_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserEnable"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/triggers": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get app triggers list",
"operationId": "get_app_triggers_api",
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-app-logs": {
"get": {
"responses": {
"200": {
"description": "Workflow app logs retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowAppLogPagination"
}
}
},
"summary": "Get workflow app logs",
"description": "Get workflow application execution logs",
"operationId": "get_workflow_app_logs",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowAppLogQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-archived-logs": {
"get": {
"responses": {
"200": {
"description": "Workflow archived logs retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowArchivedLogPagination"
}
}
},
"summary": "Get workflow archived logs",
"description": "Get workflow archived execution logs",
"operationId": "get_workflow_archived_logs",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowAppLogQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-runs": {
"get": {
"responses": {
"200": {
"description": "Workflow runs retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunPagination"
}
}
},
"summary": "Get workflow run list",
"description": "Get workflow run list",
"operationId": "get_workflow_runs",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowRunListQuery"
}
},
{
"description": "Filter by trigger source (optional): debugging or app-run. Default: debugging",
"name": "triggered_from",
"type": "string",
"in": "query"
},
{
"description": "Filter by status (optional): running, succeeded, failed, stopped, partial-succeeded",
"name": "status",
"type": "string",
"in": "query"
},
{
"description": "Last run ID for pagination",
"name": "last_id",
"type": "string",
"in": "query"
},
{
"description": "Number of items per page (1-100)",
"name": "limit",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-runs\/count": {
"get": {
"responses": {
"200": {
"description": "Workflow runs count retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunCount"
}
}
},
"summary": "Get workflow runs count statistics",
"description": "Get workflow runs count statistics",
"operationId": "get_workflow_runs_count",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowRunCountQuery"
}
},
{
"description": "Filter by trigger source (optional): debugging or app-run. Default: debugging",
"name": "triggered_from",
"type": "string",
"in": "query"
},
{
"description": "Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field.",
"name": "time_range",
"type": "string",
"in": "query"
},
{
"description": "Filter by status (optional): running, succeeded, failed, stopped, partial-succeeded",
"name": "status",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-runs\/tasks\/{task_id}\/stop": {
"post": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Task not found"
},
"200": {
"description": "Task stopped successfully"
}
},
"summary": "Stop workflow task",
"description": "Stop running workflow task",
"operationId": "stop_workflow_task",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string",
"description": "Task ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-runs\/{run_id}": {
"get": {
"responses": {
"404": {
"description": "Workflow run not found"
},
"200": {
"description": "Workflow run detail retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunDetail"
}
}
},
"summary": "Get workflow run detail",
"description": "Get workflow run detail",
"operationId": "get_workflow_run_detail",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "run_id",
"in": "path",
"required": true,
"type": "string",
"description": "Workflow run ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-runs\/{run_id}\/export": {
"get": {
"responses": {
"200": {
"description": "Export URL generated",
"schema": {
"$ref": "#\/definitions\/WorkflowRunExport"
}
}
},
"description": "Generate a download URL for an archived workflow run.",
"operationId": "get_workflow_run_export_url",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "run_id",
"in": "path",
"required": true,
"type": "string",
"description": "Workflow run ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow-runs\/{run_id}\/node-executions": {
"get": {
"responses": {
"404": {
"description": "Workflow run not found"
},
"200": {
"description": "Node executions retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunNodeExecutionList"
}
}
},
"summary": "Get workflow run node execution list",
"description": "Get workflow run node execution list",
"operationId": "get_workflow_run_node_executions",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "run_id",
"in": "path",
"required": true,
"type": "string",
"description": "Workflow run ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow\/statistics\/average-app-interactions": {
"get": {
"responses": {
"200": {
"description": "Average app interaction statistics retrieved successfully"
}
},
"description": "Get workflow average app interaction statistics",
"operationId": "get_workflow_average_app_interaction_statistic",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowStatisticQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow\/statistics\/daily-conversations": {
"get": {
"responses": {
"200": {
"description": "Daily runs statistics retrieved successfully"
}
},
"description": "Get workflow daily runs statistics",
"operationId": "get_workflow_daily_runs_statistic",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowStatisticQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow\/statistics\/daily-terminals": {
"get": {
"responses": {
"200": {
"description": "Daily terminals statistics retrieved successfully"
}
},
"description": "Get workflow daily terminals statistics",
"operationId": "get_workflow_daily_terminals_statistic",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowStatisticQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflow\/statistics\/token-costs": {
"get": {
"responses": {
"200": {
"description": "Daily token cost statistics retrieved successfully"
}
},
"description": "Get workflow daily token cost statistics",
"operationId": "get_workflow_daily_token_cost_statistic",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowStatisticQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows": {
"get": {
"responses": {
"200": {
"description": "Published workflows retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowPagination"
}
}
},
"summary": "Get published workflows",
"description": "Get all published workflows for an application",
"operationId": "get_all_published_workflows",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowListQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/default-workflow-block-configs": {
"get": {
"responses": {
"200": {
"description": "Default block configurations retrieved successfully"
}
},
"summary": "Get default block config",
"description": "Get default block configurations for workflow",
"operationId": "get_default_block_configs",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/default-workflow-block-configs\/{block_type}": {
"get": {
"responses": {
"404": {
"description": "Block type not found"
},
"200": {
"description": "Default block configuration retrieved successfully"
}
},
"summary": "Get default block config",
"description": "Get default block configuration by type",
"operationId": "get_default_block_config",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "block_type",
"in": "path",
"required": true,
"type": "string",
"description": "Block type"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DefaultBlockConfigQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft": {
"get": {
"responses": {
"404": {
"description": "Draft workflow not found"
},
"200": {
"description": "Draft workflow retrieved successfully",
"schema": {
"$ref": "#\/definitions\/Workflow"
}
}
},
"summary": "Get draft workflow",
"description": "Get draft workflow for an application",
"operationId": "get_draft_workflow",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"403": {
"description": "Permission denied"
},
"400": {
"description": "Invalid workflow configuration"
},
"200": {
"description": "Draft workflow synced successfully",
"schema": {
"$ref": "#\/definitions\/SyncDraftWorkflowResponse"
}
}
},
"summary": "Sync draft workflow",
"description": "Sync draft workflow configuration",
"operationId": "sync_draft_workflow",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SyncDraftWorkflowPayload"
}
},
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/conversation-variables": {
"get": {
"responses": {
"404": {
"description": "Draft workflow not found"
},
"200": {
"description": "Conversation variables retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariableList"
}
}
},
"description": "Get conversation variables for workflow",
"operationId": "get_conversation_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/environment-variables": {
"get": {
"responses": {
"404": {
"description": "Draft workflow not found"
},
"200": {
"description": "Environment variables retrieved successfully"
}
},
"summary": "Get draft workflow",
"description": "Get environment variables for workflow",
"operationId": "get_environment_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/iteration\/nodes\/{node_id}\/run": {
"post": {
"responses": {
"404": {
"description": "Node not found"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Workflow iteration node run started successfully"
}
},
"summary": "Run draft workflow iteration node",
"description": "Run draft workflow iteration node",
"operationId": "run_workflow_draft_iteration_node",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/IterationNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/loop\/nodes\/{node_id}\/run": {
"post": {
"responses": {
"404": {
"description": "Node not found"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Workflow loop node run started successfully"
}
},
"summary": "Run draft workflow loop node",
"description": "Run draft workflow loop node",
"operationId": "run_workflow_draft_loop_node",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/LoopNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/nodes\/{node_id}\/last-run": {
"get": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Node last run not found"
},
"200": {
"description": "Node last run retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunNodeExecution"
}
}
},
"description": "Get last run result for draft workflow node",
"operationId": "get_draft_workflow_node_last_run",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/nodes\/{node_id}\/run": {
"post": {
"responses": {
"404": {
"description": "Node not found"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Node run started successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowRunNodeExecution"
}
}
},
"summary": "Run draft workflow node",
"description": "Run draft workflow node",
"operationId": "run_draft_workflow_node",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DraftWorkflowNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/nodes\/{node_id}\/trigger\/run": {
"post": {
"responses": {
"500": {
"description": "Internal server error"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Trigger event received and node executed successfully"
}
},
"summary": "Poll for trigger events and execute single node when event arrives",
"description": "Poll for trigger events and execute single node when event arrives",
"operationId": "poll_draft_workflow_trigger_node",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/nodes\/{node_id}\/variables": {
"delete": {
"responses": {
"204": {
"description": "Node variables deleted successfully"
}
},
"description": "Delete all variables for a specific node",
"operationId": "delete_node_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Node variables retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariableList"
}
}
},
"description": "Get variables for a specific node",
"operationId": "get_node_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string",
"description": "Node ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/run": {
"post": {
"responses": {
"403": {
"description": "Permission denied"
},
"200": {
"description": "Draft workflow run started successfully"
}
},
"summary": "Run draft workflow",
"description": "Run draft workflow",
"operationId": "run_draft_workflow",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DraftWorkflowRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/system-variables": {
"get": {
"responses": {
"200": {
"description": "System variables retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariableList"
}
}
},
"description": "Get system variables for workflow",
"operationId": "get_system_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/trigger\/run": {
"post": {
"responses": {
"500": {
"description": "Internal server error"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Trigger event received and workflow executed successfully"
}
},
"summary": "Poll for trigger events and execute full workflow when event arrives",
"description": "Poll for trigger events and execute full workflow when event arrives",
"operationId": "poll_draft_workflow_trigger_run",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DraftWorkflowTriggerRunRequest"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/trigger\/run-all": {
"post": {
"responses": {
"500": {
"description": "Internal server error"
},
"403": {
"description": "Permission denied"
},
"200": {
"description": "Workflow executed successfully"
}
},
"summary": "Full workflow debug when the start node is a trigger",
"description": "Full workflow debug when the start node is a trigger",
"operationId": "draft_workflow_trigger_run_all",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DraftWorkflowTriggerRunAllPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/variables": {
"delete": {
"responses": {
"204": {
"description": "Workflow variables deleted successfully"
}
},
"description": "Delete all draft workflow variables",
"operationId": "delete_workflow_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Workflow variables retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariableListWithoutValue"
}
}
},
"summary": "Get draft workflow",
"description": "Get draft workflow variables",
"operationId": "get_workflow_variables",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariableListQuery"
}
},
{
"description": "Page number (1-100000)",
"name": "page",
"type": "string",
"in": "query"
},
{
"description": "Number of items per page (1-100)",
"name": "limit",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/variables\/{variable_id}": {
"delete": {
"responses": {
"404": {
"description": "Variable not found"
},
"204": {
"description": "Variable deleted successfully"
}
},
"description": "Delete a workflow variable",
"operationId": "delete_variable",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variable_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"patch": {
"responses": {
"404": {
"description": "Variable not found"
},
"200": {
"description": "Variable updated successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariable"
}
}
},
"description": "Update a workflow variable",
"operationId": "update_variable",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariableUpdatePayload"
}
},
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variable_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"404": {
"description": "Variable not found"
},
"200": {
"description": "Variable retrieved successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariable"
}
}
},
"description": "Get a specific workflow variable",
"operationId": "get_variable",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "variable_id",
"in": "path",
"required": true,
"type": "string",
"description": "Variable ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/draft\/variables\/{variable_id}\/reset": {
"put": {
"responses": {
"404": {
"description": "Variable not found"
},
"204": {
"description": "Variable reset (no content)"
},
"200": {
"description": "Variable reset successfully",
"schema": {
"$ref": "#\/definitions\/WorkflowDraftVariable"
}
}
},
"description": "Reset a workflow variable to its default value",
"operationId": "reset_variable",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "variable_id",
"in": "path",
"required": true,
"type": "string",
"description": "Variable ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/publish": {
"get": {
"responses": {
"404": {
"description": "Published workflow not found"
},
"200": {
"description": "Published workflow retrieved successfully",
"schema": {
"$ref": "#\/definitions\/Workflow"
}
}
},
"summary": "Get published workflow",
"description": "Get published workflow for an application",
"operationId": "get_published_workflow",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Publish workflow",
"operationId": "post_published_workflow_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/PublishWorkflowPayload"
}
},
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/triggers\/webhook": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get webhook trigger for a node",
"operationId": "get_webhook_trigger_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/Parser"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{app_id}\/workflows\/{workflow_id}": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Delete workflow",
"operationId": "delete_workflow_by_id_api",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"patch": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Workflow not found"
},
"200": {
"description": "Workflow updated successfully",
"schema": {
"$ref": "#\/definitions\/Workflow"
}
}
},
"summary": "Update workflow attributes",
"description": "Update workflow by ID",
"operationId": "update_workflow_by_id",
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string",
"description": "Application ID"
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"type": "string",
"description": "Workflow ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/apps\/{resource_id}\/api-keys": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ApiKeyList"
}
}
},
"summary": "Get all API keys for an app",
"description": "Get all API keys for an app",
"operationId": "get_app_api_keys",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"type": "string",
"description": "App ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"400": {
"description": "Maximum keys exceeded"
},
"201": {
"description": "API key created successfully",
"schema": {
"$ref": "#\/definitions\/ApiKeyItem"
}
}
},
"summary": "Create a new API key for an app",
"description": "Create a new API key for an app",
"operationId": "create_app_api_key",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"type": "string",
"description": "App ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{resource_id}\/api-keys\/{api_key_id}": {
"delete": {
"responses": {
"204": {
"description": "API key deleted successfully"
}
},
"summary": "Delete an API key for an app",
"description": "Delete an API key for an app",
"operationId": "delete_app_api_key",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"type": "string",
"description": "App ID"
},
{
"name": "api_key_id",
"in": "path",
"required": true,
"type": "string",
"description": "API key ID"
}
],
"tags": [
"console"
]
}
},
"\/apps\/{server_id}\/server\/refresh": {
"get": {
"responses": {
"404": {
"description": "Server not found"
},
"403": {
"description": "Insufficient permissions"
},
"200": {
"description": "MCP server refreshed successfully",
"schema": {
"$ref": "#\/definitions\/AppServer"
}
}
},
"description": "Refresh MCP server configuration and regenerate server code",
"operationId": "refresh_app_mcp_server",
"parameters": [
{
"name": "server_id",
"in": "path",
"required": true,
"type": "string",
"description": "Server ID"
}
],
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/default-list": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_datasource_hard_code_auth_list_api",
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/list": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_datasource_auth_list_api",
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/{provider_id}": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_datasource_auth",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_datasource_auth",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceCredentialPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/{provider_id}\/custom-client": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_datasource_auth_oauth_custom_client",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_datasource_auth_oauth_custom_client",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceCustomClientPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/{provider_id}\/default": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_datasource_auth_default_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceDefaultPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/{provider_id}\/delete": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_datasource_auth_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceCredentialDeletePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/{provider_id}\/update": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_datasource_auth_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceCredentialUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/auth\/plugin\/datasource\/{provider_id}\/update-name": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_datasource_update_provider_name_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceUpdateNamePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/billing\/invoices": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_invoices",
"tags": [
"console"
]
}
},
"\/billing\/partners\/{partner_key}\/tenants": {
"put": {
"responses": {
"400": {
"description": "Invalid partner information"
},
"200": {
"description": "Tenants synced to partner successfully"
}
},
"description": "Sync partner tenants bindings",
"operationId": "sync_partner_tenants_bindings",
"parameters": [
{
"name": "partner_key",
"in": "path",
"required": true,
"type": "string",
"description": "Partner key"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SyncPartnerTenantsBindingsRequest"
}
}
],
"tags": [
"console"
]
}
},
"\/billing\/subscription": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_subscription",
"tags": [
"console"
]
}
},
"\/code-based-extension": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/CodeBasedExtensionResponse"
}
}
},
"description": "Get code-based extension data by module name",
"operationId": "get_code_based_extension",
"parameters": [
{
"description": "Extension module name",
"name": "module",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/compliance\/download": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"description": "Get compliance document download link",
"operationId": "download_compliance_document",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ComplianceDownloadQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/data-source\/integrates": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_data_source_api",
"tags": [
"console"
]
}
},
"\/data-source\/integrates\/{binding_id}\/{action}": {
"parameters": [
{
"name": "binding_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_data_source_api",
"tags": [
"console"
]
}
},
"\/datasets": {
"get": {
"responses": {
"200": {
"description": "Datasets retrieved successfully"
}
},
"description": "Get list of datasets",
"operationId": "get_datasets",
"parameters": [
{
"description": "Page number (default: 1)",
"name": "page",
"type": "string",
"in": "query"
},
{
"description": "Number of items per page (default: 20)",
"name": "limit",
"type": "string",
"in": "query"
},
{
"description": "Filter by dataset IDs (list)",
"name": "ids",
"type": "string",
"in": "query"
},
{
"description": "Search keyword",
"name": "keyword",
"type": "string",
"in": "query"
},
{
"description": "Filter by tag IDs (list)",
"name": "tag_ids",
"type": "string",
"in": "query"
},
{
"description": "Include all datasets (default: false)",
"name": "include_all",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"201": {
"description": "Dataset created successfully"
}
},
"description": "Create a new dataset",
"operationId": "create_dataset",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasetCreatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/api-base-info": {
"get": {
"responses": {
"200": {
"description": "API base info retrieved successfully"
}
},
"description": "Get dataset API base information",
"operationId": "get_dataset_api_base_info",
"tags": [
"console"
]
}
},
"\/datasets\/api-keys": {
"get": {
"responses": {
"200": {
"description": "API keys retrieved successfully",
"schema": {
"$ref": "#\/definitions\/ApiKeyList"
}
}
},
"description": "Get dataset API keys",
"operationId": "get_dataset_api_keys",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_api_key_api",
"tags": [
"console"
]
}
},
"\/datasets\/api-keys\/{api_key_id}": {
"delete": {
"responses": {
"204": {
"description": "API key deleted successfully"
}
},
"description": "Delete dataset API key",
"operationId": "delete_dataset_api_key",
"parameters": [
{
"name": "api_key_id",
"in": "path",
"required": true,
"type": "string",
"description": "API key ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/batch_import_status\/{job_id}": {
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_document_segment_batch_import_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_document_segment_batch_import_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/BatchImportPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/external": {
"post": {
"responses": {
"403": {
"description": "Permission denied"
},
"400": {
"description": "Invalid parameters"
},
"201": {
"description": "External dataset created successfully",
"schema": {
"$ref": "#\/definitions\/DatasetDetail"
}
}
},
"description": "Create external knowledge dataset",
"operationId": "create_external_dataset",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ExternalDatasetCreatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/external-knowledge-api": {
"get": {
"responses": {
"200": {
"description": "External API templates retrieved successfully"
}
},
"description": "Get external knowledge API templates",
"operationId": "get_external_api_templates",
"parameters": [
{
"description": "Page number (default: 1)",
"name": "page",
"type": "string",
"in": "query"
},
{
"description": "Number of items per page (default: 20)",
"name": "limit",
"type": "string",
"in": "query"
},
{
"description": "Search keyword",
"name": "keyword",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_external_api_template_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ExternalKnowledgeApiPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/external-knowledge-api\/{external_knowledge_api_id}": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_external_api_template_api",
"parameters": [
{
"name": "external_knowledge_api_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_external_api_template_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ExternalKnowledgeApiPayload"
}
},
{
"name": "external_knowledge_api_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"404": {
"description": "Template not found"
},
"200": {
"description": "External API template retrieved successfully"
}
},
"description": "Get external knowledge API template details",
"operationId": "get_external_api_template",
"parameters": [
{
"name": "external_knowledge_api_id",
"in": "path",
"required": true,
"type": "string",
"description": "External knowledge API ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/external-knowledge-api\/{external_knowledge_api_id}\/use-check": {
"get": {
"responses": {
"200": {
"description": "Usage check completed successfully"
}
},
"description": "Check if external knowledge API is being used",
"operationId": "check_external_api_usage",
"parameters": [
{
"name": "external_knowledge_api_id",
"in": "path",
"required": true,
"type": "string",
"description": "External knowledge API ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/indexing-estimate": {
"post": {
"responses": {
"200": {
"description": "Indexing estimate calculated successfully"
}
},
"description": "Estimate dataset indexing cost",
"operationId": "estimate_dataset_indexing",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/IndexingEstimatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/init": {
"post": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"201": {
"description": "Dataset initialized successfully",
"schema": {
"$ref": "#\/definitions\/DatasetAndDocument"
}
}
},
"description": "Initialize dataset with documents",
"operationId": "init_dataset",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/KnowledgeConfig"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/metadata\/built-in": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_metadata_built_in_field_api",
"tags": [
"console"
]
}
},
"\/datasets\/notion-indexing-estimate": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_notion_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_data_source_notion_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/NotionEstimatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/process-rule": {
"get": {
"responses": {
"200": {
"description": "Process rules retrieved successfully"
}
},
"description": "Get dataset document processing rules",
"operationId": "get_process_rule",
"parameters": [
{
"description": "Document ID (optional)",
"name": "document_id",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/retrieval-setting": {
"get": {
"responses": {
"200": {
"description": "Retrieval settings retrieved successfully"
}
},
"description": "Get dataset retrieval settings",
"operationId": "get_dataset_retrieval_setting",
"tags": [
"console"
]
}
},
"\/datasets\/retrieval-setting\/{vector_type}": {
"get": {
"responses": {
"200": {
"description": "Mock retrieval settings retrieved successfully"
}
},
"description": "Get mock dataset retrieval settings by vector type",
"operationId": "get_dataset_retrieval_setting_mock",
"parameters": [
{
"name": "vector_type",
"in": "path",
"required": true,
"type": "string",
"description": "Vector store type"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_dataset_api",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"patch": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Dataset not found"
},
"200": {
"description": "Dataset updated successfully",
"schema": {
"$ref": "#\/definitions\/DatasetDetail"
}
}
},
"description": "Update dataset details",
"operationId": "update_dataset",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasetUpdatePayload"
}
},
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Dataset not found"
},
"200": {
"description": "Dataset retrieved successfully",
"schema": {
"$ref": "#\/definitions\/DatasetDetail"
}
}
},
"description": "Get dataset details",
"operationId": "get_dataset",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/api-keys\/{status}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "status",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_enable_api_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/auto-disable-logs": {
"get": {
"responses": {
"404": {
"description": "Dataset not found"
},
"200": {
"description": "Auto disable logs retrieved successfully"
}
},
"description": "Get dataset auto disable logs",
"operationId": "get_dataset_auto_disable_logs",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/batch\/{batch}\/indexing-estimate": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "batch",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_document_batch_indexing_estimate_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/batch\/{batch}\/indexing-status": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "batch",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_document_batch_indexing_status_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_dataset_document_list_api",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_document_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/KnowledgeConfig"
}
},
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Documents retrieved successfully"
}
},
"description": "Get documents in a dataset",
"operationId": "get_dataset_documents",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"description": "Page number (default: 1)",
"name": "page",
"type": "string",
"in": "query"
},
{
"description": "Number of items per page (default: 20)",
"name": "limit",
"type": "string",
"in": "query"
},
{
"description": "Search keyword",
"name": "keyword",
"type": "string",
"in": "query"
},
{
"description": "Sort order (default: -created_at)",
"name": "sort",
"type": "string",
"in": "query"
},
{
"description": "Fetch full details (default: false)",
"name": "fetch",
"type": "string",
"in": "query"
},
{
"description": "Filter documents by display status",
"name": "status",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/download-zip": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Stream a ZIP archive containing the requested uploaded documents",
"description": "Download selected dataset documents as a single ZIP archive (upload-file only)",
"operationId": "download_dataset_documents_as_zip",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DocumentBatchDownloadZipPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/metadata": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_document_metadata_edit_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MetadataOperationData"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/status\/{action}\/batch": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_document_status_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_document_api",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"404": {
"description": "Document not found"
},
"200": {
"description": "Document retrieved successfully"
}
},
"description": "Get document details",
"operationId": "get_document",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string",
"description": "Document ID"
},
{
"description": "Metadata inclusion (all\/only\/without)",
"name": "metadata",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/download": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"description": "Get a signed download URL for a dataset document's original uploaded file",
"operationId": "get_dataset_document_download_url",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/indexing-estimate": {
"get": {
"responses": {
"400": {
"description": "Document already finished"
},
"404": {
"description": "Document not found"
},
"200": {
"description": "Indexing estimate calculated successfully"
}
},
"description": "Estimate document indexing cost",
"operationId": "estimate_document_indexing",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string",
"description": "Document ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/indexing-status": {
"get": {
"responses": {
"404": {
"description": "Document not found"
},
"200": {
"description": "Indexing status retrieved successfully"
}
},
"description": "Get document indexing status",
"operationId": "get_document_indexing_status",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string",
"description": "Document ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/metadata": {
"put": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Document not found"
},
"200": {
"description": "Document metadata updated successfully"
}
},
"description": "Update document metadata",
"operationId": "update_document_metadata",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string",
"description": "Document ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/UpdateDocumentMetadataRequest"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/notion\/sync": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_notion_document_sync_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/pipeline-execution-log": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_document_pipeline_execution_log_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/processing\/pause": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "pause document",
"operationId": "patch_document_pause_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/processing\/resume": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "recover document",
"operationId": "patch_document_recover_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/processing\/{action}": {
"patch": {
"responses": {
"400": {
"description": "Invalid action"
},
"404": {
"description": "Document not found"
},
"200": {
"description": "Processing status updated successfully"
}
},
"description": "Update document processing status (pause\/resume)",
"operationId": "update_document_processing",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string",
"description": "Document ID"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string",
"description": "Action to perform (pause\/resume)"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/rename": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_document_rename_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DocumentRenamePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segment": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_document_segment_add_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SegmentCreatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segment\/{action}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_dataset_document_segment_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segments": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_dataset_document_segment_list_api",
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_document_segment_list_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segments\/batch_import": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_document_segment_batch_import_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_document_segment_batch_import_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/BatchImportPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segments\/{segment_id}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "segment_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_dataset_document_segment_update_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_dataset_document_segment_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SegmentUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segments\/{segment_id}\/child_chunks": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "segment_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_child_chunk_add_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_child_chunk_add_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChildChunkCreatePayload"
}
}
],
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_child_chunk_add_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/segments\/{segment_id}\/child_chunks\/{child_chunk_id}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "segment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "child_chunk_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_child_chunk_update_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_child_chunk_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChildChunkUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/documents\/{document_id}\/website-sync": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "document_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "sync website document",
"operationId": "get_website_document_sync_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/error-docs": {
"get": {
"responses": {
"404": {
"description": "Dataset not found"
},
"200": {
"description": "Error documents retrieved successfully"
}
},
"description": "Get dataset error documents",
"operationId": "get_dataset_error_docs",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/external-hit-testing": {
"post": {
"responses": {
"400": {
"description": "Invalid parameters"
},
"404": {
"description": "Dataset not found"
},
"200": {
"description": "External hit testing completed successfully"
}
},
"description": "Test external knowledge retrieval for dataset",
"operationId": "test_external_knowledge_retrieval",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ExternalHitTestingPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/hit-testing": {
"post": {
"responses": {
"400": {
"description": "Invalid parameters"
},
"404": {
"description": "Dataset not found"
},
"200": {
"description": "Hit testing completed successfully"
}
},
"description": "Test dataset knowledge retrieval",
"operationId": "test_dataset_retrieval",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/HitTestingPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/indexing-status": {
"get": {
"responses": {
"200": {
"description": "Indexing status retrieved successfully"
}
},
"description": "Get dataset indexing status",
"operationId": "get_dataset_indexing_status",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/metadata": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_metadata_create_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_metadata_create_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MetadataArgs"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/metadata\/built-in\/{action}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "action",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_dataset_metadata_built_in_field_action_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/metadata\/{metadata_id}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "metadata_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_dataset_metadata_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_dataset_metadata_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MetadataUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/notion\/sync": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_notion_dataset_sync_api",
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/permission-part-users": {
"get": {
"responses": {
"403": {
"description": "Permission denied"
},
"404": {
"description": "Dataset not found"
},
"200": {
"description": "Permission users retrieved successfully"
}
},
"description": "Get dataset permission user list",
"operationId": "get_dataset_permission_users",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/queries": {
"get": {
"responses": {
"200": {
"description": "Query history retrieved successfully",
"schema": {
"$ref": "#\/definitions\/DatasetQueryDetail"
}
}
},
"description": "Get dataset query history",
"operationId": "get_dataset_queries",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/related-apps": {
"get": {
"responses": {
"200": {
"description": "Related apps retrieved successfully",
"schema": {
"$ref": "#\/definitions\/RelatedAppList"
}
}
},
"description": "Get applications related to dataset",
"operationId": "get_dataset_related_apps",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/retry": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "retry document",
"operationId": "post_document_retry_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DocumentRetryPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{dataset_id}\/use-check": {
"get": {
"responses": {
"200": {
"description": "Dataset use status retrieved successfully"
}
},
"description": "Check if dataset is in use",
"operationId": "check_dataset_use",
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{resource_id}\/api-keys": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/ApiKeyList"
}
}
},
"summary": "Get all API keys for a dataset",
"description": "Get all API keys for a dataset",
"operationId": "get_dataset_api_keys",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"400": {
"description": "Maximum keys exceeded"
},
"201": {
"description": "API key created successfully",
"schema": {
"$ref": "#\/definitions\/ApiKeyItem"
}
}
},
"summary": "Create a new API key for a dataset",
"description": "Create a new API key for a dataset",
"operationId": "create_dataset_api_key",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
}
],
"tags": [
"console"
]
}
},
"\/datasets\/{resource_id}\/api-keys\/{api_key_id}": {
"delete": {
"responses": {
"204": {
"description": "API key deleted successfully"
}
},
"summary": "Delete an API key for a dataset",
"description": "Delete an API key for a dataset",
"operationId": "delete_dataset_api_key",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"type": "string",
"description": "Dataset ID"
},
{
"name": "api_key_id",
"in": "path",
"required": true,
"type": "string",
"description": "API key ID"
}
],
"tags": [
"console"
]
}
},
"\/email-code-login": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_email_code_login_send_email_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EmailPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/email-code-login\/validity": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_email_code_login_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EmailCodeLoginPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/email-register": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_email_register_reset_api",
"tags": [
"console"
]
}
},
"\/email-register\/send-email": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_email_register_send_email_api",
"tags": [
"console"
]
}
},
"\/email-register\/validity": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_email_register_check_api",
"tags": [
"console"
]
}
},
"\/explore\/apps": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_recommended_app_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RecommendedAppsQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/explore\/apps\/{app_id}": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_recommended_app_api",
"tags": [
"console"
]
}
},
"\/explore\/banners": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get banner list",
"operationId": "get_banner_api",
"tags": [
"default"
]
}
},
"\/features": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/FeatureResponse"
}
}
},
"summary": "Get feature configuration for current tenant",
"description": "Get feature configuration for current tenant",
"operationId": "get_tenant_features",
"tags": [
"console"
]
}
},
"\/files\/support-type": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_file_support_type_api",
"tags": [
"console"
]
}
},
"\/files\/upload": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/UploadConfig"
}
}
},
"operationId": "get_file_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"201": {
"description": "File uploaded successfully",
"schema": {
"$ref": "#\/definitions\/FileResponse"
}
}
},
"operationId": "post_file_api",
"tags": [
"console"
]
}
},
"\/files\/{file_id}\/preview": {
"parameters": [
{
"name": "file_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_file_preview_api",
"tags": [
"console"
]
}
},
"\/forgot-password": {
"post": {
"responses": {
"400": {
"description": "Invalid email or rate limit exceeded"
},
"200": {
"description": "Email sent successfully",
"schema": {
"$ref": "#\/definitions\/ForgotPasswordEmailResponse"
}
}
},
"description": "Send password reset email",
"operationId": "send_forgot_password_email",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ForgotPasswordSendPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/forgot-password\/resets": {
"post": {
"responses": {
"400": {
"description": "Invalid token or password mismatch"
},
"200": {
"description": "Password reset successfully",
"schema": {
"$ref": "#\/definitions\/ForgotPasswordResetResponse"
}
}
},
"description": "Reset password with verification token",
"operationId": "reset_password",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ForgotPasswordResetPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/forgot-password\/validity": {
"post": {
"responses": {
"400": {
"description": "Invalid code or token"
},
"200": {
"description": "Code verified successfully",
"schema": {
"$ref": "#\/definitions\/ForgotPasswordCheckResponse"
}
}
},
"description": "Verify password reset code",
"operationId": "check_forgot_password_code",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ForgotPasswordCheckPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/info": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tenant_api",
"tags": [
"console"
]
}
},
"\/init": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/InitStatusResponse"
}
}
},
"summary": "Get initialization validation status",
"description": "Get initialization validation status",
"operationId": "get_init_status",
"tags": [
"console"
]
},
"post": {
"responses": {
"400": {
"description": "Already setup or validation failed"
},
"201": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/InitValidateResponse"
}
}
},
"summary": "Validate initialization password",
"description": "Validate initialization password for self-hosted edition",
"operationId": "validate_init_password",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/InitValidatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_installed_apps_list_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_installed_apps_list_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_installed_app_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_installed_app_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/audio-to-text": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_chat_audio_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/chat-messages": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_chat_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ChatMessagePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/chat-messages\/{task_id}\/stop": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_chat_stop_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/completion-messages": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_completion_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/CompletionMessageExplorePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/completion-messages\/{task_id}\/stop": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_completion_stop_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/conversations": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_conversation_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ConversationListQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/conversations\/{c_id}": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "c_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_conversation_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/conversations\/{c_id}\/name": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "c_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_conversation_rename_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ConversationRenamePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/conversations\/{c_id}\/pin": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "c_id",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_conversation_pin_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/conversations\/{c_id}\/unpin": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "c_id",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_conversation_un_pin_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/messages": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_message_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MessageListQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/messages\/{message_id}\/feedbacks": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_message_feedback_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MessageFeedbackPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/messages\/{message_id}\/more-like-this": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_message_more_like_this_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MoreLikeThisQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/messages\/{message_id}\/suggested-questions": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_message_suggested_question_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/meta": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get app meta",
"operationId": "get_explore_app_meta_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/parameters": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Retrieve app parameters",
"operationId": "get_app_parameter_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/saved-messages": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_saved_message_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SavedMessageListQuery"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_saved_message_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SavedMessageCreatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/saved-messages\/{message_id}": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_saved_message_api",
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/text-to-audio": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_chat_text_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TextToAudioPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/workflows\/run": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run workflow",
"operationId": "post_installed_app_workflow_run_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkflowRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/installed-apps\/{installed_app_id}\/workflows\/tasks\/{task_id}\/stop": {
"parameters": [
{
"name": "installed_app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Stop workflow task",
"operationId": "post_installed_app_workflow_task_stop_api",
"tags": [
"console"
]
}
},
"\/instruction-generate": {
"post": {
"responses": {
"402": {
"description": "Provider quota exceeded"
},
"400": {
"description": "Invalid request parameters or flow\/workflow not found"
},
"200": {
"description": "Instruction generated successfully"
}
},
"description": "Generate instruction for workflow nodes or general use",
"operationId": "generate_instruction",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/InstructionGeneratePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/instruction-generate\/template": {
"post": {
"responses": {
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Template retrieved successfully"
}
},
"description": "Get instruction generation template",
"operationId": "get_instruction_template",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/InstructionTemplatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/login": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Authenticate user and login",
"operationId": "post_login_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/LoginPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/logout": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_logout_api",
"tags": [
"console"
]
}
},
"\/mcp\/oauth\/callback": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_mcp_callback_api",
"parameters": [
{
"name": "code",
"in": "query",
"type": "string",
"required": true
},
{
"name": "state",
"in": "query",
"type": "string",
"required": true
}
],
"tags": [
"console"
]
}
},
"\/notion\/pages\/{page_id}\/{page_type}\/preview": {
"parameters": [
{
"name": "page_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "page_type",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_notion_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_data_source_notion_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/NotionEstimatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/notion\/pre-import\/pages": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_data_source_notion_list_api",
"tags": [
"console"
]
}
},
"\/oauth\/authorize\/{provider}": {
"get": {
"responses": {
"400": {
"description": "OAuth process failed"
},
"302": {
"description": "Redirect to console with access token"
}
},
"description": "Handle OAuth callback and complete login process",
"operationId": "oauth_callback",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string",
"description": "OAuth provider name (github\/google)"
},
{
"description": "Authorization code from OAuth provider",
"name": "code",
"type": "string",
"in": "query"
},
{
"description": "Optional state parameter (used for invite token)",
"name": "state",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/oauth\/data-source\/binding\/{provider}": {
"get": {
"responses": {
"400": {
"description": "Invalid provider or code"
},
"200": {
"description": "Data source binding success",
"schema": {
"$ref": "#\/definitions\/OAuthDataSourceBindingResponse"
}
}
},
"description": "Bind OAuth data source with authorization code",
"operationId": "oauth_data_source_binding",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string",
"description": "Data source provider name (notion)"
},
{
"description": "Authorization code from OAuth provider",
"name": "code",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/oauth\/data-source\/callback\/{provider}": {
"get": {
"responses": {
"400": {
"description": "Invalid provider"
},
"302": {
"description": "Redirect to console with result"
}
},
"description": "Handle OAuth callback from data source provider",
"operationId": "oauth_data_source_callback",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string",
"description": "Data source provider name (notion)"
},
{
"description": "Authorization code from OAuth provider",
"name": "code",
"type": "string",
"in": "query"
},
{
"description": "Error message from OAuth provider",
"name": "error",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/oauth\/data-source\/{provider}": {
"get": {
"responses": {
"403": {
"description": "Admin privileges required"
},
"400": {
"description": "Invalid provider"
},
"200": {
"description": "Authorization URL or internal setup success",
"schema": {
"$ref": "#\/definitions\/OAuthDataSourceResponse"
}
}
},
"description": "Get OAuth authorization URL for data source provider",
"operationId": "oauth_data_source",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string",
"description": "Data source provider name (notion)"
}
],
"tags": [
"console"
]
}
},
"\/oauth\/data-source\/{provider}\/{binding_id}\/sync": {
"get": {
"responses": {
"400": {
"description": "Invalid provider or sync failed"
},
"200": {
"description": "Data source sync success",
"schema": {
"$ref": "#\/definitions\/OAuthDataSourceSyncResponse"
}
}
},
"description": "Sync data from OAuth data source",
"operationId": "oauth_data_source_sync",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string",
"description": "Data source provider name (notion)"
},
{
"name": "binding_id",
"in": "path",
"required": true,
"type": "string",
"description": "Data source binding ID"
}
],
"tags": [
"console"
]
}
},
"\/oauth\/login\/{provider}": {
"get": {
"responses": {
"400": {
"description": "Invalid provider"
},
"302": {
"description": "Redirect to OAuth authorization URL"
}
},
"description": "Initiate OAuth login process",
"operationId": "oauth_login",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string",
"description": "OAuth provider name (github\/google)"
},
{
"description": "Optional invitation token",
"name": "invite_token",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/oauth\/plugin\/{provider_id}\/datasource\/callback": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_datasource_o_auth_callback",
"tags": [
"console"
]
}
},
"\/oauth\/plugin\/{provider_id}\/datasource\/get-authorization-url": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_datasource_plugin_o_auth_authorization_url",
"tags": [
"console"
]
}
},
"\/oauth\/plugin\/{provider}\/tool\/authorization-url": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_plugin_o_auth_api",
"tags": [
"console"
]
}
},
"\/oauth\/plugin\/{provider}\/tool\/callback": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_o_auth_callback",
"tags": [
"console"
]
}
},
"\/oauth\/plugin\/{provider}\/trigger\/callback": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Handle OAuth callback for trigger provider",
"operationId": "get_trigger_o_auth_callback_api",
"tags": [
"console"
]
}
},
"\/oauth\/provider": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_o_auth_server_app_api",
"tags": [
"console"
]
}
},
"\/oauth\/provider\/account": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_o_auth_server_user_account_api",
"tags": [
"console"
]
}
},
"\/oauth\/provider\/authorize": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_o_auth_server_user_authorize_api",
"tags": [
"console"
]
}
},
"\/oauth\/provider\/token": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_o_auth_server_user_token_api",
"tags": [
"console"
]
}
},
"\/rag\/pipeline\/customized\/templates\/{template_id}": {
"parameters": [
{
"name": "template_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_customized_pipeline_template_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_customized_pipeline_template_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_customized_pipeline_template_api",
"tags": [
"console"
]
}
},
"\/rag\/pipeline\/dataset": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_create_rag_pipeline_dataset_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RagPipelineDatasetImportPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipeline\/empty-dataset": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_create_empty_rag_pipeline_dataset_api",
"tags": [
"console"
]
}
},
"\/rag\/pipeline\/templates": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_pipeline_template_list_api",
"tags": [
"console"
]
}
},
"\/rag\/pipeline\/templates\/{template_id}": {
"parameters": [
{
"name": "template_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_pipeline_template_detail_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/datasource-plugins": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_datasource_list_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/imports": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_rag_pipeline_import_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RagPipelineImportPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/imports\/{import_id}\/confirm": {
"parameters": [
{
"name": "import_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_rag_pipeline_import_confirm_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/imports\/{pipeline_id}\/check-dependencies": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_import_check_dependencies_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/recommended-plugins": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_recommended_plugin_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/transform\/datasets\/{dataset_id}": {
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_rag_pipeline_transform_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/customized\/publish": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_publish_customized_pipeline_template_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/Payload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/exports": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_export_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflow-runs": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get workflow run list",
"operationId": "get_rag_pipeline_workflow_run_list_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflow-runs\/tasks\/{task_id}\/stop": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Stop workflow task",
"operationId": "post_rag_pipeline_task_stop_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflow-runs\/{run_id}": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "run_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get workflow run detail",
"operationId": "get_rag_pipeline_workflow_run_detail_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflow-runs\/{run_id}\/node-executions": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "run_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get workflow run node execution list",
"operationId": "get_rag_pipeline_workflow_run_node_execution_list_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get published workflows",
"operationId": "get_published_all_rag_pipeline_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/default-workflow-block-configs": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get default block config",
"operationId": "get_default_rag_pipeline_block_configs_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/default-workflow-block-configs\/{block_type}": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "block_type",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get default block config",
"operationId": "get_default_rag_pipeline_block_config_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get draft rag pipeline's workflow",
"operationId": "get_draft_rag_pipeline_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Sync draft workflow",
"operationId": "post_draft_rag_pipeline_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/datasource\/nodes\/{node_id}\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run rag pipeline datasource",
"operationId": "post_rag_pipeline_draft_datasource_node_run_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/datasource\/variables-inspect": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Set datasource variables",
"operationId": "post_rag_pipeline_datasource_variable_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceVariablesPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/environment-variables": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_environment_variable_collection_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/iteration\/nodes\/{node_id}\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run draft workflow iteration node",
"operationId": "post_rag_pipeline_draft_run_iteration_node_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/NodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/loop\/nodes\/{node_id}\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run draft workflow loop node",
"operationId": "post_rag_pipeline_draft_run_loop_node_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/NodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/nodes\/{node_id}\/last-run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_workflow_last_run_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/nodes\/{node_id}\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run draft workflow node",
"operationId": "post_rag_pipeline_draft_node_run_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/NodeRunRequiredPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/nodes\/{node_id}\/variables": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_rag_pipeline_node_variable_collection_api",
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_node_variable_collection_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/pre-processing\/parameters": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get first step parameters of rag pipeline",
"operationId": "get_draft_rag_pipeline_first_step_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/processing\/parameters": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get second step parameters of rag pipeline",
"operationId": "get_draft_rag_pipeline_second_step_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run draft workflow",
"operationId": "post_draft_rag_pipeline_run_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DraftWorkflowRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/system-variables": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_system_variable_collection_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/variables": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_rag_pipeline_variable_collection_api",
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_variable_collection_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/variables\/{variable_id}": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variable_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_rag_pipeline_variable_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_rag_pipeline_variable_api",
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_rag_pipeline_variable_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/draft\/variables\/{variable_id}\/reset": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "variable_id",
"in": "path",
"required": true,
"type": "string"
}
],
"put": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "put_rag_pipeline_variable_reset_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/publish": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get published pipeline",
"operationId": "get_published_rag_pipeline_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Publish workflow",
"operationId": "post_published_rag_pipeline_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/published\/datasource\/nodes\/{node_id}\/preview": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run datasource content preview",
"operationId": "post_data_source_content_preview_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/Parser"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/published\/datasource\/nodes\/{node_id}\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run rag pipeline datasource",
"operationId": "post_rag_pipeline_published_datasource_node_run_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/DatasourceNodeRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/published\/pre-processing\/parameters": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get first step parameters of rag pipeline",
"operationId": "get_published_rag_pipeline_first_step_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/published\/processing\/parameters": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get second step parameters of rag pipeline",
"operationId": "get_published_rag_pipeline_second_step_api",
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/published\/run": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run published workflow",
"operationId": "post_published_rag_pipeline_run_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/PublishedWorkflowRunPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rag\/pipelines\/{pipeline_id}\/workflows\/{workflow_id}": {
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "workflow_id",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Update workflow attributes",
"operationId": "patch_rag_pipeline_by_id_api",
"tags": [
"console"
]
}
},
"\/refresh-token": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_refresh_token_api",
"tags": [
"console"
]
}
},
"\/remote-files\/upload": {
"post": {
"responses": {
"201": {
"description": "Remote file uploaded",
"schema": {
"$ref": "#\/definitions\/FileWithSignedUrl"
}
}
},
"operationId": "post_remote_file_upload_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RemoteFileUploadPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/remote-files\/{url}": {
"parameters": [
{
"name": "url",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Remote file info",
"schema": {
"$ref": "#\/definitions\/RemoteFileInfo"
}
}
},
"operationId": "get_remote_file_info_api",
"tags": [
"console"
]
}
},
"\/reset-password": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_reset_password_send_email_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EmailPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rule-code-generate": {
"post": {
"responses": {
"402": {
"description": "Provider quota exceeded"
},
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Code rules generated successfully"
}
},
"description": "Generate code rules using LLM",
"operationId": "generate_rule_code",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RuleCodeGeneratePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rule-generate": {
"post": {
"responses": {
"402": {
"description": "Provider quota exceeded"
},
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Rule configuration generated successfully"
}
},
"description": "Generate rule configuration using LLM",
"operationId": "generate_rule_config",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RuleGeneratePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/rule-structured-output-generate": {
"post": {
"responses": {
"402": {
"description": "Provider quota exceeded"
},
"400": {
"description": "Invalid request parameters"
},
"200": {
"description": "Structured output generated successfully"
}
},
"description": "Generate structured output rules using LLM",
"operationId": "generate_structured_output",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/RuleStructuredOutputPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/spec\/schema-definitions": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get system JSON Schema definitions specification",
"description": "Used for frontend component type mapping",
"operationId": "get_spec_schema_definitions_api",
"tags": [
"console"
]
}
},
"\/system-features": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/SystemFeatureResponse"
}
}
},
"summary": "Get system-wide feature configuration",
"description": "Get system-wide feature configuration\nNOTE: This endpoint is unauthenticated by design, as it provides system features\ndata required for dashboard initialization.\n\nAuthentication would create circular dependency (can't login without dashboard loading).\n\nOnly non-sensitive configuration data should be returned by this endpoint.",
"operationId": "get_system_features",
"tags": [
"console"
]
}
},
"\/tag-bindings\/create": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tag_binding_create_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TagBindingPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/tag-bindings\/remove": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tag_binding_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TagBindingRemovePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/tags": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tag_list_api",
"parameters": [
{
"description": "Tag type filter. Can be \"knowledge\" or \"app\".",
"name": "type",
"type": "string",
"in": "query"
},
{
"description": "Search keyword for tag name.",
"name": "keyword",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tag_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TagBasePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/tags\/{tag_id}": {
"parameters": [
{
"name": "tag_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_tag_update_delete_api",
"tags": [
"console"
]
},
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_tag_update_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TagBasePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/test\/retrieval": {
"post": {
"responses": {
"200": {
"description": "Bedrock retrieval test completed"
}
},
"description": "Bedrock retrieval test (internal use only)",
"operationId": "bedrock_retrieval_test",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/BedrockRetrievalPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/trial-apps\/{app_id}": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get app detail",
"operationId": "get_app_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/audio-to-text": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_trial_chat_audio_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/chat-messages": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_trial_chat_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/completion-messages": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_trial_completion_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/datasets": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_list_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/messages\/{message_id}\/suggested-questions": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "message_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_trial_message_suggested_question_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/parameters": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Retrieve app parameters",
"operationId": "get_trial_app_parameter_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/site": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Retrieve app site info",
"description": "Returns the site configuration for the application including theme, icons, and text.",
"operationId": "get_trial_sit_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/text-to-audio": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_trial_chat_text_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/workflows": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get workflow detail",
"operationId": "get_app_workflow_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/workflows\/run": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Run workflow",
"operationId": "post_trial_app_workflow_run_api",
"tags": [
"default"
]
}
},
"\/trial-apps\/{app_id}\/workflows\/tasks\/{task_id}\/stop": {
"parameters": [
{
"name": "app_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Stop workflow task",
"operationId": "post_trial_app_workflow_task_stop_api",
"tags": [
"default"
]
}
},
"\/website\/crawl": {
"post": {
"responses": {
"400": {
"description": "Invalid crawl parameters"
},
"200": {
"description": "Website crawl initiated successfully"
}
},
"description": "Crawl website content",
"operationId": "crawl_website",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WebsiteCrawlPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/website\/crawl\/status\/{job_id}": {
"get": {
"responses": {
"400": {
"description": "Invalid provider"
},
"404": {
"description": "Crawl job not found"
},
"200": {
"description": "Crawl status retrieved successfully"
}
},
"description": "Get website crawl status",
"operationId": "get_crawl_status",
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"type": "string",
"description": "Crawl job ID"
},
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WebsiteCrawlStatusQuery"
}
},
{
"description": "Crawl provider (firecrawl\/watercrawl\/jinareader)",
"name": "provider",
"type": "string",
"in": "query"
}
],
"tags": [
"console"
]
}
},
"\/workspaces": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tenant_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tenant_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/agent-provider\/{provider_name}": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "object",
"description": "Agent provider details"
}
}
},
"description": "Get specific agent provider details",
"operationId": "get_agent_provider",
"parameters": [
{
"name": "provider_name",
"in": "path",
"required": true,
"type": "string",
"description": "Agent provider name"
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/agent-providers": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "Agent provider information"
}
}
}
},
"description": "Get list of available agent providers",
"operationId": "list_agent_providers",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/dataset-operators": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_dataset_operator_member_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/default-model": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_default_model_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserGetDefault"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_default_model_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPostDefault"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/create": {
"post": {
"responses": {
"403": {
"description": "Admin privileges required"
},
"200": {
"description": "Endpoint created successfully",
"schema": {
"$ref": "#\/definitions\/EndpointCreateResponse"
}
}
},
"description": "Create a new plugin endpoint",
"operationId": "create_endpoint",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointCreatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/delete": {
"post": {
"responses": {
"403": {
"description": "Admin privileges required"
},
"200": {
"description": "Endpoint deleted successfully",
"schema": {
"$ref": "#\/definitions\/EndpointDeleteResponse"
}
}
},
"description": "Delete a plugin endpoint",
"operationId": "delete_endpoint",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointIdPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/disable": {
"post": {
"responses": {
"403": {
"description": "Admin privileges required"
},
"200": {
"description": "Endpoint disabled successfully",
"schema": {
"$ref": "#\/definitions\/EndpointDisableResponse"
}
}
},
"description": "Disable a plugin endpoint",
"operationId": "disable_endpoint",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointIdPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/enable": {
"post": {
"responses": {
"403": {
"description": "Admin privileges required"
},
"200": {
"description": "Endpoint enabled successfully",
"schema": {
"$ref": "#\/definitions\/EndpointEnableResponse"
}
}
},
"description": "Enable a plugin endpoint",
"operationId": "enable_endpoint",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointIdPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/list": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/EndpointListResponse"
}
}
},
"description": "List plugin endpoints with pagination",
"operationId": "list_endpoints",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointListQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/list\/plugin": {
"get": {
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#\/definitions\/PluginEndpointListResponse"
}
}
},
"description": "List endpoints for a specific plugin",
"operationId": "list_plugin_endpoints",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointListForPluginQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/endpoints\/update": {
"post": {
"responses": {
"403": {
"description": "Admin privileges required"
},
"200": {
"description": "Endpoint updated successfully",
"schema": {
"$ref": "#\/definitions\/EndpointUpdateResponse"
}
}
},
"description": "Update a plugin endpoint",
"operationId": "update_endpoint",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/EndpointUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_member_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members\/invite-email": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_member_invite_email_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MemberInvitePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members\/owner-transfer-check": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_owner_transfer_check_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/OwnerTransferCheckPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members\/send-owner-transfer-confirm-email": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_send_owner_transfer_email_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/OwnerTransferEmailPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members\/{member_id}": {
"parameters": [
{
"name": "member_id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_member_cancel_invite_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members\/{member_id}\/owner-transfer": {
"parameters": [
{
"name": "member_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_owner_transfer",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/OwnerTransferPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/members\/{member_id}\/update-role": {
"parameters": [
{
"name": "member_id",
"in": "path",
"required": true,
"type": "string"
}
],
"put": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "put_member_update_role_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/MemberRoleUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserModelList"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/checkout-url": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_payment_checkout_url_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/credentials": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_model_provider_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCredentialDelete"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCredentialCreate"
}
}
],
"tags": [
"console"
]
},
"put": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "put_model_provider_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCredentialUpdate"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCredentialId"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/credentials\/switch": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_credential_switch_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCredentialSwitch"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/credentials\/validate": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_validate_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCredentialValidate"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_model_provider_model_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserDeleteModels"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_model_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPostModels"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_model_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/credentials": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_model_provider_model_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserDeleteCredential"
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_model_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserCreateCredential"
}
}
],
"tags": [
"console"
]
},
"put": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "put_model_provider_model_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserUpdateCredential"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_model_credential_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserGetCredentials"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/credentials\/switch": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_model_credential_switch_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserSwitch"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/credentials\/validate": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_model_provider_model_validate_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserValidate"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/disable": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_model_provider_model_disable_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserDeleteModels"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/enable": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"patch": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "patch_model_provider_model_enable_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserDeleteModels"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/load-balancing-configs\/credentials-validate": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_load_balancing_credentials_validate_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/LoadBalancingCredentialPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/load-balancing-configs\/{config_id}\/credentials-validate": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "config_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_load_balancing_config_credentials_validate_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/LoadBalancingCredentialPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/models\/parameter-rules": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_model_parameter_rule_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserParameter"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/model-providers\/{provider}\/preferred-provider-type": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_preferred_provider_type_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPreferredProviderType"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/models\/model-types\/{model_type}": {
"parameters": [
{
"name": "model_type",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_available_model_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/permission": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get workspace permission settings",
"description": "Returns permission flags that control workspace features like member invitations and owner transfer.",
"operationId": "get_workspace_permission_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/asset": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_asset_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserAsset"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/debugging-key": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_debugging_key_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/fetch-manifest": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_manifest_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPluginIdentifierQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/icon": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_icon_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserIcon"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/install\/github": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_install_from_github_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserGithubInstall"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/install\/marketplace": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_install_from_marketplace_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPluginIdentifiers"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/install\/pkg": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_install_from_pkg_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPluginIdentifiers"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/list": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_list_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserList"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/list\/installations\/ids": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_list_installations_from_ids_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserLatest"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/list\/latest-versions": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_list_latest_versions_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserLatest"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/marketplace\/pkg": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_marketplace_pkg_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPluginIdentifierQuery"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/parameters\/dynamic-options": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_dynamic_select_options_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserDynamicOptions"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/parameters\/dynamic-options-with-credentials": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Fetch dynamic options using credentials directly (for edit mode)",
"operationId": "post_plugin_fetch_dynamic_select_options_with_credentials_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserDynamicOptionsWithCredentials"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/permission\/change": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_change_permission_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPermissionChange"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/permission\/fetch": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_permission_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/preferences\/autoupgrade\/exclude": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_auto_upgrade_exclude_plugin_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserExcludePlugin"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/preferences\/change": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_change_preferences_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserPreferencesChange"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/preferences\/fetch": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_preferences_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/readme": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_readme_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserReadme"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/tasks": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_install_tasks_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserTasks"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/tasks\/delete_all": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_delete_all_install_task_items_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/tasks\/{task_id}": {
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_plugin_fetch_install_task_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/tasks\/{task_id}\/delete": {
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_delete_install_task_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/tasks\/{task_id}\/delete\/{identifier}": {
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "identifier",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_delete_install_task_item_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/uninstall": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_uninstall_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserUninstall"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/upgrade\/github": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_upgrade_from_github_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserGithubUpgrade"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/upgrade\/marketplace": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_upgrade_from_marketplace_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserMarketplaceUpgrade"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/upload\/bundle": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_upload_from_bundle_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/upload\/github": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_upload_from_github_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/ParserGithubUpload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/plugin\/upload\/pkg": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_plugin_upload_from_pkg_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-labels": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_labels_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/add": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_api_provider_add_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"credentials": {
"type": "string"
},
"schema_type": {
"type": "string"
},
"schema": {
"type": "string"
},
"provider": {
"type": "string"
},
"icon": {
"type": "string"
},
"privacy_policy": {
"type": "string"
},
"labels": {
"type": "string"
},
"custom_disclaimer": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/delete": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_api_provider_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"provider": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/get": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_api_provider_get_api",
"parameters": [
{
"name": "provider",
"in": "query",
"type": "string",
"required": true
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/remote": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_api_provider_get_remote_schema_api",
"parameters": [
{
"name": "url",
"in": "query",
"type": "string",
"required": true
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/schema": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_api_provider_schema_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"schema": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/test\/pre": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_api_provider_previous_test_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"tool_name": {
"type": "string"
},
"provider_name": {
"type": "string"
},
"credentials": {
"type": "string"
},
"parameters": {
"type": "string"
},
"schema_type": {
"type": "string"
},
"schema": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/tools": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_api_provider_list_tools_api",
"parameters": [
{
"name": "provider",
"in": "query",
"type": "string",
"required": true
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/api\/update": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_api_provider_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"credentials": {
"type": "string"
},
"schema_type": {
"type": "string"
},
"schema": {
"type": "string"
},
"provider": {
"type": "string"
},
"original_provider": {
"type": "string"
},
"icon": {
"type": "string"
},
"privacy_policy": {
"type": "string"
},
"labels": {
"type": "string"
},
"custom_disclaimer": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/add": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_builtin_provider_add_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"credentials": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/credential\/info": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_get_credential_info_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/credential\/schema\/{credential_type}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "credential_type",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_credentials_schema_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/credentials": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_get_credentials_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/default-credential": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_builtin_provider_set_default_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/delete": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_builtin_provider_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"credential_id": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/icon": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_icon_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/info": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_info_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/oauth\/client-schema": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_get_oauth_client_schema_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/oauth\/custom-client": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_tool_o_auth_custom_client",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_o_auth_custom_client",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"client_params": {
"type": "string"
},
"enable_oauth_custom_client": {
"type": "boolean"
}
}
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_o_auth_custom_client",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/tools": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_provider_list_tools_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/builtin\/{provider}\/update": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_builtin_provider_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"credential_id": {
"type": "string"
},
"credentials": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/mcp": {
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "delete_tool_provider_mcp_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"provider_id": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_provider_mcp_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"server_url": {
"type": "string"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"icon_type": {
"type": "string"
},
"icon_background": {
"type": "string"
},
"server_identifier": {
"type": "string"
},
"configuration": {
"type": "string"
},
"headers": {
"type": "string"
},
"authentication": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
},
"put": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "put_tool_provider_mcp_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"server_url": {
"type": "string"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"icon_type": {
"type": "string"
},
"icon_background": {
"type": "string"
},
"provider_id": {
"type": "string"
},
"server_identifier": {
"type": "string"
},
"configuration": {
"type": "string"
},
"headers": {
"type": "string"
},
"authentication": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/mcp\/auth": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_mcp_auth_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"provider_id": {
"type": "string"
},
"authorization_code": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/mcp\/tools\/{provider_id}": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_mcp_detail_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/mcp\/update\/{provider_id}": {
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_mcp_update_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/workflow\/create": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_workflow_provider_create_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"workflow_app_id": {
"type": "string"
},
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"parameters": {
"type": "string"
},
"privacy_policy": {
"type": "string"
},
"labels": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/workflow\/delete": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_workflow_provider_delete_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"workflow_tool_id": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/workflow\/get": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_workflow_provider_get_api",
"parameters": [
{
"name": "workflow_tool_id",
"in": "query",
"type": "string"
},
{
"name": "workflow_app_id",
"in": "query",
"type": "string"
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/workflow\/tools": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_workflow_provider_list_tool_api",
"parameters": [
{
"name": "workflow_tool_id",
"in": "query",
"type": "string",
"required": true
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-provider\/workflow\/update": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_tool_workflow_provider_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"type": "object",
"properties": {
"workflow_tool_id": {
"type": "string"
},
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"parameters": {
"type": "string"
},
"privacy_policy": {
"type": "string"
},
"labels": {
"type": "string"
}
}
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tool-providers": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_provider_list_api",
"parameters": [
{
"name": "type",
"in": "query",
"type": "string",
"enum": [
"builtin",
"model",
"api",
"workflow",
"mcp"
]
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tools\/api": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_api_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tools\/builtin": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_builtin_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tools\/mcp": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_mcp_list_all_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/tools\/workflow": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_tool_workflow_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/icon": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_trigger_provider_icon_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/info": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get info for a trigger provider",
"operationId": "get_trigger_provider_info_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/oauth\/client": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Remove custom OAuth client configuration",
"operationId": "delete_trigger_o_auth_client_manage_api",
"tags": [
"console"
]
},
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Configure custom OAuth client for a provider",
"operationId": "post_trigger_o_auth_client_manage_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerOAuthClientPayload"
}
}
],
"tags": [
"console"
]
},
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get OAuth client configuration for a provider",
"operationId": "get_trigger_o_auth_client_manage_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/builder\/build\/{subscription_builder_id}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "subscription_builder_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Build a subscription instance for a trigger provider",
"operationId": "post_trigger_subscription_builder_build_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerSubscriptionBuilderUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/builder\/create": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Add a new subscription instance for a trigger provider",
"operationId": "post_trigger_subscription_builder_create_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerSubscriptionBuilderCreatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/builder\/logs\/{subscription_builder_id}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "subscription_builder_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get the request logs for a subscription instance for a trigger provider",
"operationId": "get_trigger_subscription_builder_logs_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/builder\/update\/{subscription_builder_id}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "subscription_builder_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Update a subscription instance for a trigger provider",
"operationId": "post_trigger_subscription_builder_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerSubscriptionBuilderUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/builder\/verify-and-update\/{subscription_builder_id}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "subscription_builder_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Verify and update a subscription instance for a trigger provider",
"operationId": "post_trigger_subscription_builder_verify_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerSubscriptionBuilderVerifyPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/builder\/{subscription_builder_id}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "subscription_builder_id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Get a subscription instance for a trigger provider",
"operationId": "get_trigger_subscription_builder_get_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/list": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "List all trigger subscriptions for the current tenant's provider",
"operationId": "get_trigger_subscription_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/oauth\/authorize": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Initiate OAuth authorization flow for a trigger provider",
"operationId": "get_trigger_o_auth_authorize_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{provider}\/subscriptions\/verify\/{subscription_id}": {
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "subscription_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Verify credentials for an existing subscription (edit mode only)",
"operationId": "post_trigger_subscription_verify_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerSubscriptionBuilderVerifyPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{subscription_id}\/subscriptions\/delete": {
"parameters": [
{
"name": "subscription_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Delete a subscription instance",
"operationId": "post_trigger_subscription_delete_api",
"tags": [
"console"
]
}
},
"\/workspaces\/current\/trigger-provider\/{subscription_id}\/subscriptions\/update": {
"parameters": [
{
"name": "subscription_id",
"in": "path",
"required": true,
"type": "string"
}
],
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "Update a subscription instance",
"operationId": "post_trigger_subscription_update_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/TriggerSubscriptionBuilderUpdatePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/current\/triggers": {
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"summary": "List all trigger providers for the current tenant",
"operationId": "get_trigger_provider_list_api",
"tags": [
"console"
]
}
},
"\/workspaces\/custom-config": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_custom_config_workspace_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkspaceCustomConfigPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/custom-config\/webapp-logo\/upload": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_webapp_logo_workspace_api",
"tags": [
"console"
]
}
},
"\/workspaces\/info": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_workspace_info_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/WorkspaceInfoPayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/switch": {
"post": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "post_switch_workspace_api",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#\/definitions\/SwitchWorkspacePayload"
}
}
],
"tags": [
"console"
]
}
},
"\/workspaces\/{tenant_id}\/model-providers\/{provider}\/{icon_type}\/{lang}": {
"parameters": [
{
"name": "tenant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "provider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "icon_type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "lang",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "get_model_provider_icon_api",
"tags": [
"console"
]
}
}
},
"info": {
"title": "Console API",
"version": "1.0",
"description": "Console management APIs for app configuration, monitoring, and administration"
},
"produces": [
"application\/json"
],
"consumes": [
"application\/json"
],
"securityDefinitions": {
"Bearer": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Type: Bearer {your-api-key}"
}
},
"security": [
{
"Bearer": []
}
],
"tags": [
{
"name": "default",
"description": "Default namespace"
},
{
"name": "console",
"description": "Console management API operations"
}
],
"definitions": {
"AppImportPayload": {
"properties": {
"mode": {
"description": "Import mode",
"title": "Mode",
"type": "string"
},
"yaml_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Yaml Content"
},
"yaml_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Yaml Url"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"app_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "App Id"
}
},
"required": [
"mode"
],
"title": "AppImportPayload",
"type": "object"
},
"TextToAudioPayload": {
"properties": {
"message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message Id"
},
"voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Voice"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Text"
},
"streaming": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Enable streaming response",
"title": "Streaming"
}
},
"title": "TextToAudioPayload",
"type": "object"
},
"CompletionMessageExplorePayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"query": {
"default": "",
"title": "Query",
"type": "string"
},
"files": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Files"
},
"response_mode": {
"anyOf": [
{
"enum": [
"blocking",
"streaming"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Response Mode"
},
"retriever_from": {
"default": "explore_app",
"title": "Retriever From",
"type": "string"
}
},
"required": [
"inputs"
],
"title": "CompletionMessageExplorePayload",
"type": "object"
},
"ChatMessagePayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"model_config": {
"additionalProperties": true,
"title": "Model Config",
"type": "object"
},
"files": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Uploaded files",
"title": "Files"
},
"response_mode": {
"default": "blocking",
"description": "Response mode",
"enum": [
"blocking",
"streaming"
],
"title": "Response Mode",
"type": "string"
},
"retriever_from": {
"default": "dev",
"description": "Retriever source",
"title": "Retriever From",
"type": "string"
},
"query": {
"description": "User query",
"title": "Query",
"type": "string"
},
"conversation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Conversation ID",
"title": "Conversation Id"
},
"parent_message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Parent message ID",
"title": "Parent Message Id"
}
},
"required": [
"inputs",
"model_config",
"query"
],
"title": "ChatMessagePayload",
"type": "object"
},
"ConversationListQuery": {
"properties": {
"last_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Id"
},
"limit": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"pinned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Pinned"
}
},
"title": "ConversationListQuery",
"type": "object"
},
"ConversationRenamePayload": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"auto_generate": {
"default": false,
"title": "Auto Generate",
"type": "boolean"
}
},
"title": "ConversationRenamePayload",
"type": "object"
},
"MessageListQuery": {
"properties": {
"conversation_id": {
"title": "Conversation Id",
"type": "string"
},
"first_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Id"
},
"limit": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"required": [
"conversation_id"
],
"title": "MessageListQuery",
"type": "object"
},
"MessageFeedbackPayload": {
"properties": {
"message_id": {
"description": "Message ID",
"title": "Message Id",
"type": "string"
},
"rating": {
"anyOf": [
{
"enum": [
"like",
"dislike"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Feedback rating",
"title": "Rating"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Feedback content",
"title": "Content"
}
},
"required": [
"message_id"
],
"title": "MessageFeedbackPayload",
"type": "object"
},
"MoreLikeThisQuery": {
"properties": {
"response_mode": {
"enum": [
"blocking",
"streaming"
],
"title": "Response Mode",
"type": "string"
}
},
"required": [
"response_mode"
],
"title": "MoreLikeThisQuery",
"type": "object"
},
"WorkflowRunPayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"files": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Files"
}
},
"required": [
"inputs"
],
"title": "WorkflowRunPayload",
"type": "object"
},
"UploadConfig": {
"properties": {
"file_size_limit": {
"title": "File Size Limit",
"type": "integer"
},
"batch_count_limit": {
"title": "Batch Count Limit",
"type": "integer"
},
"file_upload_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "File Upload Limit"
},
"image_file_size_limit": {
"title": "Image File Size Limit",
"type": "integer"
},
"video_file_size_limit": {
"title": "Video File Size Limit",
"type": "integer"
},
"audio_file_size_limit": {
"title": "Audio File Size Limit",
"type": "integer"
},
"workflow_file_upload_limit": {
"title": "Workflow File Upload Limit",
"type": "integer"
},
"image_file_batch_limit": {
"title": "Image File Batch Limit",
"type": "integer"
},
"single_chunk_attachment_limit": {
"title": "Single Chunk Attachment Limit",
"type": "integer"
},
"attachment_image_file_size_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Attachment Image File Size Limit"
}
},
"required": [
"file_size_limit",
"batch_count_limit",
"image_file_size_limit",
"video_file_size_limit",
"audio_file_size_limit",
"workflow_file_upload_limit",
"image_file_batch_limit",
"single_chunk_attachment_limit"
],
"title": "UploadConfig",
"type": "object"
},
"FileResponse": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"size": {
"title": "Size",
"type": "integer"
},
"extension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Extension"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"preview_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Preview Url"
},
"source_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Url"
},
"original_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Original Url"
},
"user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "User Id"
},
"tenant_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Tenant Id"
},
"conversation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conversation Id"
},
"file_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "File Key"
}
},
"required": [
"id",
"name",
"size"
],
"title": "FileResponse",
"type": "object"
},
"RemoteFileInfo": {
"properties": {
"file_type": {
"title": "File Type",
"type": "string"
},
"file_length": {
"title": "File Length",
"type": "integer"
}
},
"required": [
"file_type",
"file_length"
],
"title": "RemoteFileInfo",
"type": "object"
},
"RemoteFileUploadPayload": {
"properties": {
"url": {
"description": "URL to fetch",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "RemoteFileUploadPayload",
"type": "object"
},
"FileWithSignedUrl": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"size": {
"title": "Size",
"type": "integer"
},
"extension": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Extension"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
}
},
"required": [
"id",
"name",
"size"
],
"title": "FileWithSignedUrl",
"type": "object"
},
"InsertExploreAppPayload": {
"properties": {
"app_id": {
"title": "App Id",
"type": "string"
},
"desc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Desc"
},
"copyright": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Copyright"
},
"privacy_policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Privacy Policy"
},
"custom_disclaimer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Custom Disclaimer"
},
"language": {
"title": "Language",
"type": "string"
},
"category": {
"title": "Category",
"type": "string"
},
"position": {
"title": "Position",
"type": "integer"
},
"can_trial": {
"default": false,
"title": "Can Trial",
"type": "boolean"
},
"trial_limit": {
"default": 0,
"title": "Trial Limit",
"type": "integer"
}
},
"required": [
"app_id",
"language",
"category",
"position"
],
"title": "InsertExploreAppPayload",
"type": "object"
},
"InsertExploreBannerPayload": {
"properties": {
"category": {
"title": "Category",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"img-src": {
"title": "Img-Src",
"type": "string"
},
"language": {
"default": "en-US",
"title": "Language",
"type": "string"
},
"link": {
"title": "Link",
"type": "string"
},
"sort": {
"title": "Sort",
"type": "integer"
}
},
"required": [
"category",
"title",
"description",
"img-src",
"link",
"sort"
],
"title": "InsertExploreBannerPayload",
"type": "object"
},
"ApiKeyList": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ApiKeyItem"
}
}
},
"type": "object"
},
"ApiKeyItem": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"token": {
"type": "string"
},
"last_used_at": {
"type": "object"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"CodeBasedExtensionResponse": {
"properties": {
"module": {
"type": "string",
"description": "Module name"
},
"data": {
"type": "object",
"description": "Extension data"
}
},
"type": "object"
},
"APIBasedExtensionPayload": {
"properties": {
"name": {
"description": "Extension name",
"title": "Name",
"type": "string"
},
"api_endpoint": {
"description": "API endpoint URL",
"title": "Api Endpoint",
"type": "string"
},
"api_key": {
"description": "API key for authentication",
"title": "Api Key",
"type": "string"
}
},
"required": [
"name",
"api_endpoint",
"api_key"
],
"title": "APIBasedExtensionPayload",
"type": "object"
},
"ApiBasedExtensionModel": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"api_endpoint": {
"type": "string"
},
"api_key": {
"type": "object"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"FeatureResponse": {
"properties": {
"features": {
"type": "object",
"description": "Feature configuration object"
}
},
"type": "object"
},
"SystemFeatureResponse": {
"properties": {
"features": {
"type": "object",
"description": "System feature configuration object"
}
},
"type": "object"
},
"InitValidatePayload": {
"properties": {
"password": {
"maxLength": 30,
"title": "Password",
"type": "string"
}
},
"required": [
"password"
],
"title": "InitValidatePayload",
"type": "object"
},
"InitStatusResponse": {
"properties": {
"status": {
"type": "string",
"description": "Initialization status",
"example": "finished",
"enum": [
"finished",
"not_started"
]
}
},
"type": "object"
},
"InitValidateResponse": {
"properties": {
"result": {
"type": "string",
"description": "Operation result"
}
},
"type": "object"
},
"AdvancedPromptTemplateQuery": {
"properties": {
"app_mode": {
"description": "Application mode",
"title": "App Mode",
"type": "string"
},
"model_mode": {
"description": "Model mode",
"title": "Model Mode",
"type": "string"
},
"has_context": {
"default": "true",
"description": "Whether has context",
"title": "Has Context",
"type": "string"
},
"model_name": {
"description": "Model name",
"title": "Model Name",
"type": "string"
}
},
"required": [
"app_mode",
"model_mode",
"model_name"
],
"title": "AdvancedPromptTemplateQuery",
"type": "object"
},
"AgentLogQuery": {
"properties": {
"message_id": {
"description": "Message UUID",
"title": "Message Id",
"type": "string"
},
"conversation_id": {
"description": "Conversation UUID",
"title": "Conversation Id",
"type": "string"
}
},
"required": [
"message_id",
"conversation_id"
],
"title": "AgentLogQuery",
"type": "object"
},
"AnnotationReplyPayload": {
"properties": {
"score_threshold": {
"description": "Score threshold for annotation matching",
"title": "Score Threshold",
"type": "number"
},
"embedding_provider_name": {
"description": "Embedding provider name",
"title": "Embedding Provider Name",
"type": "string"
},
"embedding_model_name": {
"description": "Embedding model name",
"title": "Embedding Model Name",
"type": "string"
}
},
"required": [
"score_threshold",
"embedding_provider_name",
"embedding_model_name"
],
"title": "AnnotationReplyPayload",
"type": "object"
},
"AnnotationSettingUpdatePayload": {
"properties": {
"score_threshold": {
"description": "Score threshold",
"title": "Score Threshold",
"type": "number"
}
},
"required": [
"score_threshold"
],
"title": "AnnotationSettingUpdatePayload",
"type": "object"
},
"CreateAnnotationPayload": {
"properties": {
"message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Message ID",
"title": "Message Id"
},
"question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Question text",
"title": "Question"
},
"answer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Answer text",
"title": "Answer"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Content text",
"title": "Content"
},
"annotation_reply": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Annotation reply data",
"title": "Annotation Reply"
}
},
"title": "CreateAnnotationPayload",
"type": "object"
},
"AnnotationListQuery": {
"properties": {
"page": {
"default": 1,
"description": "Page number",
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"description": "Page size",
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"keyword": {
"default": "",
"description": "Search keyword",
"title": "Keyword",
"type": "string"
}
},
"title": "AnnotationListQuery",
"type": "object"
},
"Annotation": {
"properties": {
"id": {
"type": "string"
},
"question": {
"type": "string"
},
"content": {
"type": "string"
},
"account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"SimpleAccount": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"type": "object"
},
"AnnotationList": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Annotation"
}
}
},
"type": "object"
},
"UpdateAnnotationPayload": {
"properties": {
"question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Question"
},
"answer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Answer"
},
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Content"
},
"annotation_reply": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Annotation Reply"
}
},
"title": "UpdateAnnotationPayload",
"type": "object"
},
"AnnotationHitHistoryList": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AnnotationHitHistoryItem"
}
}
},
"type": "object"
},
"AnnotationHitHistoryItem": {
"properties": {
"id": {
"type": "string"
},
"source": {
"type": "string"
},
"score": {
"type": "number"
},
"question": {
"type": "string"
},
"created_at": {
"type": "object"
},
"match": {
"type": "string"
},
"response": {
"type": "string"
}
},
"type": "object"
},
"AppListQuery": {
"properties": {
"page": {
"default": 1,
"description": "Page number (1-99999)",
"maximum": 99999,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"description": "Page size (1-100)",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"mode": {
"default": "all",
"description": "App mode filter",
"enum": [
"completion",
"chat",
"advanced-chat",
"workflow",
"agent-chat",
"channel",
"all"
],
"title": "Mode",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by app name",
"title": "Name"
},
"tag_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Comma-separated tag IDs",
"title": "Tag Ids"
},
"is_created_by_me": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by creator",
"title": "Is Created By Me"
}
},
"title": "AppListQuery",
"type": "object"
},
"CreateAppPayload": {
"properties": {
"name": {
"description": "App name",
"minLength": 1,
"title": "Name",
"type": "string"
},
"description": {
"anyOf": [
{
"maxLength": 400,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "App description (max 400 chars)",
"title": "Description"
},
"mode": {
"description": "App mode",
"enum": [
"chat",
"agent-chat",
"advanced-chat",
"workflow",
"completion"
],
"title": "Mode",
"type": "string"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon type",
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon",
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon background color",
"title": "Icon Background"
}
},
"required": [
"name",
"mode"
],
"title": "CreateAppPayload",
"type": "object"
},
"AppPagination": {
"$defs": {
"AppPartial": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"max_active_requests": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Active Requests"
},
"desc_or_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Desc Or Prompt"
},
"mode_compatible_with_agent": {
"title": "Mode Compatible With Agent",
"type": "string"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"app_model_config": {
"anyOf": [
{
"$ref": "#\/definitions\/ModelConfigPartial"
},
{
"type": "null"
}
],
"default": null
},
"workflow": {
"anyOf": [
{
"$ref": "#\/definitions\/WorkflowPartial"
},
{
"type": "null"
}
],
"default": null
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"tags": {
"items": {
"$ref": "#\/definitions\/Tag"
},
"title": "Tags",
"type": "array"
},
"access_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Mode"
},
"create_user_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Create User Name"
},
"author_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Name"
},
"has_draft_trigger": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Draft Trigger"
}
},
"required": [
"id",
"name",
"mode_compatible_with_agent"
],
"title": "AppPartial",
"type": "object"
},
"ModelConfigPartial": {
"properties": {
"model_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Model Dict"
},
"pre_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Prompt"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "ModelConfigPartial",
"type": "object"
},
"Tag": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name",
"type"
],
"title": "Tag",
"type": "object"
},
"WorkflowPartial": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id"
],
"title": "WorkflowPartial",
"type": "object"
}
},
"properties": {
"page": {
"title": "Page",
"type": "integer"
},
"per_page": {
"title": "Per Page",
"type": "integer"
},
"total": {
"title": "Total",
"type": "integer"
},
"has_next": {
"title": "Has Next",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#\/definitions\/AppPartial"
},
"title": "Items",
"type": "array"
}
},
"required": [
"page",
"per_page",
"total",
"has_next",
"items"
],
"title": "AppPagination",
"type": "object"
},
"AppDetail": {
"$defs": {
"ModelConfig": {
"properties": {
"opening_statement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Opening Statement"
},
"suggested_questions_list": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Suggested Questions List"
},
"suggested_questions_after_answer_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Suggested Questions After Answer Dict"
},
"speech_to_text_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Speech To Text Dict"
},
"text_to_speech_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Text To Speech Dict"
},
"retriever_resource_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Retriever Resource Dict"
},
"annotation_reply_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Annotation Reply Dict"
},
"more_like_this_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "More Like This Dict"
},
"sensitive_word_avoidance_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Sensitive Word Avoidance Dict"
},
"external_data_tools_list": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "External Data Tools List"
},
"model_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Model Dict"
},
"user_input_form_list": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "User Input Form List"
},
"dataset_query_variable": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Dataset Query Variable"
},
"pre_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Prompt"
},
"agent_mode_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Agent Mode Dict"
},
"prompt_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prompt Type"
},
"chat_prompt_config_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Chat Prompt Config Dict"
},
"completion_prompt_config_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Completion Prompt Config Dict"
},
"dataset_configs_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Dataset Configs Dict"
},
"file_upload_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "File Upload Dict"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "ModelConfig",
"type": "object"
},
"Tag": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name",
"type"
],
"title": "Tag",
"type": "object"
},
"WorkflowPartial": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id"
],
"title": "WorkflowPartial",
"type": "object"
}
},
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"mode_compatible_with_agent": {
"title": "Mode Compatible With Agent",
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"enable_site": {
"title": "Enable Site",
"type": "boolean"
},
"enable_api": {
"title": "Enable Api",
"type": "boolean"
},
"app_model_config": {
"anyOf": [
{
"$ref": "#\/definitions\/ModelConfig"
},
{
"type": "null"
}
],
"default": null
},
"workflow": {
"anyOf": [
{
"$ref": "#\/definitions\/WorkflowPartial"
},
{
"type": "null"
}
],
"default": null
},
"tracing": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Tracing"
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"access_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Mode"
},
"tags": {
"items": {
"$ref": "#\/definitions\/Tag"
},
"title": "Tags",
"type": "array"
}
},
"required": [
"id",
"name",
"mode_compatible_with_agent",
"enable_site",
"enable_api"
],
"title": "AppDetail",
"type": "object"
},
"UpdateAppPayload": {
"properties": {
"name": {
"description": "App name",
"minLength": 1,
"title": "Name",
"type": "string"
},
"description": {
"anyOf": [
{
"maxLength": 400,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "App description (max 400 chars)",
"title": "Description"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon type",
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon",
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon background color",
"title": "Icon Background"
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Use icon as answer icon",
"title": "Use Icon As Answer Icon"
},
"max_active_requests": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum active requests",
"title": "Max Active Requests"
}
},
"required": [
"name"
],
"title": "UpdateAppPayload",
"type": "object"
},
"AppDetailWithSite": {
"$defs": {
"DeletedTool": {
"properties": {
"type": {
"title": "Type",
"type": "string"
},
"tool_name": {
"title": "Tool Name",
"type": "string"
},
"provider_id": {
"title": "Provider Id",
"type": "string"
}
},
"required": [
"type",
"tool_name",
"provider_id"
],
"title": "DeletedTool",
"type": "object"
},
"IconType": {
"enum": [
"image",
"emoji",
"link"
],
"title": "IconType",
"type": "string"
},
"ModelConfig": {
"properties": {
"opening_statement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Opening Statement"
},
"suggested_questions_list": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Suggested Questions List"
},
"suggested_questions_after_answer_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Suggested Questions After Answer Dict"
},
"speech_to_text_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Speech To Text Dict"
},
"text_to_speech_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Text To Speech Dict"
},
"retriever_resource_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Retriever Resource Dict"
},
"annotation_reply_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Annotation Reply Dict"
},
"more_like_this_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "More Like This Dict"
},
"sensitive_word_avoidance_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Sensitive Word Avoidance Dict"
},
"external_data_tools_list": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "External Data Tools List"
},
"model_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Model Dict"
},
"user_input_form_list": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "User Input Form List"
},
"dataset_query_variable": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Dataset Query Variable"
},
"pre_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Prompt"
},
"agent_mode_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Agent Mode Dict"
},
"prompt_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prompt Type"
},
"chat_prompt_config_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Chat Prompt Config Dict"
},
"completion_prompt_config_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Completion Prompt Config Dict"
},
"dataset_configs_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Dataset Configs Dict"
},
"file_upload_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "File Upload Dict"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "ModelConfig",
"type": "object"
},
"Site": {
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Code"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#\/definitions\/IconType"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"default_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Language"
},
"chat_color_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Chat Color Theme"
},
"chat_color_theme_inverted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Chat Color Theme Inverted"
},
"customize_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customize Domain"
},
"copyright": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Copyright"
},
"privacy_policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Privacy Policy"
},
"custom_disclaimer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Custom Disclaimer"
},
"customize_token_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customize Token Strategy"
},
"prompt_public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Prompt Public"
},
"app_base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "App Base Url"
},
"show_workflow_steps": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Show Workflow Steps"
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "Site",
"type": "object"
},
"Tag": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name",
"type"
],
"title": "Tag",
"type": "object"
},
"WorkflowPartial": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id"
],
"title": "WorkflowPartial",
"type": "object"
}
},
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"mode_compatible_with_agent": {
"title": "Mode Compatible With Agent",
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"enable_site": {
"title": "Enable Site",
"type": "boolean"
},
"enable_api": {
"title": "Enable Api",
"type": "boolean"
},
"app_model_config": {
"anyOf": [
{
"$ref": "#\/definitions\/ModelConfig"
},
{
"type": "null"
}
],
"default": null
},
"workflow": {
"anyOf": [
{
"$ref": "#\/definitions\/WorkflowPartial"
},
{
"type": "null"
}
],
"default": null
},
"tracing": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Tracing"
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"access_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Mode"
},
"tags": {
"items": {
"$ref": "#\/definitions\/Tag"
},
"title": "Tags",
"type": "array"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"api_base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Api Base Url"
},
"max_active_requests": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Active Requests"
},
"deleted_tools": {
"items": {
"$ref": "#\/definitions\/DeletedTool"
},
"title": "Deleted Tools",
"type": "array"
},
"site": {
"anyOf": [
{
"$ref": "#\/definitions\/Site"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"id",
"name",
"mode_compatible_with_agent",
"enable_site",
"enable_api"
],
"title": "AppDetailWithSite",
"type": "object"
},
"CopyAppPayload": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name for the copied app",
"title": "Name"
},
"description": {
"anyOf": [
{
"maxLength": 400,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Description for the copied app",
"title": "Description"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon type",
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon",
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon background color",
"title": "Icon Background"
}
},
"title": "CopyAppPayload",
"type": "object"
},
"AppExportQuery": {
"properties": {
"include_secret": {
"default": false,
"description": "Include secrets in export",
"title": "Include Secret",
"type": "boolean"
},
"workflow_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Specific workflow ID to export",
"title": "Workflow Id"
}
},
"title": "AppExportQuery",
"type": "object"
},
"AppExportResponse": {
"properties": {
"data": {
"title": "Data",
"type": "string"
}
},
"required": [
"data"
],
"title": "AppExportResponse",
"type": "object"
},
"AppNamePayload": {
"properties": {
"name": {
"description": "Name to check",
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "AppNamePayload",
"type": "object"
},
"AppIconPayload": {
"properties": {
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon data",
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Icon background color",
"title": "Icon Background"
}
},
"title": "AppIconPayload",
"type": "object"
},
"AppSiteStatusPayload": {
"properties": {
"enable_site": {
"description": "Enable or disable site",
"title": "Enable Site",
"type": "boolean"
}
},
"required": [
"enable_site"
],
"title": "AppSiteStatusPayload",
"type": "object"
},
"AppApiStatusPayload": {
"properties": {
"enable_api": {
"description": "Enable or disable API",
"title": "Enable Api",
"type": "boolean"
}
},
"required": [
"enable_api"
],
"title": "AppApiStatusPayload",
"type": "object"
},
"AppTracePayload": {
"properties": {
"enabled": {
"description": "Enable or disable tracing",
"title": "Enabled",
"type": "boolean"
},
"tracing_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tracing provider",
"title": "Tracing Provider"
}
},
"required": [
"enabled"
],
"title": "AppTracePayload",
"type": "object"
},
"AudioTranscriptResponse": {
"properties": {
"text": {
"type": "string",
"description": "Transcribed text from audio"
}
},
"type": "object"
},
"TextToSpeechPayload": {
"properties": {
"message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Message ID",
"title": "Message Id"
},
"text": {
"description": "Text to convert",
"title": "Text",
"type": "string"
},
"voice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Voice name",
"title": "Voice"
},
"streaming": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether to stream audio",
"title": "Streaming"
}
},
"required": [
"text"
],
"title": "TextToSpeechPayload",
"type": "object"
},
"TextToSpeechVoiceQuery": {
"properties": {
"language": {
"description": "Language code",
"title": "Language",
"type": "string"
}
},
"required": [
"language"
],
"title": "TextToSpeechVoiceQuery",
"type": "object"
},
"CompletionMessagePayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"model_config": {
"additionalProperties": true,
"title": "Model Config",
"type": "object"
},
"files": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Uploaded files",
"title": "Files"
},
"response_mode": {
"default": "blocking",
"description": "Response mode",
"enum": [
"blocking",
"streaming"
],
"title": "Response Mode",
"type": "string"
},
"retriever_from": {
"default": "dev",
"description": "Retriever source",
"title": "Retriever From",
"type": "string"
},
"query": {
"default": "",
"description": "Query text",
"title": "Query",
"type": "string"
}
},
"required": [
"inputs",
"model_config"
],
"title": "CompletionMessagePayload",
"type": "object"
},
"CompletionConversationQuery": {
"properties": {
"keyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Search keyword",
"title": "Keyword"
},
"start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date (YYYY-MM-DD HH:MM)",
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date (YYYY-MM-DD HH:MM)",
"title": "End"
},
"annotation_status": {
"default": "all",
"description": "Annotation status filter",
"enum": [
"annotated",
"not_annotated",
"all"
],
"title": "Annotation Status",
"type": "string"
},
"page": {
"default": 1,
"description": "Page number",
"maximum": 99999,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"description": "Page size (1-100)",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "CompletionConversationQuery",
"type": "object"
},
"ConversationPagination": {
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Conversation"
}
}
},
"type": "object"
},
"Conversation": {
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"from_source": {
"type": "string"
},
"from_end_user_id": {
"type": "string"
},
"from_end_user_session_id": {
"type": "string"
},
"from_account_id": {
"type": "string"
},
"from_account_name": {
"type": "string"
},
"read_at": {
"type": "object"
},
"created_at": {
"type": "object"
},
"updated_at": {
"type": "object"
},
"annotation": {
"$ref": "#\/definitions\/Annotation"
},
"model_config": {
"$ref": "#\/definitions\/SimpleModelConfig"
},
"user_feedback_stats": {
"$ref": "#\/definitions\/FeedbackStat"
},
"admin_feedback_stats": {
"$ref": "#\/definitions\/FeedbackStat"
},
"message": {
"$ref": "#\/definitions\/SimpleMessageDetail"
}
},
"type": "object"
},
"SimpleModelConfig": {
"properties": {
"model": {
"type": "object"
},
"pre_prompt": {
"type": "string"
}
},
"type": "object"
},
"FeedbackStat": {
"properties": {
"like": {
"type": "integer"
},
"dislike": {
"type": "integer"
}
},
"type": "object"
},
"SimpleMessageDetail": {
"properties": {
"inputs": {
"type": "object"
},
"query": {
"type": "string"
},
"message": {
"type": "object"
},
"answer": {
"type": "string"
}
},
"type": "object"
},
"ConversationMessageDetail": {
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"from_source": {
"type": "string"
},
"from_end_user_id": {
"type": "string"
},
"from_account_id": {
"type": "string"
},
"created_at": {
"type": "object"
},
"model_config": {
"$ref": "#\/definitions\/ModelConfig"
},
"message": {
"$ref": "#\/definitions\/MessageDetail"
}
},
"type": "object"
},
"ModelConfig": {
"properties": {
"opening_statement": {
"type": "string"
},
"suggested_questions": {
"type": "object"
},
"model": {
"type": "object"
},
"user_input_form": {
"type": "object"
},
"pre_prompt": {
"type": "string"
},
"agent_mode": {
"type": "object"
}
},
"type": "object"
},
"MessageDetail": {
"properties": {
"id": {
"type": "string"
},
"conversation_id": {
"type": "string"
},
"inputs": {
"type": "object"
},
"query": {
"type": "string"
},
"message": {
"type": "object"
},
"message_tokens": {
"type": "integer"
},
"answer": {
"type": "string"
},
"answer_tokens": {
"type": "integer"
},
"provider_response_latency": {
"type": "number"
},
"from_source": {
"type": "string"
},
"from_end_user_id": {
"type": "string"
},
"from_account_id": {
"type": "string"
},
"feedbacks": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Feedback"
}
},
"workflow_run_id": {
"type": "string"
},
"annotation": {
"$ref": "#\/definitions\/Annotation"
},
"annotation_hit_history": {
"$ref": "#\/definitions\/AnnotationHitHistory"
},
"created_at": {
"type": "object"
},
"agent_thoughts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AgentThought"
}
},
"message_files": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageFile"
}
},
"metadata": {
"type": "object"
},
"status": {
"type": "string"
},
"error": {
"type": "string"
},
"parent_message_id": {
"type": "string"
}
},
"type": "object"
},
"Feedback": {
"properties": {
"rating": {
"type": "string"
},
"content": {
"type": "string"
},
"from_source": {
"type": "string"
},
"from_end_user_id": {
"type": "string"
},
"from_account": {
"$ref": "#\/definitions\/SimpleAccount"
}
},
"type": "object"
},
"AnnotationHitHistory": {
"properties": {
"annotation_id": {
"type": "string"
},
"annotation_create_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"AgentThought": {
"properties": {
"id": {
"type": "string"
},
"chain_id": {
"type": "string"
},
"message_id": {
"type": "string"
},
"position": {
"type": "integer"
},
"thought": {
"type": "string"
},
"tool": {
"type": "string"
},
"tool_labels": {
"type": "object"
},
"tool_input": {
"type": "string"
},
"created_at": {
"type": "object"
},
"observation": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"MessageFile": {
"properties": {
"id": {
"type": "string"
},
"filename": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"transfer_method": {
"type": "string"
},
"belongs_to": {
"type": "string",
"default": "user"
},
"upload_file_id": {
"type": "string"
}
},
"type": "object"
},
"ChatConversationQuery": {
"properties": {
"keyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Search keyword",
"title": "Keyword"
},
"start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date (YYYY-MM-DD HH:MM)",
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date (YYYY-MM-DD HH:MM)",
"title": "End"
},
"annotation_status": {
"default": "all",
"description": "Annotation status filter",
"enum": [
"annotated",
"not_annotated",
"all"
],
"title": "Annotation Status",
"type": "string"
},
"page": {
"default": 1,
"description": "Page number",
"maximum": 99999,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"description": "Page size (1-100)",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"sort_by": {
"default": "-updated_at",
"description": "Sort field and direction",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
],
"title": "Sort By",
"type": "string"
}
},
"title": "ChatConversationQuery",
"type": "object"
},
"ConversationWithSummaryPagination": {
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ConversationWithSummary"
}
}
},
"type": "object"
},
"ConversationWithSummary": {
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"from_source": {
"type": "string"
},
"from_end_user_id": {
"type": "string"
},
"from_end_user_session_id": {
"type": "string"
},
"from_account_id": {
"type": "string"
},
"from_account_name": {
"type": "string"
},
"name": {
"type": "string"
},
"summary": {
"type": "string"
},
"read_at": {
"type": "object"
},
"created_at": {
"type": "object"
},
"updated_at": {
"type": "object"
},
"annotated": {
"type": "boolean"
},
"model_config": {
"$ref": "#\/definitions\/SimpleModelConfig"
},
"message_count": {
"type": "integer"
},
"user_feedback_stats": {
"$ref": "#\/definitions\/FeedbackStat"
},
"admin_feedback_stats": {
"$ref": "#\/definitions\/FeedbackStat"
},
"status_count": {
"$ref": "#\/definitions\/StatusCount"
}
},
"type": "object"
},
"StatusCount": {
"properties": {
"success": {
"type": "integer"
},
"failed": {
"type": "integer"
},
"partial_success": {
"type": "integer"
}
},
"type": "object"
},
"ConversationDetail": {
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"from_source": {
"type": "string"
},
"from_end_user_id": {
"type": "string"
},
"from_account_id": {
"type": "string"
},
"created_at": {
"type": "object"
},
"updated_at": {
"type": "object"
},
"annotated": {
"type": "boolean"
},
"introduction": {
"type": "string"
},
"model_config": {
"$ref": "#\/definitions\/ModelConfig"
},
"message_count": {
"type": "integer"
},
"user_feedback_stats": {
"$ref": "#\/definitions\/FeedbackStat"
},
"admin_feedback_stats": {
"$ref": "#\/definitions\/FeedbackStat"
}
},
"type": "object"
},
"ConversationVariablesQuery": {
"properties": {
"conversation_id": {
"description": "Conversation ID to filter variables",
"title": "Conversation Id",
"type": "string"
}
},
"required": [
"conversation_id"
],
"title": "ConversationVariablesQuery",
"type": "object"
},
"PaginatedConversationVariable": {
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ConversationVariable"
}
}
},
"type": "object"
},
"ConversationVariable": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"value_type": {
"type": "string"
},
"value": {
"type": "object"
},
"description": {
"type": "string"
}
},
"type": "object"
},
"RuleGeneratePayload": {
"properties": {
"instruction": {
"description": "Rule generation instruction",
"title": "Instruction",
"type": "string"
},
"model_config": {
"additionalProperties": true,
"description": "Model configuration",
"title": "Model Config",
"type": "object"
},
"no_variable": {
"default": false,
"description": "Whether to exclude variables",
"title": "No Variable",
"type": "boolean"
}
},
"required": [
"instruction",
"model_config"
],
"title": "RuleGeneratePayload",
"type": "object"
},
"RuleCodeGeneratePayload": {
"properties": {
"instruction": {
"description": "Rule generation instruction",
"title": "Instruction",
"type": "string"
},
"model_config": {
"additionalProperties": true,
"description": "Model configuration",
"title": "Model Config",
"type": "object"
},
"no_variable": {
"default": false,
"description": "Whether to exclude variables",
"title": "No Variable",
"type": "boolean"
},
"code_language": {
"default": "javascript",
"description": "Programming language for code generation",
"title": "Code Language",
"type": "string"
}
},
"required": [
"instruction",
"model_config"
],
"title": "RuleCodeGeneratePayload",
"type": "object"
},
"RuleStructuredOutputPayload": {
"properties": {
"instruction": {
"description": "Structured output generation instruction",
"title": "Instruction",
"type": "string"
},
"model_config": {
"additionalProperties": true,
"description": "Model configuration",
"title": "Model Config",
"type": "object"
}
},
"required": [
"instruction",
"model_config"
],
"title": "RuleStructuredOutputPayload",
"type": "object"
},
"InstructionGeneratePayload": {
"properties": {
"flow_id": {
"description": "Workflow\/Flow ID",
"title": "Flow Id",
"type": "string"
},
"node_id": {
"default": "",
"description": "Node ID for workflow context",
"title": "Node Id",
"type": "string"
},
"current": {
"default": "",
"description": "Current instruction text",
"title": "Current",
"type": "string"
},
"language": {
"default": "javascript",
"description": "Programming language (javascript\/python)",
"title": "Language",
"type": "string"
},
"instruction": {
"description": "Instruction for generation",
"title": "Instruction",
"type": "string"
},
"model_config": {
"additionalProperties": true,
"description": "Model configuration",
"title": "Model Config",
"type": "object"
},
"ideal_output": {
"default": "",
"description": "Expected ideal output",
"title": "Ideal Output",
"type": "string"
}
},
"required": [
"flow_id",
"instruction",
"model_config"
],
"title": "InstructionGeneratePayload",
"type": "object"
},
"InstructionTemplatePayload": {
"properties": {
"type": {
"description": "Instruction template type",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
],
"title": "InstructionTemplatePayload",
"type": "object"
},
"MCPServerCreatePayload": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Server description",
"title": "Description"
},
"parameters": {
"additionalProperties": true,
"description": "Server parameters configuration",
"title": "Parameters",
"type": "object"
}
},
"required": [
"parameters"
],
"title": "MCPServerCreatePayload",
"type": "object"
},
"MCPServerUpdatePayload": {
"properties": {
"id": {
"description": "Server ID",
"title": "Id",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Server description",
"title": "Description"
},
"parameters": {
"additionalProperties": true,
"description": "Server parameters configuration",
"title": "Parameters",
"type": "object"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Server status",
"title": "Status"
}
},
"required": [
"id",
"parameters"
],
"title": "MCPServerUpdatePayload",
"type": "object"
},
"AppServer": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"server_code": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
},
"parameters": {
"type": "object"
},
"created_at": {
"type": "object"
},
"updated_at": {
"type": "object"
}
},
"type": "object"
},
"ChatMessagesQuery": {
"properties": {
"conversation_id": {
"description": "Conversation ID",
"title": "Conversation Id",
"type": "string"
},
"first_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "First message ID for pagination",
"title": "First Id"
},
"limit": {
"default": 20,
"description": "Number of messages to return (1-100)",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"required": [
"conversation_id"
],
"title": "ChatMessagesQuery",
"type": "object"
},
"MessageInfiniteScrollPagination": {
"properties": {
"limit": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageDetail"
}
}
},
"type": "object"
},
"AnnotationCountResponse": {
"properties": {
"count": {
"type": "integer",
"description": "Number of annotations"
}
},
"type": "object"
},
"SuggestedQuestionsResponse": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "string",
"description": "Suggested question"
}
}
},
"type": "object"
},
"FeedbackExportQuery": {
"properties": {
"from_source": {
"anyOf": [
{
"enum": [
"user",
"admin"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by feedback source",
"title": "From Source"
},
"rating": {
"anyOf": [
{
"enum": [
"like",
"dislike"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by rating",
"title": "Rating"
},
"has_comment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Only include feedback with comments",
"title": "Has Comment"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date (YYYY-MM-DD)",
"title": "Start Date"
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date (YYYY-MM-DD)",
"title": "End Date"
},
"format": {
"default": "csv",
"description": "Export format",
"enum": [
"csv",
"json"
],
"title": "Format",
"type": "string"
}
},
"title": "FeedbackExportQuery",
"type": "object"
},
"ModelConfigRequest": {
"properties": {
"provider": {
"type": "string",
"description": "Model provider"
},
"model": {
"type": "string",
"description": "Model name"
},
"configs": {
"type": "object",
"description": "Model configuration parameters"
},
"opening_statement": {
"type": "string",
"description": "Opening statement"
},
"suggested_questions": {
"type": "array",
"description": "Suggested questions",
"items": {
"type": "string"
}
},
"more_like_this": {
"type": "object",
"description": "More like this configuration"
},
"speech_to_text": {
"type": "object",
"description": "Speech to text configuration"
},
"text_to_speech": {
"type": "object",
"description": "Text to speech configuration"
},
"retrieval_model": {
"type": "object",
"description": "Retrieval model configuration"
},
"tools": {
"type": "array",
"description": "Available tools",
"items": {
"type": "object"
}
},
"dataset_configs": {
"type": "object",
"description": "Dataset configurations"
},
"agent_mode": {
"type": "object",
"description": "Agent mode configuration"
}
},
"type": "object"
},
"TraceProviderQuery": {
"properties": {
"tracing_provider": {
"description": "Tracing provider name",
"title": "Tracing Provider",
"type": "string"
}
},
"required": [
"tracing_provider"
],
"title": "TraceProviderQuery",
"type": "object"
},
"TraceConfigPayload": {
"properties": {
"tracing_provider": {
"description": "Tracing provider name",
"title": "Tracing Provider",
"type": "string"
},
"tracing_config": {
"additionalProperties": true,
"description": "Tracing configuration data",
"title": "Tracing Config",
"type": "object"
}
},
"required": [
"tracing_provider",
"tracing_config"
],
"title": "TraceConfigPayload",
"type": "object"
},
"AppSiteUpdatePayload": {
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"default_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Language"
},
"chat_color_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Chat Color Theme"
},
"chat_color_theme_inverted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Chat Color Theme Inverted"
},
"customize_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customize Domain"
},
"copyright": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Copyright"
},
"privacy_policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Privacy Policy"
},
"custom_disclaimer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Custom Disclaimer"
},
"customize_token_strategy": {
"anyOf": [
{
"enum": [
"must",
"allow",
"not_allow"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customize Token Strategy"
},
"prompt_public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Prompt Public"
},
"show_workflow_steps": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Show Workflow Steps"
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
}
},
"title": "AppSiteUpdatePayload",
"type": "object"
},
"AppSite": {
"properties": {
"app_id": {
"type": "string"
},
"access_token": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"icon": {
"type": "string"
},
"icon_background": {
"type": "string"
},
"description": {
"type": "string"
},
"default_language": {
"type": "string"
},
"customize_domain": {
"type": "string"
},
"copyright": {
"type": "string"
},
"privacy_policy": {
"type": "string"
},
"custom_disclaimer": {
"type": "string"
},
"customize_token_strategy": {
"type": "string"
},
"prompt_public": {
"type": "boolean"
},
"show_workflow_steps": {
"type": "boolean"
},
"use_icon_as_answer_icon": {
"type": "boolean"
}
},
"type": "object"
},
"StatisticTimeRangeQuery": {
"properties": {
"start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date (YYYY-MM-DD HH:MM)",
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date (YYYY-MM-DD HH:MM)",
"title": "End"
}
},
"title": "StatisticTimeRangeQuery",
"type": "object"
},
"WorkflowRunListQuery": {
"properties": {
"last_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Last run ID for pagination",
"title": "Last Id"
},
"limit": {
"default": 20,
"description": "Number of items per page (1-100)",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"status": {
"anyOf": [
{
"enum": [
"running",
"succeeded",
"failed",
"stopped",
"partial-succeeded"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Workflow run status filter",
"title": "Status"
},
"triggered_from": {
"anyOf": [
{
"enum": [
"debugging",
"app-run"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by trigger source: debugging or app-run",
"title": "Triggered From"
}
},
"title": "WorkflowRunListQuery",
"type": "object"
},
"AdvancedChatWorkflowRunPagination": {
"properties": {
"limit": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AdvancedChatWorkflowRunForList"
}
}
},
"type": "object"
},
"AdvancedChatWorkflowRunForList": {
"properties": {
"id": {
"type": "string"
},
"conversation_id": {
"type": "string"
},
"message_id": {
"type": "string"
},
"version": {
"type": "string"
},
"status": {
"type": "string"
},
"elapsed_time": {
"type": "number"
},
"total_tokens": {
"type": "integer"
},
"total_steps": {
"type": "integer"
},
"created_by_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_at": {
"type": "object"
},
"finished_at": {
"type": "object"
},
"exceptions_count": {
"type": "integer"
},
"retry_index": {
"type": "integer"
}
},
"type": "object"
},
"WorkflowRunExport": {
"properties": {
"status": {
"type": "string",
"description": "Export status: success\/failed"
},
"presigned_url": {
"type": "string",
"description": "Pre-signed URL for download"
},
"presigned_url_expires_at": {
"type": "string",
"description": "Pre-signed URL expiration time"
}
},
"type": "object"
},
"WorkflowRunCountQuery": {
"properties": {
"status": {
"anyOf": [
{
"enum": [
"running",
"succeeded",
"failed",
"stopped",
"partial-succeeded"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Workflow run status filter",
"title": "Status"
},
"time_range": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time range filter (e.g., 7d, 4h, 30m, 30s)",
"title": "Time Range"
},
"triggered_from": {
"anyOf": [
{
"enum": [
"debugging",
"app-run"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by trigger source: debugging or app-run",
"title": "Triggered From"
}
},
"title": "WorkflowRunCountQuery",
"type": "object"
},
"WorkflowRunCount": {
"properties": {
"total": {
"type": "integer"
},
"running": {
"type": "integer"
},
"succeeded": {
"type": "integer"
},
"failed": {
"type": "integer"
},
"stopped": {
"type": "integer"
},
"partial_succeeded": {
"type": "integer"
}
},
"type": "object"
},
"WorkflowRunPagination": {
"properties": {
"limit": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkflowRunForList"
}
}
},
"type": "object"
},
"WorkflowRunForList": {
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"status": {
"type": "string"
},
"elapsed_time": {
"type": "number"
},
"total_tokens": {
"type": "integer"
},
"total_steps": {
"type": "integer"
},
"created_by_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_at": {
"type": "object"
},
"finished_at": {
"type": "object"
},
"exceptions_count": {
"type": "integer"
},
"retry_index": {
"type": "integer"
}
},
"type": "object"
},
"WorkflowRunDetail": {
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"graph": {
"type": "object"
},
"inputs": {
"type": "object"
},
"status": {
"type": "string"
},
"outputs": {
"type": "object"
},
"error": {
"type": "string"
},
"elapsed_time": {
"type": "number"
},
"total_tokens": {
"type": "integer"
},
"total_steps": {
"type": "integer"
},
"created_by_role": {
"type": "string"
},
"created_by_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_by_end_user": {
"$ref": "#\/definitions\/SimpleEndUser"
},
"created_at": {
"type": "object"
},
"finished_at": {
"type": "object"
},
"exceptions_count": {
"type": "integer"
}
},
"type": "object"
},
"SimpleEndUser": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"is_anonymous": {
"type": "boolean"
},
"session_id": {
"type": "string"
}
},
"type": "object"
},
"WorkflowRunNodeExecutionList": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkflowRunNodeExecution"
}
}
},
"type": "object"
},
"WorkflowRunNodeExecution": {
"properties": {
"id": {
"type": "string"
},
"index": {
"type": "integer"
},
"predecessor_node_id": {
"type": "string"
},
"node_id": {
"type": "string"
},
"node_type": {
"type": "string"
},
"title": {
"type": "string"
},
"inputs": {
"type": "object"
},
"process_data": {
"type": "object"
},
"outputs": {
"type": "object"
},
"status": {
"type": "string"
},
"error": {
"type": "string"
},
"elapsed_time": {
"type": "number"
},
"execution_metadata": {
"type": "object"
},
"extras": {
"type": "object"
},
"created_at": {
"type": "object"
},
"created_by_role": {
"type": "string"
},
"created_by_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_by_end_user": {
"$ref": "#\/definitions\/SimpleEndUser"
},
"finished_at": {
"type": "object"
},
"inputs_truncated": {
"type": "boolean"
},
"outputs_truncated": {
"type": "boolean"
},
"process_data_truncated": {
"type": "boolean"
}
},
"type": "object"
},
"SyncDraftWorkflowPayload": {
"properties": {
"graph": {
"additionalProperties": true,
"title": "Graph",
"type": "object"
},
"features": {
"additionalProperties": true,
"title": "Features",
"type": "object"
},
"hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Hash"
},
"environment_variables": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Environment Variables",
"type": "array"
},
"conversation_variables": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Conversation Variables",
"type": "array"
}
},
"required": [
"graph",
"features"
],
"title": "SyncDraftWorkflowPayload",
"type": "object"
},
"Workflow": {
"properties": {
"id": {
"type": "string"
},
"graph": {
"type": "object"
},
"features": {
"type": "object"
},
"hash": {
"type": "string"
},
"version": {
"type": "string"
},
"marked_name": {
"type": "string"
},
"marked_comment": {
"type": "string"
},
"created_by": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_at": {
"type": "object"
},
"updated_by": {
"$ref": "#\/definitions\/SimpleAccount"
},
"updated_at": {
"type": "object"
},
"tool_published": {
"type": "boolean"
},
"environment_variables": {
"type": "array",
"items": {
"type": "object"
}
},
"conversation_variables": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ConversationVariable"
}
},
"rag_pipeline_variables": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PipelineVariable"
}
}
},
"type": "object"
},
"PipelineVariable": {
"properties": {
"label": {
"type": "string"
},
"variable": {
"type": "string"
},
"type": {
"type": "string"
},
"belong_to_node_id": {
"type": "string"
},
"max_length": {
"type": "integer"
},
"required": {
"type": "boolean"
},
"unit": {
"type": "string"
},
"default_value": {
"type": "object"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
},
"placeholder": {
"type": "string"
},
"tooltips": {
"type": "string"
},
"allowed_file_types": {
"type": "array",
"items": {
"type": "string"
}
},
"allow_file_extension": {
"type": "array",
"items": {
"type": "string"
}
},
"allow_file_upload_methods": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"SyncDraftWorkflowResponse": {
"properties": {
"result": {
"type": "string"
},
"hash": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"type": "object"
},
"AdvancedChatWorkflowRunPayload": {
"properties": {
"files": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Files"
},
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
},
"query": {
"default": "",
"title": "Query",
"type": "string"
},
"conversation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Conversation Id"
},
"parent_message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parent Message Id"
}
},
"title": "AdvancedChatWorkflowRunPayload",
"type": "object"
},
"IterationNodeRunPayload": {
"properties": {
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
}
},
"title": "IterationNodeRunPayload",
"type": "object"
},
"LoopNodeRunPayload": {
"properties": {
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
}
},
"title": "LoopNodeRunPayload",
"type": "object"
},
"DraftWorkflowRunPayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"datasource_type": {
"title": "Datasource Type",
"type": "string"
},
"datasource_info_list": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Datasource Info List",
"type": "array"
},
"start_node_id": {
"title": "Start Node Id",
"type": "string"
}
},
"required": [
"inputs",
"datasource_type",
"datasource_info_list",
"start_node_id"
],
"title": "DraftWorkflowRunPayload",
"type": "object"
},
"DraftWorkflowNodeRunPayload": {
"properties": {
"files": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Files"
},
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"query": {
"default": "",
"title": "Query",
"type": "string"
}
},
"required": [
"inputs"
],
"title": "DraftWorkflowNodeRunPayload",
"type": "object"
},
"PublishWorkflowPayload": {
"properties": {
"marked_name": {
"anyOf": [
{
"maxLength": 20,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Marked Name"
},
"marked_comment": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Marked Comment"
}
},
"title": "PublishWorkflowPayload",
"type": "object"
},
"DefaultBlockConfigQuery": {
"properties": {
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q"
}
},
"title": "DefaultBlockConfigQuery",
"type": "object"
},
"ConvertToWorkflowPayload": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
}
},
"title": "ConvertToWorkflowPayload",
"type": "object"
},
"WorkflowListQuery": {
"properties": {
"page": {
"default": 1,
"maximum": 99999,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 10,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"user_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "User Id"
},
"named_only": {
"default": false,
"title": "Named Only",
"type": "boolean"
}
},
"title": "WorkflowListQuery",
"type": "object"
},
"WorkflowPagination": {
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Workflow"
}
},
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"has_more": {
"type": "boolean"
}
},
"type": "object"
},
"WorkflowUpdatePayload": {
"properties": {
"marked_name": {
"anyOf": [
{
"maxLength": 20,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Marked Name"
},
"marked_comment": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Marked Comment"
}
},
"title": "WorkflowUpdatePayload",
"type": "object"
},
"DraftWorkflowTriggerRunRequest": {
"required": [
"node_id"
],
"properties": {
"node_id": {
"type": "string",
"description": "Node ID"
}
},
"type": "object"
},
"DraftWorkflowTriggerRunAllPayload": {
"properties": {
"node_ids": {
"items": {
"type": "string"
},
"title": "Node Ids",
"type": "array"
}
},
"required": [
"node_ids"
],
"title": "DraftWorkflowTriggerRunAllPayload",
"type": "object"
},
"WorkflowAppLogQuery": {
"$defs": {
"WorkflowExecutionStatus": {
"enum": [
"scheduled",
"running",
"succeeded",
"failed",
"stopped",
"partial-succeeded",
"paused"
],
"title": "WorkflowExecutionStatus",
"type": "string"
}
},
"properties": {
"keyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Search keyword for filtering logs",
"title": "Keyword"
},
"status": {
"anyOf": [
{
"$ref": "#\/definitions\/WorkflowExecutionStatus"
},
{
"type": "null"
}
],
"default": null,
"description": "Execution status filter (succeeded, failed, stopped, partial-succeeded)"
},
"created_at__before": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter logs created before this timestamp",
"title": "Created At Before"
},
"created_at__after": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter logs created after this timestamp",
"title": "Created At After"
},
"created_by_end_user_session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by end user session ID",
"title": "Created By End User Session Id"
},
"created_by_account": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by account",
"title": "Created By Account"
},
"detail": {
"default": false,
"description": "Whether to return detailed logs",
"title": "Detail",
"type": "boolean"
},
"page": {
"default": 1,
"description": "Page number (1-99999)",
"maximum": 99999,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"description": "Number of items per page (1-100)",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "WorkflowAppLogQuery",
"type": "object"
},
"WorkflowAppLogPagination": {
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkflowAppLogPartial"
}
}
},
"type": "object"
},
"WorkflowAppLogPartial": {
"properties": {
"id": {
"type": "string"
},
"workflow_run": {
"$ref": "#\/definitions\/WorkflowRunForLog"
},
"details": {
"type": "object"
},
"created_from": {
"type": "string"
},
"created_by_role": {
"type": "string"
},
"created_by_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_by_end_user": {
"$ref": "#\/definitions\/SimpleEndUser"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"WorkflowRunForLog": {
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"status": {
"type": "string"
},
"triggered_from": {
"type": "string"
},
"error": {
"type": "string"
},
"elapsed_time": {
"type": "number"
},
"total_tokens": {
"type": "integer"
},
"total_steps": {
"type": "integer"
},
"created_at": {
"type": "object"
},
"finished_at": {
"type": "object"
},
"exceptions_count": {
"type": "integer"
}
},
"type": "object"
},
"WorkflowArchivedLogPagination": {
"properties": {
"page": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"has_more": {
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkflowArchivedLogPartial"
}
}
},
"type": "object"
},
"WorkflowArchivedLogPartial": {
"properties": {
"id": {
"type": "string"
},
"workflow_run": {
"$ref": "#\/definitions\/WorkflowRunForArchivedLog"
},
"trigger_metadata": {
"type": "object"
},
"created_by_account": {
"$ref": "#\/definitions\/SimpleAccount"
},
"created_by_end_user": {
"$ref": "#\/definitions\/SimpleEndUser"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"WorkflowRunForArchivedLog": {
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"triggered_from": {
"type": "string"
},
"elapsed_time": {
"type": "number"
},
"total_tokens": {
"type": "integer"
}
},
"type": "object"
},
"WorkflowDraftVariableListQuery": {
"properties": {
"page": {
"default": 1,
"description": "Page number",
"maximum": 100000,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"description": "Items per page",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "WorkflowDraftVariableListQuery",
"type": "object"
},
"WorkflowDraftVariableListWithoutValue": {
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkflowDraftVariableWithoutValue"
}
},
"total": {
"type": "object"
}
},
"type": "object"
},
"WorkflowDraftVariableWithoutValue": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"selector": {
"type": "array",
"items": {
"type": "string"
}
},
"value_type": {
"type": "string"
},
"edited": {
"type": "boolean"
},
"visible": {
"type": "boolean"
},
"is_truncated": {
"type": "boolean"
}
},
"type": "object"
},
"WorkflowDraftVariableList": {
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkflowDraftVariable"
}
}
},
"type": "object"
},
"WorkflowDraftVariable": {
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"selector": {
"type": "array",
"items": {
"type": "string"
}
},
"value_type": {
"type": "string"
},
"edited": {
"type": "boolean"
},
"visible": {
"type": "boolean"
},
"is_truncated": {
"type": "boolean"
},
"value": {
"type": "object"
},
"full_content": {
"type": "object"
}
},
"type": "object"
},
"WorkflowDraftVariableUpdatePayload": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Variable name",
"title": "Name"
},
"value": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Variable value",
"title": "Value"
}
},
"title": "WorkflowDraftVariableUpdatePayload",
"type": "object"
},
"WorkflowStatisticQuery": {
"properties": {
"start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date and time (YYYY-MM-DD HH:MM)",
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date and time (YYYY-MM-DD HH:MM)",
"title": "End"
}
},
"title": "WorkflowStatisticQuery",
"type": "object"
},
"Parser": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"datasource_type": {
"title": "Datasource Type",
"type": "string"
},
"credential_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credential Id"
}
},
"required": [
"inputs",
"datasource_type"
],
"title": "Parser",
"type": "object"
},
"ParserEnable": {
"properties": {
"trigger_id": {
"title": "Trigger Id",
"type": "string"
},
"enable_trigger": {
"title": "Enable Trigger",
"type": "boolean"
}
},
"required": [
"trigger_id",
"enable_trigger"
],
"title": "ParserEnable",
"type": "object"
},
"ActivateCheckQuery": {
"properties": {
"workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workspace Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "ActivateCheckQuery",
"type": "object"
},
"ActivationCheckResponse": {
"properties": {
"is_valid": {
"type": "boolean",
"description": "Whether token is valid"
},
"data": {
"type": "object",
"description": "Activation data if valid"
}
},
"type": "object"
},
"ActivatePayload": {
"properties": {
"workspace_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workspace Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"token": {
"title": "Token",
"type": "string"
},
"name": {
"maxLength": 30,
"title": "Name",
"type": "string"
},
"interface_language": {
"title": "Interface Language",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"token",
"name",
"interface_language",
"timezone"
],
"title": "ActivatePayload",
"type": "object"
},
"ActivationResponse": {
"properties": {
"result": {
"type": "string",
"description": "Operation result"
}
},
"type": "object"
},
"ApiKeyAuthBindingPayload": {
"properties": {
"category": {
"title": "Category",
"type": "string"
},
"provider": {
"title": "Provider",
"type": "string"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"category",
"provider",
"credentials"
],
"title": "ApiKeyAuthBindingPayload",
"type": "object"
},
"OAuthDataSourceResponse": {
"properties": {
"data": {
"type": "object",
"description": "Authorization URL or 'internal' for internal setup"
}
},
"type": "object"
},
"OAuthDataSourceBindingResponse": {
"properties": {
"result": {
"type": "string",
"description": "Operation result"
}
},
"type": "object"
},
"OAuthDataSourceSyncResponse": {
"properties": {
"result": {
"type": "string",
"description": "Operation result"
}
},
"type": "object"
},
"ForgotPasswordSendPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
}
},
"required": [
"email"
],
"title": "ForgotPasswordSendPayload",
"type": "object"
},
"ForgotPasswordEmailResponse": {
"properties": {
"result": {
"type": "string",
"description": "Operation result"
},
"data": {
"type": "string",
"description": "Reset token"
},
"code": {
"type": "string",
"description": "Error code if account not found"
}
},
"type": "object"
},
"ForgotPasswordCheckPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"code": {
"title": "Code",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"email",
"code",
"token"
],
"title": "ForgotPasswordCheckPayload",
"type": "object"
},
"ForgotPasswordCheckResponse": {
"properties": {
"is_valid": {
"type": "boolean",
"description": "Whether code is valid"
},
"email": {
"type": "string",
"description": "Email address"
},
"token": {
"type": "string",
"description": "New reset token"
}
},
"type": "object"
},
"ForgotPasswordResetPayload": {
"properties": {
"token": {
"title": "Token",
"type": "string"
},
"new_password": {
"title": "New Password",
"type": "string"
},
"password_confirm": {
"title": "Password Confirm",
"type": "string"
}
},
"required": [
"token",
"new_password",
"password_confirm"
],
"title": "ForgotPasswordResetPayload",
"type": "object"
},
"ForgotPasswordResetResponse": {
"properties": {
"result": {
"type": "string",
"description": "Operation result"
}
},
"type": "object"
},
"LoginPayload": {
"properties": {
"email": {
"description": "Email address",
"title": "Email",
"type": "string"
},
"password": {
"description": "Password",
"title": "Password",
"type": "string"
},
"remember_me": {
"default": false,
"description": "Remember me flag",
"title": "Remember Me",
"type": "boolean"
},
"invite_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Invitation token",
"title": "Invite Token"
}
},
"required": [
"email",
"password"
],
"title": "LoginPayload",
"type": "object"
},
"EmailPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
}
},
"required": [
"email"
],
"title": "EmailPayload",
"type": "object"
},
"EmailCodeLoginPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"code": {
"title": "Code",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
}
},
"required": [
"email",
"code",
"token"
],
"title": "EmailCodeLoginPayload",
"type": "object"
},
"SyncPartnerTenantsBindingsRequest": {
"required": [
"click_id"
],
"properties": {
"click_id": {
"type": "string",
"description": "Click Id from partner referral link"
}
},
"type": "object"
},
"ComplianceDownloadQuery": {
"properties": {
"doc_name": {
"description": "Compliance document name",
"title": "Doc Name",
"type": "string"
}
},
"required": [
"doc_name"
],
"title": "ComplianceDownloadQuery",
"type": "object"
},
"NotionEstimatePayload": {
"properties": {
"notion_info_list": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Notion Info List",
"type": "array"
},
"process_rule": {
"additionalProperties": true,
"title": "Process Rule",
"type": "object"
},
"doc_form": {
"default": "text_model",
"title": "Doc Form",
"type": "string"
},
"doc_language": {
"default": "English",
"title": "Doc Language",
"type": "string"
}
},
"required": [
"notion_info_list",
"process_rule"
],
"title": "NotionEstimatePayload",
"type": "object"
},
"DatasetCreatePayload": {
"$defs": {
"DatasetPermissionEnum": {
"enum": [
"only_me",
"all_team_members",
"partial_members"
],
"title": "DatasetPermissionEnum",
"type": "string"
}
},
"properties": {
"name": {
"maxLength": 40,
"minLength": 1,
"title": "Name",
"type": "string"
},
"description": {
"default": "",
"maxLength": 400,
"title": "Description",
"type": "string"
},
"indexing_technique": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Indexing Technique"
},
"permission": {
"anyOf": [
{
"$ref": "#\/definitions\/DatasetPermissionEnum"
},
{
"type": "null"
}
],
"default": "only_me"
},
"provider": {
"default": "vendor",
"title": "Provider",
"type": "string"
},
"external_knowledge_api_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Knowledge Api Id"
},
"external_knowledge_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Knowledge Id"
}
},
"required": [
"name"
],
"title": "DatasetCreatePayload",
"type": "object"
},
"DatasetUpdatePayload": {
"$defs": {
"DatasetPermissionEnum": {
"enum": [
"only_me",
"all_team_members",
"partial_members"
],
"title": "DatasetPermissionEnum",
"type": "string"
}
},
"properties": {
"name": {
"anyOf": [
{
"maxLength": 40,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"maxLength": 400,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"permission": {
"anyOf": [
{
"$ref": "#\/definitions\/DatasetPermissionEnum"
},
{
"type": "null"
}
],
"default": null
},
"indexing_technique": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Indexing Technique"
},
"embedding_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Embedding Model"
},
"embedding_model_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Embedding Model Provider"
},
"retrieval_model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Retrieval Model"
},
"partial_member_list": {
"anyOf": [
{
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Partial Member List"
},
"external_retrieval_model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "External Retrieval Model"
},
"external_knowledge_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Knowledge Id"
},
"external_knowledge_api_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "External Knowledge Api Id"
},
"icon_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Info"
},
"is_multimodal": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Is Multimodal"
}
},
"title": "DatasetUpdatePayload",
"type": "object"
},
"DatasetDetail": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"provider": {
"type": "string"
},
"permission": {
"type": "string"
},
"data_source_type": {
"type": "string"
},
"indexing_technique": {
"type": "string"
},
"app_count": {
"type": "integer"
},
"document_count": {
"type": "integer"
},
"word_count": {
"type": "integer"
},
"created_by": {
"type": "string"
},
"author_name": {
"type": "string"
},
"created_at": {
"type": "object"
},
"updated_by": {
"type": "string"
},
"updated_at": {
"type": "object"
},
"embedding_model": {
"type": "string"
},
"embedding_model_provider": {
"type": "string"
},
"embedding_available": {
"type": "boolean"
},
"retrieval_model_dict": {
"$ref": "#\/definitions\/DatasetRetrievalModel"
},
"tags": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Tag"
}
},
"doc_form": {
"type": "string"
},
"external_knowledge_info": {
"$ref": "#\/definitions\/ExternalKnowledgeInfo"
},
"external_retrieval_model": {
"$ref": "#\/definitions\/ExternalRetrievalModel"
},
"doc_metadata": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DatasetDocMetadata"
}
},
"built_in_field_enabled": {
"type": "boolean"
},
"pipeline_id": {
"type": "string"
},
"runtime_mode": {
"type": "string"
},
"chunk_structure": {
"type": "string"
},
"icon_info": {
"$ref": "#\/definitions\/DatasetIconInfo"
},
"is_published": {
"type": "boolean"
},
"total_documents": {
"type": "integer"
},
"total_available_documents": {
"type": "integer"
},
"enable_api": {
"type": "boolean"
},
"is_multimodal": {
"type": "boolean"
}
},
"type": "object"
},
"DatasetRetrievalModel": {
"properties": {
"search_method": {
"type": "string"
},
"reranking_enable": {
"type": "boolean"
},
"reranking_mode": {
"type": "string"
},
"reranking_model": {
"$ref": "#\/definitions\/DatasetRerankingModel"
},
"weights": {
"$ref": "#\/definitions\/DatasetWeightedScore"
},
"top_k": {
"type": "integer"
},
"score_threshold_enabled": {
"type": "boolean"
},
"score_threshold": {
"type": "number"
}
},
"type": "object"
},
"DatasetRerankingModel": {
"properties": {
"reranking_provider_name": {
"type": "string"
},
"reranking_model_name": {
"type": "string"
}
},
"type": "object"
},
"DatasetWeightedScore": {
"properties": {
"weight_type": {
"type": "string"
},
"keyword_setting": {
"$ref": "#\/definitions\/DatasetKeywordSetting"
},
"vector_setting": {
"$ref": "#\/definitions\/DatasetVectorSetting"
}
},
"type": "object"
},
"DatasetKeywordSetting": {
"properties": {
"keyword_weight": {
"type": "number"
}
},
"type": "object"
},
"DatasetVectorSetting": {
"properties": {
"vector_weight": {
"type": "number"
},
"embedding_model_name": {
"type": "string"
},
"embedding_provider_name": {
"type": "string"
}
},
"type": "object"
},
"Tag": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name",
"type"
],
"title": "Tag",
"type": "object"
},
"ExternalKnowledgeInfo": {
"properties": {
"external_knowledge_id": {
"type": "string"
},
"external_knowledge_api_id": {
"type": "string"
},
"external_knowledge_api_name": {
"type": "string"
},
"external_knowledge_api_endpoint": {
"type": "string"
}
},
"type": "object"
},
"ExternalRetrievalModel": {
"properties": {
"top_k": {
"type": "integer"
},
"score_threshold": {
"type": "number"
},
"score_threshold_enabled": {
"type": "boolean"
}
},
"type": "object"
},
"DatasetDocMetadata": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"DatasetIconInfo": {
"properties": {
"icon_type": {
"type": "string"
},
"icon": {
"type": "string"
},
"icon_background": {
"type": "string"
},
"icon_url": {
"type": "string"
}
},
"type": "object"
},
"DatasetQueryDetail": {
"properties": {
"id": {
"type": "string"
},
"queries": {
"$ref": "#\/definitions\/DatasetContent"
},
"source": {
"type": "string"
},
"source_app_id": {
"type": "string"
},
"created_by_role": {
"type": "string"
},
"created_by": {
"type": "string"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"DatasetContent": {
"properties": {
"content_type": {
"type": "string"
},
"content": {
"type": "string"
},
"file_info": {
"$ref": "#\/definitions\/DatasetFileInfo"
}
},
"type": "object"
},
"DatasetFileInfo": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"extension": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"source_url": {
"type": "string"
}
},
"type": "object"
},
"IndexingEstimatePayload": {
"properties": {
"info_list": {
"additionalProperties": true,
"title": "Info List",
"type": "object"
},
"process_rule": {
"additionalProperties": true,
"title": "Process Rule",
"type": "object"
},
"indexing_technique": {
"title": "Indexing Technique",
"type": "string"
},
"doc_form": {
"default": "text_model",
"title": "Doc Form",
"type": "string"
},
"dataset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Dataset Id"
},
"doc_language": {
"default": "English",
"title": "Doc Language",
"type": "string"
}
},
"required": [
"info_list",
"process_rule",
"indexing_technique"
],
"title": "IndexingEstimatePayload",
"type": "object"
},
"RelatedAppList": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AppDetailKernel"
}
},
"total": {
"type": "integer"
}
},
"type": "object"
},
"AppDetailKernel": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"mode": {
"type": "string"
},
"icon_type": {
"type": "string"
},
"icon": {
"type": "string"
},
"icon_background": {
"type": "string"
},
"icon_url": {
"type": "object"
}
},
"type": "object"
},
"KnowledgeConfig": {
"$defs": {
"DataSource": {
"properties": {
"info_list": {
"$ref": "#\/definitions\/InfoList"
}
},
"required": [
"info_list"
],
"title": "DataSource",
"type": "object"
},
"FileInfo": {
"properties": {
"file_ids": {
"items": {
"type": "string"
},
"title": "File Ids",
"type": "array"
}
},
"required": [
"file_ids"
],
"title": "FileInfo",
"type": "object"
},
"InfoList": {
"properties": {
"data_source_type": {
"enum": [
"upload_file",
"notion_import",
"website_crawl"
],
"title": "Data Source Type",
"type": "string"
},
"notion_info_list": {
"anyOf": [
{
"items": {
"$ref": "#\/definitions\/NotionInfo"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Notion Info List"
},
"file_info_list": {
"anyOf": [
{
"$ref": "#\/definitions\/FileInfo"
},
{
"type": "null"
}
],
"default": null
},
"website_info_list": {
"anyOf": [
{
"$ref": "#\/definitions\/WebsiteInfo"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"data_source_type"
],
"title": "InfoList",
"type": "object"
},
"NotionIcon": {
"properties": {
"type": {
"title": "Type",
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"emoji": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Emoji"
}
},
"required": [
"type"
],
"title": "NotionIcon",
"type": "object"
},
"NotionInfo": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
},
"workspace_id": {
"title": "Workspace Id",
"type": "string"
},
"pages": {
"items": {
"$ref": "#\/definitions\/NotionPage"
},
"title": "Pages",
"type": "array"
}
},
"required": [
"credential_id",
"workspace_id",
"pages"
],
"title": "NotionInfo",
"type": "object"
},
"NotionPage": {
"properties": {
"page_id": {
"title": "Page Id",
"type": "string"
},
"page_name": {
"title": "Page Name",
"type": "string"
},
"page_icon": {
"anyOf": [
{
"$ref": "#\/definitions\/NotionIcon"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"page_id",
"page_name",
"type"
],
"title": "NotionPage",
"type": "object"
},
"PreProcessingRule": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"id",
"enabled"
],
"title": "PreProcessingRule",
"type": "object"
},
"ProcessRule": {
"properties": {
"mode": {
"enum": [
"automatic",
"custom",
"hierarchical"
],
"title": "Mode",
"type": "string"
},
"rules": {
"anyOf": [
{
"$ref": "#\/definitions\/Rule"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"mode"
],
"title": "ProcessRule",
"type": "object"
},
"RerankingModel": {
"properties": {
"reranking_provider_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reranking Provider Name"
},
"reranking_model_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reranking Model Name"
}
},
"title": "RerankingModel",
"type": "object"
},
"RetrievalMethod": {
"enum": [
"semantic_search",
"full_text_search",
"hybrid_search",
"keyword_search"
],
"title": "RetrievalMethod",
"type": "string"
},
"RetrievalModel": {
"properties": {
"search_method": {
"$ref": "#\/definitions\/RetrievalMethod"
},
"reranking_enable": {
"title": "Reranking Enable",
"type": "boolean"
},
"reranking_model": {
"anyOf": [
{
"$ref": "#\/definitions\/RerankingModel"
},
{
"type": "null"
}
],
"default": null
},
"reranking_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reranking Mode"
},
"top_k": {
"title": "Top K",
"type": "integer"
},
"score_threshold_enabled": {
"title": "Score Threshold Enabled",
"type": "boolean"
},
"score_threshold": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Score Threshold"
},
"weights": {
"anyOf": [
{
"$ref": "#\/definitions\/WeightModel"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"search_method",
"reranking_enable",
"top_k",
"score_threshold_enabled"
],
"title": "RetrievalModel",
"type": "object"
},
"Rule": {
"properties": {
"pre_processing_rules": {
"anyOf": [
{
"items": {
"$ref": "#\/definitions\/PreProcessingRule"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Processing Rules"
},
"segmentation": {
"anyOf": [
{
"$ref": "#\/definitions\/Segmentation"
},
{
"type": "null"
}
],
"default": null
},
"parent_mode": {
"anyOf": [
{
"enum": [
"full-doc",
"paragraph"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parent Mode"
},
"subchunk_segmentation": {
"anyOf": [
{
"$ref": "#\/definitions\/Segmentation"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Rule",
"type": "object"
},
"Segmentation": {
"properties": {
"separator": {
"default": "\n",
"title": "Separator",
"type": "string"
},
"max_tokens": {
"title": "Max Tokens",
"type": "integer"
},
"chunk_overlap": {
"default": 0,
"title": "Chunk Overlap",
"type": "integer"
}
},
"required": [
"max_tokens"
],
"title": "Segmentation",
"type": "object"
},
"WebsiteInfo": {
"properties": {
"provider": {
"title": "Provider",
"type": "string"
},
"job_id": {
"title": "Job Id",
"type": "string"
},
"urls": {
"items": {
"type": "string"
},
"title": "Urls",
"type": "array"
},
"only_main_content": {
"default": true,
"title": "Only Main Content",
"type": "boolean"
}
},
"required": [
"provider",
"job_id",
"urls"
],
"title": "WebsiteInfo",
"type": "object"
},
"WeightKeywordSetting": {
"properties": {
"keyword_weight": {
"title": "Keyword Weight",
"type": "number"
}
},
"required": [
"keyword_weight"
],
"title": "WeightKeywordSetting",
"type": "object"
},
"WeightModel": {
"properties": {
"weight_type": {
"anyOf": [
{
"enum": [
"semantic_first",
"keyword_first",
"customized"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Weight Type"
},
"vector_setting": {
"anyOf": [
{
"$ref": "#\/definitions\/WeightVectorSetting"
},
{
"type": "null"
}
],
"default": null
},
"keyword_setting": {
"anyOf": [
{
"$ref": "#\/definitions\/WeightKeywordSetting"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "WeightModel",
"type": "object"
},
"WeightVectorSetting": {
"properties": {
"vector_weight": {
"title": "Vector Weight",
"type": "number"
},
"embedding_provider_name": {
"title": "Embedding Provider Name",
"type": "string"
},
"embedding_model_name": {
"title": "Embedding Model Name",
"type": "string"
}
},
"required": [
"vector_weight",
"embedding_provider_name",
"embedding_model_name"
],
"title": "WeightVectorSetting",
"type": "object"
}
},
"properties": {
"original_document_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Original Document Id"
},
"duplicate": {
"default": true,
"title": "Duplicate",
"type": "boolean"
},
"indexing_technique": {
"enum": [
"high_quality",
"economy"
],
"title": "Indexing Technique",
"type": "string"
},
"data_source": {
"anyOf": [
{
"$ref": "#\/definitions\/DataSource"
},
{
"type": "null"
}
],
"default": null
},
"process_rule": {
"anyOf": [
{
"$ref": "#\/definitions\/ProcessRule"
},
{
"type": "null"
}
],
"default": null
},
"retrieval_model": {
"anyOf": [
{
"$ref": "#\/definitions\/RetrievalModel"
},
{
"type": "null"
}
],
"default": null
},
"doc_form": {
"default": "text_model",
"title": "Doc Form",
"type": "string"
},
"doc_language": {
"default": "English",
"title": "Doc Language",
"type": "string"
},
"embedding_model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Embedding Model"
},
"embedding_model_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Embedding Model Provider"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"is_multimodal": {
"default": false,
"title": "Is Multimodal",
"type": "boolean"
}
},
"required": [
"indexing_technique"
],
"title": "KnowledgeConfig",
"type": "object"
},
"DatasetAndDocument": {
"properties": {
"dataset": {
"$ref": "#\/definitions\/Dataset"
},
"documents": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Document"
}
},
"batch": {
"type": "string"
}
},
"type": "object"
},
"Dataset": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"permission": {
"type": "string"
},
"data_source_type": {
"type": "string"
},
"indexing_technique": {
"type": "string"
},
"created_by": {
"type": "string"
},
"created_at": {
"type": "object"
}
},
"type": "object"
},
"Document": {
"properties": {
"id": {
"type": "string"
},
"position": {
"type": "integer"
},
"data_source_type": {
"type": "string"
},
"data_source_info": {
"type": "object"
},
"data_source_detail_dict": {
"type": "object"
},
"dataset_process_rule_id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_from": {
"type": "string"
},
"created_by": {
"type": "string"
},
"created_at": {
"type": "object"
},
"tokens": {
"type": "integer"
},
"indexing_status": {
"type": "string"
},
"error": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"disabled_at": {
"type": "object"
},
"disabled_by": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"display_status": {
"type": "string"
},
"word_count": {
"type": "integer"
},
"hit_count": {
"type": "integer"
},
"doc_form": {
"type": "string"
},
"doc_metadata": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DocumentMetadata"
}
}
},
"type": "object"
},
"DocumentMetadata": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"DocumentBatchDownloadZipPayload": {
"description": "Request payload for bulk downloading documents as a zip archive.",
"properties": {
"document_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Document Ids",
"type": "array"
}
},
"required": [
"document_ids"
],
"title": "DocumentBatchDownloadZipPayload",
"type": "object"
},
"UpdateDocumentMetadataRequest": {
"properties": {
"doc_type": {
"type": "string",
"description": "Document type"
},
"doc_metadata": {
"type": "object",
"description": "Document metadata"
}
},
"type": "object"
},
"DocumentRetryPayload": {
"properties": {
"document_ids": {
"items": {
"type": "string"
},
"title": "Document Ids",
"type": "array"
}
},
"required": [
"document_ids"
],
"title": "DocumentRetryPayload",
"type": "object"
},
"DocumentRenamePayload": {
"properties": {
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "DocumentRenamePayload",
"type": "object"
},
"SegmentCreatePayload": {
"properties": {
"content": {
"title": "Content",
"type": "string"
},
"answer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Answer"
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Keywords"
},
"attachment_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Attachment Ids"
}
},
"required": [
"content"
],
"title": "SegmentCreatePayload",
"type": "object"
},
"SegmentUpdatePayload": {
"properties": {
"content": {
"title": "Content",
"type": "string"
},
"answer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Answer"
},
"keywords": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Keywords"
},
"regenerate_child_chunks": {
"default": false,
"title": "Regenerate Child Chunks",
"type": "boolean"
},
"attachment_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Attachment Ids"
}
},
"required": [
"content"
],
"title": "SegmentUpdatePayload",
"type": "object"
},
"BatchImportPayload": {
"properties": {
"upload_file_id": {
"title": "Upload File Id",
"type": "string"
}
},
"required": [
"upload_file_id"
],
"title": "BatchImportPayload",
"type": "object"
},
"ChildChunkCreatePayload": {
"properties": {
"content": {
"title": "Content",
"type": "string"
}
},
"required": [
"content"
],
"title": "ChildChunkCreatePayload",
"type": "object"
},
"ChildChunkUpdatePayload": {
"properties": {
"content": {
"title": "Content",
"type": "string"
}
},
"required": [
"content"
],
"title": "ChildChunkUpdatePayload",
"type": "object"
},
"ExternalKnowledgeApiPayload": {
"properties": {
"name": {
"maxLength": 40,
"minLength": 1,
"title": "Name",
"type": "string"
},
"settings": {
"additionalProperties": true,
"title": "Settings",
"type": "object"
}
},
"required": [
"name",
"settings"
],
"title": "ExternalKnowledgeApiPayload",
"type": "object"
},
"ExternalDatasetCreatePayload": {
"properties": {
"external_knowledge_api_id": {
"title": "External Knowledge Api Id",
"type": "string"
},
"external_knowledge_id": {
"title": "External Knowledge Id",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"description": {
"anyOf": [
{
"maxLength": 400,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"external_retrieval_model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "External Retrieval Model"
}
},
"required": [
"external_knowledge_api_id",
"external_knowledge_id",
"name"
],
"title": "ExternalDatasetCreatePayload",
"type": "object"
},
"ExternalHitTestingPayload": {
"properties": {
"query": {
"title": "Query",
"type": "string"
},
"external_retrieval_model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "External Retrieval Model"
},
"metadata_filtering_conditions": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata Filtering Conditions"
}
},
"required": [
"query"
],
"title": "ExternalHitTestingPayload",
"type": "object"
},
"BedrockRetrievalPayload": {
"properties": {
"retrieval_setting": {
"additionalProperties": true,
"title": "Retrieval Setting",
"type": "object"
},
"query": {
"title": "Query",
"type": "string"
},
"knowledge_id": {
"title": "Knowledge Id",
"type": "string"
}
},
"required": [
"retrieval_setting",
"query",
"knowledge_id"
],
"title": "BedrockRetrievalPayload",
"type": "object"
},
"HitTestingPayload": {
"properties": {
"query": {
"maxLength": 250,
"title": "Query",
"type": "string"
},
"retrieval_model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Retrieval Model"
},
"external_retrieval_model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "External Retrieval Model"
},
"attachment_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Attachment Ids"
}
},
"required": [
"query"
],
"title": "HitTestingPayload",
"type": "object"
},
"MetadataArgs": {
"properties": {
"type": {
"enum": [
"string",
"number",
"time"
],
"title": "Type",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "MetadataArgs",
"type": "object"
},
"MetadataUpdatePayload": {
"properties": {
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "MetadataUpdatePayload",
"type": "object"
},
"MetadataOperationData": {
"$defs": {
"DocumentMetadataOperation": {
"properties": {
"document_id": {
"title": "Document Id",
"type": "string"
},
"metadata_list": {
"items": {
"$ref": "#\/definitions\/MetadataDetail"
},
"title": "Metadata List",
"type": "array"
},
"partial_update": {
"default": false,
"title": "Partial Update",
"type": "boolean"
}
},
"required": [
"document_id",
"metadata_list"
],
"title": "DocumentMetadataOperation",
"type": "object"
},
"MetadataDetail": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"required": [
"id",
"name"
],
"title": "MetadataDetail",
"type": "object"
}
},
"description": "Metadata operation data",
"properties": {
"operation_data": {
"items": {
"$ref": "#\/definitions\/DocumentMetadataOperation"
},
"title": "Operation Data",
"type": "array"
}
},
"required": [
"operation_data"
],
"title": "MetadataOperationData",
"type": "object"
},
"WebsiteCrawlPayload": {
"properties": {
"provider": {
"enum": [
"firecrawl",
"watercrawl",
"jinareader"
],
"title": "Provider",
"type": "string"
},
"url": {
"title": "Url",
"type": "string"
},
"options": {
"additionalProperties": true,
"title": "Options",
"type": "object"
}
},
"required": [
"provider",
"url",
"options"
],
"title": "WebsiteCrawlPayload",
"type": "object"
},
"WebsiteCrawlStatusQuery": {
"properties": {
"provider": {
"enum": [
"firecrawl",
"watercrawl",
"jinareader"
],
"title": "Provider",
"type": "string"
}
},
"required": [
"provider"
],
"title": "WebsiteCrawlStatusQuery",
"type": "object"
},
"DatasourceCredentialPayload": {
"properties": {
"name": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"credentials"
],
"title": "DatasourceCredentialPayload",
"type": "object"
},
"DatasourceCredentialDeletePayload": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
}
},
"required": [
"credential_id"
],
"title": "DatasourceCredentialDeletePayload",
"type": "object"
},
"DatasourceCredentialUpdatePayload": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
},
"name": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"credentials": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Credentials"
}
},
"required": [
"credential_id"
],
"title": "DatasourceCredentialUpdatePayload",
"type": "object"
},
"DatasourceCustomClientPayload": {
"properties": {
"client_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Client Params"
},
"enable_oauth_custom_client": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enable Oauth Custom Client"
}
},
"title": "DatasourceCustomClientPayload",
"type": "object"
},
"DatasourceDefaultPayload": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "DatasourceDefaultPayload",
"type": "object"
},
"DatasourceUpdateNamePayload": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
},
"name": {
"maxLength": 100,
"title": "Name",
"type": "string"
}
},
"required": [
"credential_id",
"name"
],
"title": "DatasourceUpdateNamePayload",
"type": "object"
},
"Payload": {
"properties": {
"name": {
"maxLength": 40,
"minLength": 1,
"title": "Name",
"type": "string"
},
"description": {
"default": "",
"maxLength": 400,
"title": "Description",
"type": "string"
},
"icon_info": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Info"
}
},
"required": [
"name"
],
"title": "Payload",
"type": "object"
},
"RagPipelineDatasetImportPayload": {
"properties": {
"yaml_content": {
"title": "Yaml Content",
"type": "string"
}
},
"required": [
"yaml_content"
],
"title": "RagPipelineDatasetImportPayload",
"type": "object"
},
"RagPipelineImportPayload": {
"properties": {
"mode": {
"title": "Mode",
"type": "string"
},
"yaml_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Yaml Content"
},
"yaml_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Yaml Url"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"pipeline_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pipeline Id"
}
},
"required": [
"mode"
],
"title": "RagPipelineImportPayload",
"type": "object"
},
"NodeRunPayload": {
"properties": {
"inputs": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Inputs"
}
},
"title": "NodeRunPayload",
"type": "object"
},
"PublishedWorkflowRunPayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"datasource_type": {
"title": "Datasource Type",
"type": "string"
},
"datasource_info_list": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Datasource Info List",
"type": "array"
},
"start_node_id": {
"title": "Start Node Id",
"type": "string"
},
"is_preview": {
"default": false,
"title": "Is Preview",
"type": "boolean"
},
"response_mode": {
"default": "streaming",
"enum": [
"streaming",
"blocking"
],
"title": "Response Mode",
"type": "string"
},
"original_document_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Original Document Id"
}
},
"required": [
"inputs",
"datasource_type",
"datasource_info_list",
"start_node_id"
],
"title": "PublishedWorkflowRunPayload",
"type": "object"
},
"DatasourceNodeRunPayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
},
"datasource_type": {
"title": "Datasource Type",
"type": "string"
},
"credential_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credential Id"
}
},
"required": [
"inputs",
"datasource_type"
],
"title": "DatasourceNodeRunPayload",
"type": "object"
},
"NodeRunRequiredPayload": {
"properties": {
"inputs": {
"additionalProperties": true,
"title": "Inputs",
"type": "object"
}
},
"required": [
"inputs"
],
"title": "NodeRunRequiredPayload",
"type": "object"
},
"DatasourceVariablesPayload": {
"properties": {
"datasource_type": {
"title": "Datasource Type",
"type": "string"
},
"datasource_info": {
"additionalProperties": true,
"title": "Datasource Info",
"type": "object"
},
"start_node_id": {
"title": "Start Node Id",
"type": "string"
},
"start_node_title": {
"title": "Start Node Title",
"type": "string"
}
},
"required": [
"datasource_type",
"datasource_info",
"start_node_id",
"start_node_title"
],
"title": "DatasourceVariablesPayload",
"type": "object"
},
"RecommendedAppsQuery": {
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
}
},
"title": "RecommendedAppsQuery",
"type": "object"
},
"SavedMessageListQuery": {
"properties": {
"last_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Id"
},
"limit": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "SavedMessageListQuery",
"type": "object"
},
"SavedMessageCreatePayload": {
"properties": {
"message_id": {
"title": "Message Id",
"type": "string"
}
},
"required": [
"message_id"
],
"title": "SavedMessageCreatePayload",
"type": "object"
},
"TagBasePayload": {
"properties": {
"name": {
"description": "Tag name",
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"anyOf": [
{
"enum": [
"knowledge",
"app"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tag type",
"title": "Type"
}
},
"required": [
"name"
],
"title": "TagBasePayload",
"type": "object"
},
"TagBindingPayload": {
"properties": {
"tag_ids": {
"description": "Tag IDs to bind",
"items": {
"type": "string"
},
"title": "Tag Ids",
"type": "array"
},
"target_id": {
"description": "Target ID to bind tags to",
"title": "Target Id",
"type": "string"
},
"type": {
"anyOf": [
{
"enum": [
"knowledge",
"app"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tag type",
"title": "Type"
}
},
"required": [
"tag_ids",
"target_id"
],
"title": "TagBindingPayload",
"type": "object"
},
"TagBindingRemovePayload": {
"properties": {
"tag_id": {
"description": "Tag ID to remove",
"title": "Tag Id",
"type": "string"
},
"target_id": {
"description": "Target ID to unbind tag from",
"title": "Target Id",
"type": "string"
},
"type": {
"anyOf": [
{
"enum": [
"knowledge",
"app"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tag type",
"title": "Type"
}
},
"required": [
"tag_id",
"target_id"
],
"title": "TagBindingRemovePayload",
"type": "object"
},
"AccountInitPayload": {
"properties": {
"interface_language": {
"title": "Interface Language",
"type": "string"
},
"timezone": {
"title": "Timezone",
"type": "string"
},
"invitation_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invitation Code"
}
},
"required": [
"interface_language",
"timezone"
],
"title": "AccountInitPayload",
"type": "object"
},
"AccountNamePayload": {
"properties": {
"name": {
"maxLength": 30,
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "AccountNamePayload",
"type": "object"
},
"AccountAvatarPayload": {
"properties": {
"avatar": {
"title": "Avatar",
"type": "string"
}
},
"required": [
"avatar"
],
"title": "AccountAvatarPayload",
"type": "object"
},
"AccountInterfaceLanguagePayload": {
"properties": {
"interface_language": {
"title": "Interface Language",
"type": "string"
}
},
"required": [
"interface_language"
],
"title": "AccountInterfaceLanguagePayload",
"type": "object"
},
"AccountInterfaceThemePayload": {
"properties": {
"interface_theme": {
"enum": [
"light",
"dark"
],
"title": "Interface Theme",
"type": "string"
}
},
"required": [
"interface_theme"
],
"title": "AccountInterfaceThemePayload",
"type": "object"
},
"AccountTimezonePayload": {
"properties": {
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"required": [
"timezone"
],
"title": "AccountTimezonePayload",
"type": "object"
},
"AccountPasswordPayload": {
"properties": {
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Password"
},
"new_password": {
"title": "New Password",
"type": "string"
},
"repeat_new_password": {
"title": "Repeat New Password",
"type": "string"
}
},
"required": [
"new_password",
"repeat_new_password"
],
"title": "AccountPasswordPayload",
"type": "object"
},
"AccountDeletePayload": {
"properties": {
"token": {
"title": "Token",
"type": "string"
},
"code": {
"title": "Code",
"type": "string"
}
},
"required": [
"token",
"code"
],
"title": "AccountDeletePayload",
"type": "object"
},
"AccountDeletionFeedbackPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"feedback": {
"title": "Feedback",
"type": "string"
}
},
"required": [
"email",
"feedback"
],
"title": "AccountDeletionFeedbackPayload",
"type": "object"
},
"EducationActivatePayload": {
"properties": {
"token": {
"title": "Token",
"type": "string"
},
"institution": {
"title": "Institution",
"type": "string"
},
"role": {
"title": "Role",
"type": "string"
}
},
"required": [
"token",
"institution",
"role"
],
"title": "EducationActivatePayload",
"type": "object"
},
"EducationAutocompleteQuery": {
"properties": {
"keywords": {
"title": "Keywords",
"type": "string"
},
"page": {
"default": 0,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"title": "Limit",
"type": "integer"
}
},
"required": [
"keywords"
],
"title": "EducationAutocompleteQuery",
"type": "object"
},
"ChangeEmailSendPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
},
"phase": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phase"
},
"token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Token"
}
},
"required": [
"email"
],
"title": "ChangeEmailSendPayload",
"type": "object"
},
"ChangeEmailValidityPayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
},
"code": {
"title": "Code",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"email",
"code",
"token"
],
"title": "ChangeEmailValidityPayload",
"type": "object"
},
"ChangeEmailResetPayload": {
"properties": {
"new_email": {
"title": "New Email",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"new_email",
"token"
],
"title": "ChangeEmailResetPayload",
"type": "object"
},
"CheckEmailUniquePayload": {
"properties": {
"email": {
"title": "Email",
"type": "string"
}
},
"required": [
"email"
],
"title": "CheckEmailUniquePayload",
"type": "object"
},
"EndpointCreatePayload": {
"properties": {
"plugin_unique_identifier": {
"title": "Plugin Unique Identifier",
"type": "string"
},
"settings": {
"additionalProperties": true,
"title": "Settings",
"type": "object"
},
"name": {
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"plugin_unique_identifier",
"settings",
"name"
],
"title": "EndpointCreatePayload",
"type": "object"
},
"EndpointCreateResponse": {
"properties": {
"success": {
"type": "boolean",
"description": "Operation success"
}
},
"type": "object"
},
"EndpointListQuery": {
"properties": {
"page": {
"minimum": 1,
"title": "Page",
"type": "integer"
},
"page_size": {
"exclusiveMinimum": 0,
"title": "Page Size",
"type": "integer"
}
},
"required": [
"page",
"page_size"
],
"title": "EndpointListQuery",
"type": "object"
},
"EndpointListResponse": {
"properties": {
"endpoints": {
"type": "array",
"items": {
"type": "object",
"description": "Endpoint information"
}
}
},
"type": "object"
},
"EndpointListForPluginQuery": {
"properties": {
"page": {
"minimum": 1,
"title": "Page",
"type": "integer"
},
"page_size": {
"exclusiveMinimum": 0,
"title": "Page Size",
"type": "integer"
},
"plugin_id": {
"title": "Plugin Id",
"type": "string"
}
},
"required": [
"page",
"page_size",
"plugin_id"
],
"title": "EndpointListForPluginQuery",
"type": "object"
},
"PluginEndpointListResponse": {
"properties": {
"endpoints": {
"type": "array",
"items": {
"type": "object",
"description": "Endpoint information"
}
}
},
"type": "object"
},
"EndpointIdPayload": {
"properties": {
"endpoint_id": {
"title": "Endpoint Id",
"type": "string"
}
},
"required": [
"endpoint_id"
],
"title": "EndpointIdPayload",
"type": "object"
},
"EndpointDeleteResponse": {
"properties": {
"success": {
"type": "boolean",
"description": "Operation success"
}
},
"type": "object"
},
"EndpointUpdatePayload": {
"properties": {
"endpoint_id": {
"title": "Endpoint Id",
"type": "string"
},
"settings": {
"additionalProperties": true,
"title": "Settings",
"type": "object"
},
"name": {
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"endpoint_id",
"settings",
"name"
],
"title": "EndpointUpdatePayload",
"type": "object"
},
"EndpointUpdateResponse": {
"properties": {
"success": {
"type": "boolean",
"description": "Operation success"
}
},
"type": "object"
},
"EndpointEnableResponse": {
"properties": {
"success": {
"type": "boolean",
"description": "Operation success"
}
},
"type": "object"
},
"EndpointDisableResponse": {
"properties": {
"success": {
"type": "boolean",
"description": "Operation success"
}
},
"type": "object"
},
"LoadBalancingCredentialPayload": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"model",
"model_type",
"credentials"
],
"title": "LoadBalancingCredentialPayload",
"type": "object"
},
"MemberInvitePayload": {
"$defs": {
"TenantAccountRole": {
"enum": [
"owner",
"admin",
"editor",
"normal",
"dataset_operator"
],
"title": "TenantAccountRole",
"type": "string"
}
},
"properties": {
"emails": {
"items": {
"type": "string"
},
"title": "Emails",
"type": "array"
},
"role": {
"$ref": "#\/definitions\/TenantAccountRole"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
}
},
"required": [
"role"
],
"title": "MemberInvitePayload",
"type": "object"
},
"MemberRoleUpdatePayload": {
"properties": {
"role": {
"title": "Role",
"type": "string"
}
},
"required": [
"role"
],
"title": "MemberRoleUpdatePayload",
"type": "object"
},
"OwnerTransferEmailPayload": {
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Language"
}
},
"title": "OwnerTransferEmailPayload",
"type": "object"
},
"OwnerTransferCheckPayload": {
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"code",
"token"
],
"title": "OwnerTransferCheckPayload",
"type": "object"
},
"OwnerTransferPayload": {
"properties": {
"token": {
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "OwnerTransferPayload",
"type": "object"
},
"ParserModelList": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model_type": {
"anyOf": [
{
"$ref": "#\/definitions\/ModelType"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "ParserModelList",
"type": "object"
},
"ParserCredentialDelete": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
}
},
"required": [
"credential_id"
],
"title": "ParserCredentialDelete",
"type": "object"
},
"ParserCredentialCreate": {
"properties": {
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
},
"name": {
"anyOf": [
{
"maxLength": 30,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"credentials"
],
"title": "ParserCredentialCreate",
"type": "object"
},
"ParserCredentialUpdate": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
},
"name": {
"anyOf": [
{
"maxLength": 30,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"credential_id",
"credentials"
],
"title": "ParserCredentialUpdate",
"type": "object"
},
"ParserCredentialId": {
"properties": {
"credential_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credential Id"
}
},
"title": "ParserCredentialId",
"type": "object"
},
"ParserCredentialSwitch": {
"properties": {
"credential_id": {
"title": "Credential Id",
"type": "string"
}
},
"required": [
"credential_id"
],
"title": "ParserCredentialSwitch",
"type": "object"
},
"ParserCredentialValidate": {
"properties": {
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"credentials"
],
"title": "ParserCredentialValidate",
"type": "object"
},
"ParserPreferredProviderType": {
"properties": {
"preferred_provider_type": {
"enum": [
"system",
"custom"
],
"title": "Preferred Provider Type",
"type": "string"
}
},
"required": [
"preferred_provider_type"
],
"title": "ParserPreferredProviderType",
"type": "object"
},
"ParserGetDefault": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model_type": {
"$ref": "#\/definitions\/ModelType"
}
},
"required": [
"model_type"
],
"title": "ParserGetDefault",
"type": "object"
},
"ParserPostDefault": {
"$defs": {
"Inner": {
"properties": {
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Provider"
}
},
"required": [
"model_type"
],
"title": "Inner",
"type": "object"
},
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model_settings": {
"items": {
"$ref": "#\/definitions\/Inner"
},
"title": "Model Settings",
"type": "array"
}
},
"required": [
"model_settings"
],
"title": "ParserPostDefault",
"type": "object"
},
"ParserDeleteModels": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
}
},
"required": [
"model",
"model_type"
],
"title": "ParserDeleteModels",
"type": "object"
},
"ParserPostModels": {
"$defs": {
"LoadBalancingPayload": {
"properties": {
"configs": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Configs"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enabled"
}
},
"title": "LoadBalancingPayload",
"type": "object"
},
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"load_balancing": {
"anyOf": [
{
"$ref": "#\/definitions\/LoadBalancingPayload"
},
{
"type": "null"
}
],
"default": null
},
"config_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Config From"
},
"credential_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credential Id"
}
},
"required": [
"model",
"model_type"
],
"title": "ParserPostModels",
"type": "object"
},
"ParserDeleteCredential": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"credential_id": {
"title": "Credential Id",
"type": "string"
}
},
"required": [
"model",
"model_type",
"credential_id"
],
"title": "ParserDeleteCredential",
"type": "object"
},
"ParserCreateCredential": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"name": {
"anyOf": [
{
"maxLength": 30,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"model",
"model_type",
"credentials"
],
"title": "ParserCreateCredential",
"type": "object"
},
"ParserUpdateCredential": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"credential_id": {
"title": "Credential Id",
"type": "string"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
},
"name": {
"anyOf": [
{
"maxLength": 30,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"model",
"model_type",
"credential_id",
"credentials"
],
"title": "ParserUpdateCredential",
"type": "object"
},
"ParserGetCredentials": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"config_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Config From"
},
"credential_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credential Id"
}
},
"required": [
"model",
"model_type"
],
"title": "ParserGetCredentials",
"type": "object"
},
"ParserSwitch": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"credential_id": {
"title": "Credential Id",
"type": "string"
}
},
"required": [
"model",
"model_type",
"credential_id"
],
"title": "ParserSwitch",
"type": "object"
},
"ParserValidate": {
"$defs": {
"ModelType": {
"description": "Enum class for model type.",
"enum": [
"llm",
"text-embedding",
"rerank",
"speech2text",
"moderation",
"tts"
],
"title": "ModelType",
"type": "string"
}
},
"properties": {
"model": {
"title": "Model",
"type": "string"
},
"model_type": {
"$ref": "#\/definitions\/ModelType"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"model",
"model_type",
"credentials"
],
"title": "ParserValidate",
"type": "object"
},
"ParserParameter": {
"properties": {
"model": {
"title": "Model",
"type": "string"
}
},
"required": [
"model"
],
"title": "ParserParameter",
"type": "object"
},
"ParserList": {
"properties": {
"page": {
"default": 1,
"description": "Page number",
"minimum": 1,
"title": "Page",
"type": "integer"
},
"page_size": {
"default": 256,
"description": "Page size (1-256)",
"maximum": 256,
"minimum": 1,
"title": "Page Size",
"type": "integer"
}
},
"title": "ParserList",
"type": "object"
},
"ParserLatest": {
"properties": {
"plugin_ids": {
"items": {
"type": "string"
},
"title": "Plugin Ids",
"type": "array"
}
},
"required": [
"plugin_ids"
],
"title": "ParserLatest",
"type": "object"
},
"ParserIcon": {
"properties": {
"tenant_id": {
"title": "Tenant Id",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
}
},
"required": [
"tenant_id",
"filename"
],
"title": "ParserIcon",
"type": "object"
},
"ParserAsset": {
"properties": {
"plugin_unique_identifier": {
"title": "Plugin Unique Identifier",
"type": "string"
},
"file_name": {
"title": "File Name",
"type": "string"
}
},
"required": [
"plugin_unique_identifier",
"file_name"
],
"title": "ParserAsset",
"type": "object"
},
"ParserGithubUpload": {
"properties": {
"repo": {
"title": "Repo",
"type": "string"
},
"version": {
"title": "Version",
"type": "string"
},
"package": {
"title": "Package",
"type": "string"
}
},
"required": [
"repo",
"version",
"package"
],
"title": "ParserGithubUpload",
"type": "object"
},
"ParserPluginIdentifiers": {
"properties": {
"plugin_unique_identifiers": {
"items": {
"type": "string"
},
"title": "Plugin Unique Identifiers",
"type": "array"
}
},
"required": [
"plugin_unique_identifiers"
],
"title": "ParserPluginIdentifiers",
"type": "object"
},
"ParserGithubInstall": {
"properties": {
"plugin_unique_identifier": {
"title": "Plugin Unique Identifier",
"type": "string"
},
"repo": {
"title": "Repo",
"type": "string"
},
"version": {
"title": "Version",
"type": "string"
},
"package": {
"title": "Package",
"type": "string"
}
},
"required": [
"plugin_unique_identifier",
"repo",
"version",
"package"
],
"title": "ParserGithubInstall",
"type": "object"
},
"ParserPluginIdentifierQuery": {
"properties": {
"plugin_unique_identifier": {
"title": "Plugin Unique Identifier",
"type": "string"
}
},
"required": [
"plugin_unique_identifier"
],
"title": "ParserPluginIdentifierQuery",
"type": "object"
},
"ParserTasks": {
"properties": {
"page": {
"default": 1,
"description": "Page number",
"minimum": 1,
"title": "Page",
"type": "integer"
},
"page_size": {
"default": 256,
"description": "Page size (1-256)",
"maximum": 256,
"minimum": 1,
"title": "Page Size",
"type": "integer"
}
},
"title": "ParserTasks",
"type": "object"
},
"ParserMarketplaceUpgrade": {
"properties": {
"original_plugin_unique_identifier": {
"title": "Original Plugin Unique Identifier",
"type": "string"
},
"new_plugin_unique_identifier": {
"title": "New Plugin Unique Identifier",
"type": "string"
}
},
"required": [
"original_plugin_unique_identifier",
"new_plugin_unique_identifier"
],
"title": "ParserMarketplaceUpgrade",
"type": "object"
},
"ParserGithubUpgrade": {
"properties": {
"original_plugin_unique_identifier": {
"title": "Original Plugin Unique Identifier",
"type": "string"
},
"new_plugin_unique_identifier": {
"title": "New Plugin Unique Identifier",
"type": "string"
},
"repo": {
"title": "Repo",
"type": "string"
},
"version": {
"title": "Version",
"type": "string"
},
"package": {
"title": "Package",
"type": "string"
}
},
"required": [
"original_plugin_unique_identifier",
"new_plugin_unique_identifier",
"repo",
"version",
"package"
],
"title": "ParserGithubUpgrade",
"type": "object"
},
"ParserUninstall": {
"properties": {
"plugin_installation_id": {
"title": "Plugin Installation Id",
"type": "string"
}
},
"required": [
"plugin_installation_id"
],
"title": "ParserUninstall",
"type": "object"
},
"ParserPermissionChange": {
"$defs": {
"DebugPermission": {
"enum": [
"everyone",
"admins",
"noone"
],
"title": "DebugPermission",
"type": "string"
},
"InstallPermission": {
"enum": [
"everyone",
"admins",
"noone"
],
"title": "InstallPermission",
"type": "string"
}
},
"properties": {
"install_permission": {
"$ref": "#\/definitions\/InstallPermission"
},
"debug_permission": {
"$ref": "#\/definitions\/DebugPermission"
}
},
"required": [
"install_permission",
"debug_permission"
],
"title": "ParserPermissionChange",
"type": "object"
},
"ParserDynamicOptions": {
"properties": {
"plugin_id": {
"title": "Plugin Id",
"type": "string"
},
"provider": {
"title": "Provider",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"parameter": {
"title": "Parameter",
"type": "string"
},
"credential_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Credential Id"
},
"provider_type": {
"enum": [
"tool",
"trigger"
],
"title": "Provider Type",
"type": "string"
}
},
"required": [
"plugin_id",
"provider",
"action",
"parameter",
"provider_type"
],
"title": "ParserDynamicOptions",
"type": "object"
},
"ParserDynamicOptionsWithCredentials": {
"properties": {
"plugin_id": {
"title": "Plugin Id",
"type": "string"
},
"provider": {
"title": "Provider",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"parameter": {
"title": "Parameter",
"type": "string"
},
"credential_id": {
"title": "Credential Id",
"type": "string"
},
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"plugin_id",
"provider",
"action",
"parameter",
"credential_id",
"credentials"
],
"title": "ParserDynamicOptionsWithCredentials",
"type": "object"
},
"ParserPreferencesChange": {
"$defs": {
"DebugPermission": {
"enum": [
"everyone",
"admins",
"noone"
],
"title": "DebugPermission",
"type": "string"
},
"InstallPermission": {
"enum": [
"everyone",
"admins",
"noone"
],
"title": "InstallPermission",
"type": "string"
},
"PluginAutoUpgradeSettingsPayload": {
"properties": {
"strategy_setting": {
"$ref": "#\/definitions\/StrategySetting",
"default": "fix_only"
},
"upgrade_time_of_day": {
"default": 0,
"title": "Upgrade Time Of Day",
"type": "integer"
},
"upgrade_mode": {
"$ref": "#\/definitions\/UpgradeMode",
"default": "exclude"
},
"exclude_plugins": {
"items": {
"type": "string"
},
"title": "Exclude Plugins",
"type": "array"
},
"include_plugins": {
"items": {
"type": "string"
},
"title": "Include Plugins",
"type": "array"
}
},
"title": "PluginAutoUpgradeSettingsPayload",
"type": "object"
},
"PluginPermissionSettingsPayload": {
"properties": {
"install_permission": {
"$ref": "#\/definitions\/InstallPermission",
"default": "everyone"
},
"debug_permission": {
"$ref": "#\/definitions\/DebugPermission",
"default": "everyone"
}
},
"title": "PluginPermissionSettingsPayload",
"type": "object"
},
"StrategySetting": {
"enum": [
"disabled",
"fix_only",
"latest"
],
"title": "StrategySetting",
"type": "string"
},
"UpgradeMode": {
"enum": [
"all",
"partial",
"exclude"
],
"title": "UpgradeMode",
"type": "string"
}
},
"properties": {
"permission": {
"$ref": "#\/definitions\/PluginPermissionSettingsPayload"
},
"auto_upgrade": {
"$ref": "#\/definitions\/PluginAutoUpgradeSettingsPayload"
}
},
"required": [
"permission",
"auto_upgrade"
],
"title": "ParserPreferencesChange",
"type": "object"
},
"ParserExcludePlugin": {
"properties": {
"plugin_id": {
"title": "Plugin Id",
"type": "string"
}
},
"required": [
"plugin_id"
],
"title": "ParserExcludePlugin",
"type": "object"
},
"ParserReadme": {
"properties": {
"plugin_unique_identifier": {
"title": "Plugin Unique Identifier",
"type": "string"
},
"language": {
"default": "en-US",
"title": "Language",
"type": "string"
}
},
"required": [
"plugin_unique_identifier"
],
"title": "ParserReadme",
"type": "object"
},
"TriggerSubscriptionBuilderCreatePayload": {
"properties": {
"credential_type": {
"default": "unauthorized",
"title": "Credential Type",
"type": "string"
}
},
"title": "TriggerSubscriptionBuilderCreatePayload",
"type": "object"
},
"TriggerSubscriptionBuilderVerifyPayload": {
"properties": {
"credentials": {
"additionalProperties": true,
"title": "Credentials",
"type": "object"
}
},
"required": [
"credentials"
],
"title": "TriggerSubscriptionBuilderVerifyPayload",
"type": "object"
},
"TriggerSubscriptionBuilderUpdatePayload": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"parameters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Parameters"
},
"properties": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Properties"
},
"credentials": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Credentials"
}
},
"title": "TriggerSubscriptionBuilderUpdatePayload",
"type": "object"
},
"TriggerOAuthClientPayload": {
"properties": {
"client_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Client Params"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enabled"
}
},
"title": "TriggerOAuthClientPayload",
"type": "object"
},
"WorkspaceListQuery": {
"properties": {
"page": {
"default": 1,
"maximum": 99999,
"minimum": 1,
"title": "Page",
"type": "integer"
},
"limit": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
"title": "WorkspaceListQuery",
"type": "object"
},
"SwitchWorkspacePayload": {
"properties": {
"tenant_id": {
"title": "Tenant Id",
"type": "string"
}
},
"required": [
"tenant_id"
],
"title": "SwitchWorkspacePayload",
"type": "object"
},
"WorkspaceCustomConfigPayload": {
"properties": {
"remove_webapp_brand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Remove Webapp Brand"
},
"replace_webapp_logo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Replace Webapp Logo"
}
},
"title": "WorkspaceCustomConfigPayload",
"type": "object"
},
"WorkspaceInfoPayload": {
"properties": {
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "WorkspaceInfoPayload",
"type": "object"
},
"LeakedDependency": {
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "object"
},
"current_identifier": {
"type": "string"
}
},
"type": "object"
},
"AppImport": {
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"app_id": {
"type": "string"
},
"app_mode": {
"type": "string"
},
"current_dsl_version": {
"type": "string"
},
"imported_dsl_version": {
"type": "string"
},
"error": {
"type": "string"
}
},
"type": "object"
},
"AppImportCheckDependencies": {
"properties": {
"leaked_dependencies": {
"type": "array",
"items": {
"$ref": "#\/definitions\/LeakedDependency"
}
}
},
"type": "object"
},
"AnnotationReplyStatusQuery": {
"properties": {
"action": {
"enum": [
"enable",
"disable"
],
"title": "Action",
"type": "string"
}
},
"required": [
"action"
],
"title": "AnnotationReplyStatusQuery",
"type": "object"
},
"AnnotationFilePayload": {
"properties": {
"message_id": {
"description": "Message ID",
"title": "Message Id",
"type": "string"
}
},
"required": [
"message_id"
],
"title": "AnnotationFilePayload",
"type": "object"
},
"IconType": {
"enum": [
"image",
"emoji",
"link"
],
"title": "IconType",
"type": "string"
},
"RetrievalMethod": {
"enum": [
"semantic_search",
"full_text_search",
"hybrid_search",
"keyword_search"
],
"title": "RetrievalMethod",
"type": "string"
},
"WorkflowPartial": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id"
],
"title": "WorkflowPartial",
"type": "object"
},
"ModelConfigPartial": {
"properties": {
"model_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Model Dict"
},
"pre_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Prompt"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "ModelConfigPartial",
"type": "object"
},
"Site": {
"$defs": {
"IconType": {
"enum": [
"image",
"emoji",
"link"
],
"title": "IconType",
"type": "string"
}
},
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Code"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#\/definitions\/IconType"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"default_language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Language"
},
"chat_color_theme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Chat Color Theme"
},
"chat_color_theme_inverted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Chat Color Theme Inverted"
},
"customize_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customize Domain"
},
"copyright": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Copyright"
},
"privacy_policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Privacy Policy"
},
"custom_disclaimer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Custom Disclaimer"
},
"customize_token_strategy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customize Token Strategy"
},
"prompt_public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Prompt Public"
},
"app_base_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "App Base Url"
},
"show_workflow_steps": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Show Workflow Steps"
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "Site",
"type": "object"
},
"DeletedTool": {
"properties": {
"type": {
"title": "Type",
"type": "string"
},
"tool_name": {
"title": "Tool Name",
"type": "string"
},
"provider_id": {
"title": "Provider Id",
"type": "string"
}
},
"required": [
"type",
"tool_name",
"provider_id"
],
"title": "DeletedTool",
"type": "object"
},
"AppPartial": {
"$defs": {
"ModelConfigPartial": {
"properties": {
"model_dict": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Model Dict"
},
"pre_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Prompt"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"title": "ModelConfigPartial",
"type": "object"
},
"Tag": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"name",
"type"
],
"title": "Tag",
"type": "object"
},
"WorkflowPartial": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
}
},
"required": [
"id"
],
"title": "WorkflowPartial",
"type": "object"
}
},
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"max_active_requests": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Active Requests"
},
"desc_or_prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Desc Or Prompt"
},
"mode_compatible_with_agent": {
"title": "Mode Compatible With Agent",
"type": "string"
},
"icon_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Type"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon"
},
"icon_background": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Icon Background"
},
"app_model_config": {
"anyOf": [
{
"$ref": "#\/definitions\/ModelConfigPartial"
},
{
"type": "null"
}
],
"default": null
},
"workflow": {
"anyOf": [
{
"$ref": "#\/definitions\/WorkflowPartial"
},
{
"type": "null"
}
],
"default": null
},
"use_icon_as_answer_icon": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Use Icon As Answer Icon"
},
"created_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created By"
},
"created_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"updated_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated By"
},
"updated_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated At"
},
"tags": {
"items": {
"$ref": "#\/definitions\/Tag"
},
"title": "Tags",
"type": "array"
},
"access_mode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Mode"
},
"create_user_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Create User Name"
},
"author_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Name"
},
"has_draft_trigger": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Draft Trigger"
}
},
"required": [
"id",
"name",
"mode_compatible_with_agent"
],
"title": "AppPartial",
"type": "object"
},
"Segmentation": {
"properties": {
"separator": {
"default": "\n",
"title": "Separator",
"type": "string"
},
"max_tokens": {
"title": "Max Tokens",
"type": "integer"
},
"chunk_overlap": {
"default": 0,
"title": "Chunk Overlap",
"type": "integer"
}
},
"required": [
"max_tokens"
],
"title": "Segmentation",
"type": "object"
},
"PreProcessingRule": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"id",
"enabled"
],
"title": "PreProcessingRule",
"type": "object"
},
"Rule": {
"$defs": {
"PreProcessingRule": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"id",
"enabled"
],
"title": "PreProcessingRule",
"type": "object"
},
"Segmentation": {
"properties": {
"separator": {
"default": "\n",
"title": "Separator",
"type": "string"
},
"max_tokens": {
"title": "Max Tokens",
"type": "integer"
},
"chunk_overlap": {
"default": 0,
"title": "Chunk Overlap",
"type": "integer"
}
},
"required": [
"max_tokens"
],
"title": "Segmentation",
"type": "object"
}
},
"properties": {
"pre_processing_rules": {
"anyOf": [
{
"items": {
"$ref": "#\/definitions\/PreProcessingRule"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Pre Processing Rules"
},
"segmentation": {
"anyOf": [
{
"$ref": "#\/definitions\/Segmentation"
},
{
"type": "null"
}
],
"default": null
},
"parent_mode": {
"anyOf": [
{
"enum": [
"full-doc",
"paragraph"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parent Mode"
},
"subchunk_segmentation": {
"anyOf": [
{
"$ref": "#\/definitions\/Segmentation"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "Rule",
"type": "object"
},
"WeightVectorSetting": {
"properties": {
"vector_weight": {
"title": "Vector Weight",
"type": "number"
},
"embedding_provider_name": {
"title": "Embedding Provider Name",
"type": "string"
},
"embedding_model_name": {
"title": "Embedding Model Name",
"type": "string"
}
},
"required": [
"vector_weight",
"embedding_provider_name",
"embedding_model_name"
],
"title": "WeightVectorSetting",
"type": "object"
},
"WeightKeywordSetting": {
"properties": {
"keyword_weight": {
"title": "Keyword Weight",
"type": "number"
}
},
"required": [
"keyword_weight"
],
"title": "WeightKeywordSetting",
"type": "object"
},
"WeightModel": {
"$defs": {
"WeightKeywordSetting": {
"prop
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment