mirror of
https://github.com/langgenius/dify.git
synced 2026-05-30 05:37:48 +08:00
Merge branch 'main' into 4-27-app-deploy
This commit is contained in:
@ -11708,9 +11708,9 @@ Condition detail
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | No |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | No |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
@ -11721,7 +11721,7 @@ Condition detail
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | No |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
@ -11748,9 +11748,9 @@ Condition detail
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | No |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | No |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
@ -11762,7 +11762,7 @@ Condition detail
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | No |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
@ -11790,16 +11790,16 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| external_knowledge_api_endpoint | string | | Yes |
|
||||
| external_knowledge_api_id | string | | Yes |
|
||||
| external_knowledge_api_name | string | | Yes |
|
||||
| external_knowledge_id | string | | Yes |
|
||||
| external_knowledge_api_endpoint | string | | No |
|
||||
| external_knowledge_api_id | string | | No |
|
||||
| external_knowledge_api_name | string | | No |
|
||||
| external_knowledge_id | string | | No |
|
||||
|
||||
#### DatasetExternalRetrievalModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| score_threshold | number | | Yes |
|
||||
| score_threshold | number | | No |
|
||||
| score_threshold_enabled | boolean | | No |
|
||||
| top_k | integer | | Yes |
|
||||
|
||||
@ -11816,9 +11816,9 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| icon | string | | Yes |
|
||||
| icon | string | | No |
|
||||
| icon_background | string | | No |
|
||||
| icon_type | string | | Yes |
|
||||
| icon_type | string | | No |
|
||||
| icon_url | string | | No |
|
||||
|
||||
#### DatasetKeywordSetting
|
||||
@ -11831,7 +11831,7 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_weight | number | | Yes |
|
||||
| keyword_weight | number | | No |
|
||||
|
||||
#### DatasetListItemResponse
|
||||
|
||||
@ -11852,9 +11852,9 @@ Condition detail
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | No |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | No |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
@ -11866,7 +11866,7 @@ Condition detail
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | No |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
@ -12014,7 +12014,7 @@ Condition detail
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| reranking_enable | boolean | | Yes |
|
||||
| reranking_mode | string | | No |
|
||||
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | | Yes |
|
||||
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | | No |
|
||||
| score_threshold | number | | No |
|
||||
| score_threshold_enabled | boolean | | Yes |
|
||||
| search_method | string | | Yes |
|
||||
@ -12069,9 +12069,9 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| embedding_model_name | string | | Yes |
|
||||
| embedding_provider_name | string | | Yes |
|
||||
| vector_weight | number | | Yes |
|
||||
| embedding_model_name | string | | No |
|
||||
| embedding_provider_name | string | | No |
|
||||
| vector_weight | number | | No |
|
||||
|
||||
#### DatasetWeightedScore
|
||||
|
||||
@ -12085,9 +12085,9 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | | Yes |
|
||||
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | | Yes |
|
||||
| weight_type | string | | Yes |
|
||||
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | | No |
|
||||
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | | No |
|
||||
| weight_type | string | | No |
|
||||
|
||||
#### DatasourceCredentialDeletePayload
|
||||
|
||||
@ -12153,19 +12153,44 @@ Condition detail
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| DebugPermission | string | | |
|
||||
|
||||
#### DeclaredArrayItem
|
||||
|
||||
Per-item shape for an ``array``-typed declared output.
|
||||
|
||||
PRD §OUTPUT 配置框 keeps arrays one level deep on first version; nested arrays
|
||||
are rejected so the runtime type checker and JSON Schema stay easy to reason
|
||||
about. Stage 4 §4.2.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| description | string | | No |
|
||||
| type | [DeclaredOutputType](#declaredoutputtype) | | Yes |
|
||||
|
||||
#### DeclaredOutputCheckConfig
|
||||
|
||||
File-output content check via a model-based comparison against a benchmark file.
|
||||
|
||||
Per PRD §OUTPUT 配置框, output check is **file-only** and optional. Stage 4 §4.3.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| benchmark_file_ref | object | | No |
|
||||
| enabled | boolean | | No |
|
||||
| model_ref | object | | No |
|
||||
| prompt | string | | No |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### DeclaredOutputConfig
|
||||
|
||||
One declared output of a Workflow Agent Node.
|
||||
|
||||
Stage 4 normalizes the shape: ``check`` is singular (was ``checks: list`` in
|
||||
stage 3), and ``failure_strategy`` defaults to a populated value so runtime
|
||||
code can call ``output.failure_strategy.on_failure`` without None-guards.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| checks | [ [DeclaredOutputCheckConfig](#declaredoutputcheckconfig) ] | | No |
|
||||
| array_item | [DeclaredArrayItem](#declaredarrayitem) | | No |
|
||||
| check | [DeclaredOutputCheckConfig](#declaredoutputcheckconfig) | | No |
|
||||
| description | string | | No |
|
||||
| failure_strategy | [DeclaredOutputFailureStrategy](#declaredoutputfailurestrategy) | | No |
|
||||
| file | [DeclaredOutputFileConfig](#declaredoutputfileconfig) | | No |
|
||||
@ -12176,19 +12201,36 @@ Condition detail
|
||||
|
||||
#### DeclaredOutputFailureStrategy
|
||||
|
||||
Per-output failure handling.
|
||||
|
||||
A single strategy applies to both ``type_check`` and ``output_check`` failures
|
||||
(PRD does not distinguish them at the UX level). Stage 4 §4.4.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| max_retries | integer | | No |
|
||||
| on_output_check_failed | string | | No |
|
||||
| on_type_check_failed | string | | No |
|
||||
| default_value | | | No |
|
||||
| on_failure | [OutputErrorStrategy](#outputerrorstrategy) | | No |
|
||||
| retry | [DeclaredOutputRetryConfig](#declaredoutputretryconfig) | | No |
|
||||
|
||||
#### DeclaredOutputFileConfig
|
||||
|
||||
File-type output metadata. Both lists empty means "any file accepted".
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| extensions | [ string ] | | No |
|
||||
| mime_types | [ string ] | | No |
|
||||
|
||||
#### DeclaredOutputRetryConfig
|
||||
|
||||
Per-output retry configuration that mirrors ``graphon.RetryConfig`` shape.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| enabled | boolean | | No |
|
||||
| max_retries | integer | | No |
|
||||
| retry_interval_ms | integer | | No |
|
||||
|
||||
#### DeclaredOutputType
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -13584,6 +13626,18 @@ Enum class for model type.
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| result | string | Operation result | Yes |
|
||||
|
||||
#### OutputErrorStrategy
|
||||
|
||||
Per-output failure handling strategy.
|
||||
|
||||
Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of
|
||||
a Workflow Agent Node. The runtime applies the strategy after type check or
|
||||
output check fails and any configured retry attempts have been exhausted.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| OutputErrorStrategy | string | Per-output failure handling strategy. Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of a Workflow Agent Node. The runtime applies the strategy after type check or output check fails and any configured retry attempts have been exhausted. | |
|
||||
|
||||
#### OwnerTransferCheckPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|
||||
656
api/openapi/markdown/openapi-swagger.md
Normal file
656
api/openapi/markdown/openapi-swagger.md
Normal file
@ -0,0 +1,656 @@
|
||||
# OpenAPI
|
||||
User-scoped programmatic API (bearer auth)
|
||||
|
||||
## Version: 1.0
|
||||
|
||||
### Security
|
||||
**Bearer**
|
||||
|
||||
| apiKey | *API Key* |
|
||||
| ------ | --------- |
|
||||
| Description | Type: Bearer {your-api-key} |
|
||||
| In | header |
|
||||
| Name | Authorization |
|
||||
|
||||
---
|
||||
## openapi
|
||||
User-scoped operations
|
||||
|
||||
### /_health
|
||||
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
|
||||
### /_version
|
||||
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Server version | [ServerVersionResponse](#serverversionresponse) |
|
||||
|
||||
### /account
|
||||
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Account info | [AccountResponse](#accountresponse) |
|
||||
|
||||
### /account/sessions
|
||||
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Session list | [SessionListResponse](#sessionlistresponse) |
|
||||
|
||||
### /account/sessions/self
|
||||
|
||||
#### DELETE
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Session revoked | [RevokeResponse](#revokeresponse) |
|
||||
|
||||
### /account/sessions/{session_id}
|
||||
|
||||
#### DELETE
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| session_id | path | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Session revoked | [RevokeResponse](#revokeresponse) |
|
||||
|
||||
### /apps
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| limit | query | | No | integer |
|
||||
| mode | query | | No | string |
|
||||
| name | query | | No | string |
|
||||
| page | query | | No | integer |
|
||||
| tag | query | | No | string |
|
||||
| workspace_id | query | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | App list | [AppListResponse](#applistresponse) |
|
||||
|
||||
### /apps/{app_id}/describe
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
| fields | query | | No | [ string ] |
|
||||
| workspace_id | query | | No | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | App description | [AppDescribeResponse](#appdescriberesponse) |
|
||||
|
||||
### /apps/{app_id}/files/upload
|
||||
|
||||
#### POST
|
||||
##### Description
|
||||
|
||||
Upload a file to use as an input variable when running the app
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 201 | File uploaded successfully | [FileResponse](#fileresponse) |
|
||||
| 400 | Bad request — no file or filename missing | |
|
||||
| 401 | Unauthorized — invalid or expired bearer token | |
|
||||
| 413 | File too large | |
|
||||
| 415 | Unsupported file type or blocked extension | |
|
||||
|
||||
### /apps/{app_id}/form/human_input/{form_token}
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
| form_token | path | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Form definition |
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
| form_token | path | | Yes | string |
|
||||
| payload | body | | Yes | [HumanInputFormSubmitPayload](#humaninputformsubmitpayload) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Form submitted |
|
||||
|
||||
### /apps/{app_id}/run
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
| payload | body | | Yes | [AppRunRequest](#apprunrequest) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Run result (SSE stream) |
|
||||
|
||||
### /apps/{app_id}/tasks/{task_id}/events
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
| task_id | path | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | SSE event stream |
|
||||
|
||||
### /apps/{app_id}/tasks/{task_id}/stop
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| app_id | path | | Yes | string |
|
||||
| task_id | path | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Task stopped |
|
||||
|
||||
### /oauth/device/approve
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| payload | body | | Yes | [DeviceMutateRequest](#devicemutaterequest) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Approved | [DeviceMutateResponse](#devicemutateresponse) |
|
||||
|
||||
### /oauth/device/code
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| payload | body | | Yes | [DeviceCodeRequest](#devicecoderequest) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Device code created | [DeviceCodeResponse](#devicecoderesponse) |
|
||||
|
||||
### /oauth/device/deny
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| payload | body | | Yes | [DeviceMutateRequest](#devicemutaterequest) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Denied | [DeviceMutateResponse](#devicemutateresponse) |
|
||||
|
||||
### /oauth/device/lookup
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| user_code | query | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Device lookup result | [DeviceLookupResponse](#devicelookupresponse) |
|
||||
|
||||
### /oauth/device/token
|
||||
|
||||
#### POST
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| payload | body | | Yes | [DevicePollRequest](#devicepollrequest) |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
|
||||
### /permitted-external-apps
|
||||
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Permitted external apps list | [PermittedExternalAppsListResponse](#permittedexternalappslistresponse) |
|
||||
|
||||
### /workspaces
|
||||
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Workspace list | [WorkspaceListResponse](#workspacelistresponse) |
|
||||
|
||||
### /workspaces/{workspace_id}
|
||||
|
||||
#### GET
|
||||
##### Parameters
|
||||
|
||||
| Name | Located in | Description | Required | Schema |
|
||||
| ---- | ---------- | ----------- | -------- | ------ |
|
||||
| workspace_id | path | | Yes | string |
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Workspace detail | [WorkspaceDetailResponse](#workspacedetailresponse) |
|
||||
|
||||
---
|
||||
### Models
|
||||
|
||||
#### AccountPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| email | string | | Yes |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
|
||||
#### AccountResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| account | [AccountPayload](#accountpayload) | | No |
|
||||
| default_workspace_id | string | | No |
|
||||
| subject_email | string | | No |
|
||||
| subject_issuer | string | | No |
|
||||
| subject_type | string | | Yes |
|
||||
| workspaces | [ [WorkspacePayload](#workspacepayload) ] | | No |
|
||||
|
||||
#### AppDescribeInfo
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| author | string | | No |
|
||||
| description | string | | No |
|
||||
| id | string | | Yes |
|
||||
| is_agent | boolean | | No |
|
||||
| mode | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| service_api_enabled | boolean | | Yes |
|
||||
| tags | [ [TagItem](#tagitem) ] | | No |
|
||||
| updated_at | string | | No |
|
||||
|
||||
#### AppDescribeQuery
|
||||
|
||||
`?fields=` allow-list for GET /apps/<id>/describe.
|
||||
|
||||
Empty / omitted → all blocks. Unknown member → ValidationError → 422.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| fields | [ string ] | | No |
|
||||
| workspace_id | string | | No |
|
||||
|
||||
#### AppDescribeResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| info | [AppDescribeInfo](#appdescribeinfo) | | No |
|
||||
| input_schema | object | | No |
|
||||
| parameters | object | | No |
|
||||
|
||||
#### AppInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| author | string | | No |
|
||||
| description | string | | No |
|
||||
| id | string | | Yes |
|
||||
| mode | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| tags | [ [TagItem](#tagitem) ] | | No |
|
||||
|
||||
#### AppListQuery
|
||||
|
||||
mode is a closed enum.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| limit | integer | | No |
|
||||
| mode | [AppMode](#appmode) | | No |
|
||||
| name | string | | No |
|
||||
| page | integer | | No |
|
||||
| tag | string | | No |
|
||||
| workspace_id | string | | Yes |
|
||||
|
||||
#### AppListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [AppListRow](#applistrow) ] | | Yes |
|
||||
| has_more | boolean | | Yes |
|
||||
| limit | integer | | Yes |
|
||||
| page | integer | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### AppListRow
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_by_name | string | | No |
|
||||
| description | string | | No |
|
||||
| id | string | | Yes |
|
||||
| mode | [AppMode](#appmode) | | Yes |
|
||||
| name | string | | Yes |
|
||||
| tags | [ [TagItem](#tagitem) ] | | No |
|
||||
| updated_at | string | | No |
|
||||
| workspace_id | string | | No |
|
||||
| workspace_name | string | | No |
|
||||
|
||||
#### AppMode
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| AppMode | string | | |
|
||||
|
||||
#### AppRunRequest
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| auto_generate_name | boolean | | No |
|
||||
| conversation_id | string | | No |
|
||||
| files | [ object ] | | No |
|
||||
| inputs | object | | Yes |
|
||||
| query | string | | No |
|
||||
| workflow_id | string | | No |
|
||||
| workspace_id | string | | No |
|
||||
|
||||
#### DeviceCodeRequest
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| client_id | string | | Yes |
|
||||
| device_label | string | | Yes |
|
||||
|
||||
#### DeviceCodeResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| device_code | string | | Yes |
|
||||
| expires_in | integer | | Yes |
|
||||
| interval | integer | | Yes |
|
||||
| user_code | string | | Yes |
|
||||
| verification_uri | string | | Yes |
|
||||
|
||||
#### DeviceLookupQuery
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| user_code | string | | Yes |
|
||||
|
||||
#### DeviceLookupResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| client_id | string | | No |
|
||||
| expires_in_remaining | integer | | No |
|
||||
| valid | boolean | | Yes |
|
||||
|
||||
#### DeviceMutateRequest
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| user_code | string | | Yes |
|
||||
|
||||
#### DeviceMutateResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| status | string | | Yes |
|
||||
|
||||
#### DevicePollRequest
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| client_id | string | | Yes |
|
||||
| device_code | string | | Yes |
|
||||
|
||||
#### FileResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| conversation_id | string | | No |
|
||||
| created_at | integer | | No |
|
||||
| created_by | string | | No |
|
||||
| extension | string | | No |
|
||||
| file_key | string | | No |
|
||||
| id | string | | Yes |
|
||||
| mime_type | string | | No |
|
||||
| name | string | | Yes |
|
||||
| original_url | string | | No |
|
||||
| preview_url | string | | No |
|
||||
| size | integer | | Yes |
|
||||
| source_url | string | | No |
|
||||
| tenant_id | string | | No |
|
||||
| user_id | string | | No |
|
||||
|
||||
#### HumanInputFormSubmitPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| action | string | | Yes |
|
||||
| inputs | object | | Yes |
|
||||
|
||||
#### JsonValue
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| JsonValue | | | |
|
||||
|
||||
#### MessageMetadata
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| retriever_resources | [ object ] | | No |
|
||||
| usage | [UsageInfo](#usageinfo) | | No |
|
||||
|
||||
#### PermittedExternalAppsListQuery
|
||||
|
||||
Strict (extra='forbid').
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| limit | integer | | No |
|
||||
| mode | [AppMode](#appmode) | | No |
|
||||
| name | string | | No |
|
||||
| page | integer | | No |
|
||||
|
||||
#### PermittedExternalAppsListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [AppListRow](#applistrow) ] | | Yes |
|
||||
| has_more | boolean | | Yes |
|
||||
| limit | integer | | Yes |
|
||||
| page | integer | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### RevokeResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| status | string | | Yes |
|
||||
|
||||
#### ServerVersionResponse
|
||||
|
||||
Meta endpoint payload for `GET /openapi/v1/_version` — no auth required.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| edition | string | *Enum:* `"CLOUD"`, `"SELF_HOSTED"` | Yes |
|
||||
| version | string | | Yes |
|
||||
|
||||
#### SessionListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ [SessionRow](#sessionrow) ] | | Yes |
|
||||
| has_more | boolean | | Yes |
|
||||
| limit | integer | | Yes |
|
||||
| page | integer | | Yes |
|
||||
| total | integer | | Yes |
|
||||
|
||||
#### SessionRow
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| client_id | string | | Yes |
|
||||
| created_at | string | | No |
|
||||
| device_label | string | | Yes |
|
||||
| expires_at | string | | No |
|
||||
| id | string | | Yes |
|
||||
| last_used_at | string | | No |
|
||||
| prefix | string | | Yes |
|
||||
|
||||
#### TagItem
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| name | string | | Yes |
|
||||
|
||||
#### UsageInfo
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| completion_tokens | integer | | No |
|
||||
| prompt_tokens | integer | | No |
|
||||
| total_tokens | integer | | No |
|
||||
|
||||
#### WorkflowRunData
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_at | integer | | No |
|
||||
| elapsed_time | number | | No |
|
||||
| error | string | | No |
|
||||
| finished_at | integer | | No |
|
||||
| id | string | | Yes |
|
||||
| outputs | object | | No |
|
||||
| status | string | | Yes |
|
||||
| total_steps | integer | | No |
|
||||
| total_tokens | integer | | No |
|
||||
| workflow_id | string | | Yes |
|
||||
|
||||
#### WorkspaceDetailResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_at | string | | No |
|
||||
| current | boolean | | Yes |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| role | string | | Yes |
|
||||
| status | string | | Yes |
|
||||
|
||||
#### WorkspaceListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| workspaces | [ [WorkspaceSummaryResponse](#workspacesummaryresponse) ] | | Yes |
|
||||
|
||||
#### WorkspacePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| role | string | | Yes |
|
||||
|
||||
#### WorkspaceSummaryResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| current | boolean | | Yes |
|
||||
| id | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| role | string | | Yes |
|
||||
| status | string | | Yes |
|
||||
@ -2338,9 +2338,9 @@ Condition detail
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | No |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | No |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
@ -2351,7 +2351,7 @@ Condition detail
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | No |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
@ -2378,9 +2378,9 @@ Condition detail
|
||||
| embedding_model | string | | Yes |
|
||||
| embedding_model_provider | string | | Yes |
|
||||
| enable_api | boolean | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | Yes |
|
||||
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | | No |
|
||||
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | Yes |
|
||||
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | | No |
|
||||
| id | string | | Yes |
|
||||
| indexing_technique | string | | Yes |
|
||||
| is_multimodal | boolean | | Yes |
|
||||
@ -2392,7 +2392,7 @@ Condition detail
|
||||
| provider | string | | Yes |
|
||||
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | | Yes |
|
||||
| runtime_mode | string | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | Yes |
|
||||
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | | No |
|
||||
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
||||
| total_available_documents | integer | | Yes |
|
||||
| total_documents | integer | | Yes |
|
||||
@ -2412,16 +2412,16 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| external_knowledge_api_endpoint | string | | Yes |
|
||||
| external_knowledge_api_id | string | | Yes |
|
||||
| external_knowledge_api_name | string | | Yes |
|
||||
| external_knowledge_id | string | | Yes |
|
||||
| external_knowledge_api_endpoint | string | | No |
|
||||
| external_knowledge_api_id | string | | No |
|
||||
| external_knowledge_api_name | string | | No |
|
||||
| external_knowledge_id | string | | No |
|
||||
|
||||
#### DatasetExternalRetrievalModelResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| score_threshold | number | | Yes |
|
||||
| score_threshold | number | | No |
|
||||
| score_threshold_enabled | boolean | | No |
|
||||
| top_k | integer | | Yes |
|
||||
|
||||
@ -2429,16 +2429,16 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| icon | string | | Yes |
|
||||
| icon | string | | No |
|
||||
| icon_background | string | | No |
|
||||
| icon_type | string | | Yes |
|
||||
| icon_type | string | | No |
|
||||
| icon_url | string | | No |
|
||||
|
||||
#### DatasetKeywordSettingResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_weight | number | | Yes |
|
||||
| keyword_weight | number | | No |
|
||||
|
||||
#### DatasetListQuery
|
||||
|
||||
@ -2522,7 +2522,7 @@ Condition detail
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| reranking_enable | boolean | | Yes |
|
||||
| reranking_mode | string | | No |
|
||||
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | | Yes |
|
||||
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | | No |
|
||||
| score_threshold | number | | No |
|
||||
| score_threshold_enabled | boolean | | Yes |
|
||||
| search_method | string | | Yes |
|
||||
@ -2566,17 +2566,17 @@ Condition detail
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| embedding_model_name | string | | Yes |
|
||||
| embedding_provider_name | string | | Yes |
|
||||
| vector_weight | number | | Yes |
|
||||
| embedding_model_name | string | | No |
|
||||
| embedding_provider_name | string | | No |
|
||||
| vector_weight | number | | No |
|
||||
|
||||
#### DatasetWeightedScoreResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | | Yes |
|
||||
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | | Yes |
|
||||
| weight_type | string | | Yes |
|
||||
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | | No |
|
||||
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | | No |
|
||||
| weight_type | string | | No |
|
||||
|
||||
#### DatasourceNodeRunPayload
|
||||
|
||||
|
||||
Reference in New Issue
Block a user