mirror of
https://github.com/langgenius/dify.git
synced 2026-05-30 13:47:52 +08:00
Merge remote-tracking branch 'upstream/main' into feat/hitl-form-enhancement
This commit is contained in:
File diff suppressed because it is too large
Load Diff
@ -21,9 +21,9 @@ Service operations
|
||||
#### GET
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [IndexInfoResponse](#indexinforesponse) |
|
||||
|
||||
### /app/feedbacks
|
||||
|
||||
@ -264,11 +264,11 @@ Stop a running chat message generation
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Task stopped successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Task not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Task stopped successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Task not found | |
|
||||
|
||||
### /completion-messages
|
||||
|
||||
@ -318,11 +318,11 @@ Stop a running completion task
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Task stopped successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Task not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Task stopped successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Task not found | |
|
||||
|
||||
### /conversations
|
||||
|
||||
@ -875,11 +875,11 @@ Update metadata for multiple documents
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Documents metadata updated successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Documents metadata updated successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/documents/status/{action}
|
||||
|
||||
@ -914,13 +914,13 @@ Raises:
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Document status updated successfully |
|
||||
| 400 | Bad request - invalid action |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - insufficient permissions |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Document status updated successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 400 | Bad request - invalid action | |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - insufficient permissions | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/documents/{batch}/indexing-status
|
||||
|
||||
@ -1028,12 +1028,12 @@ Get a signed download URL for a document's original uploaded file
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Download URL generated successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - insufficient permissions |
|
||||
| 404 | Document or upload file not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Download URL generated successfully | [UrlResponse](#urlresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - insufficient permissions | |
|
||||
| 404 | Document or upload file not found | |
|
||||
|
||||
### /datasets/{dataset_id}/documents/{document_id}/segments
|
||||
|
||||
@ -1452,11 +1452,11 @@ Enable or disable built-in metadata field
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Action completed successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Dataset not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Action completed successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Dataset not found | |
|
||||
|
||||
### /datasets/{dataset_id}/metadata/{metadata_id}
|
||||
|
||||
@ -1655,11 +1655,11 @@ cross-tenant/app access when an end-user ID is known.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | End user retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | End user not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | End user retrieved successfully | [EndUserDetail](#enduserdetail) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | End user not found | |
|
||||
|
||||
### /files/upload
|
||||
|
||||
@ -1770,11 +1770,11 @@ Returns basic information about the application including name, description, tag
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Application info retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Application not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Application info retrieved successfully | [AppInfoResponse](#appinforesponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Application not found | |
|
||||
|
||||
### /messages
|
||||
|
||||
@ -1823,11 +1823,11 @@ Allows users to rate messages as like/dislike and provide optional feedback cont
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Feedback submitted successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Message not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Feedback submitted successfully | [ResultResponse](#resultresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Message not found | |
|
||||
|
||||
### /messages/{message_id}/suggested
|
||||
|
||||
@ -1849,13 +1849,13 @@ Returns AI-generated follow-up questions based on the message content.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Suggested questions retrieved successfully |
|
||||
| 400 | Suggested questions feature is disabled |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Message not found |
|
||||
| 500 | Internal server error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Suggested questions retrieved successfully | [SimpleResultStringListResponse](#simpleresultstringlistresponse) |
|
||||
| 400 | Suggested questions feature is disabled | |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Message not found | |
|
||||
| 500 | Internal server error | |
|
||||
|
||||
### /meta
|
||||
|
||||
@ -1911,11 +1911,11 @@ Returns the site configuration for the application including theme, icons, and t
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Site configuration retrieved successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 403 | Forbidden - site not found or tenant archived |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Site configuration retrieved successfully | [Site](#site) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 403 | Forbidden - site not found or tenant archived | |
|
||||
|
||||
### /text-to-audio
|
||||
|
||||
@ -2068,11 +2068,11 @@ Stop a running workflow task
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Task stopped successfully |
|
||||
| 401 | Unauthorized - invalid API token |
|
||||
| 404 | Task not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Task stopped successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 401 | Unauthorized - invalid API token | |
|
||||
| 404 | Task not found | |
|
||||
|
||||
### /workflows/{workflow_id}/run
|
||||
|
||||
@ -2167,6 +2167,16 @@ Returns a list of available models for the specified model type.
|
||||
| embedding_provider_name | string | Embedding provider name | Yes |
|
||||
| score_threshold | number | Score threshold for annotation matching | Yes |
|
||||
|
||||
#### AppInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| author_name | string | | Yes |
|
||||
| description | string | | Yes |
|
||||
| mode | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| tags | [ string ] | | Yes |
|
||||
|
||||
#### ChatRequestPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -2386,6 +2396,27 @@ Request payload for bulk downloading documents as a zip archive.
|
||||
| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
|
||||
| text | string | | No |
|
||||
|
||||
#### EndUserDetail
|
||||
|
||||
Full EndUser record for API responses.
|
||||
|
||||
Note: The SQLAlchemy model defines an `is_anonymous` property for Flask-Login semantics
|
||||
(always False). The database column is exposed as `_is_anonymous`, so this DTO maps
|
||||
`is_anonymous` from `_is_anonymous` to return the stored value.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_id | string | | No |
|
||||
| created_at | dateTime | | Yes |
|
||||
| external_user_id | string | | No |
|
||||
| id | string | | Yes |
|
||||
| is_anonymous | boolean | | Yes |
|
||||
| name | string | | No |
|
||||
| session_id | string | | Yes |
|
||||
| tenant_id | string | | Yes |
|
||||
| type | string | | Yes |
|
||||
| updated_at | dateTime | | Yes |
|
||||
|
||||
#### FeedbackListQuery
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -2434,6 +2465,14 @@ Request payload for bulk downloading documents as a zip archive.
|
||||
| action | string | | Yes |
|
||||
| inputs | object | Submitted human input values keyed by output variable name. Use a string for paragraph or select input values, a file mapping for file inputs, and a list of file mappings for file-list inputs. Local file mappings use `transfer_method=local_file` with `upload_file_id`; remote file mappings use `transfer_method=remote_url` with `url` or `remote_url`. | Yes |
|
||||
|
||||
#### IndexInfoResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| api_version | string | | Yes |
|
||||
| server_version | string | | Yes |
|
||||
| welcome | string | | Yes |
|
||||
|
||||
#### JsonValue
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -2525,6 +2564,12 @@ Metadata operation data
|
||||
| reranking_model_name | string | | No |
|
||||
| reranking_provider_name | string | | No |
|
||||
|
||||
#### ResultResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### RetrievalMethod
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -2610,6 +2655,38 @@ Metadata operation data
|
||||
| session_id | string | | No |
|
||||
| type | string | | Yes |
|
||||
|
||||
#### SimpleResultResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### SimpleResultStringListResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ string ] | | Yes |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### Site
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| chat_color_theme | string | | No |
|
||||
| chat_color_theme_inverted | boolean | | Yes |
|
||||
| copyright | string | | No |
|
||||
| custom_disclaimer | string | | No |
|
||||
| default_language | string | | Yes |
|
||||
| description | string | | No |
|
||||
| icon | string | | No |
|
||||
| icon_background | string | | No |
|
||||
| icon_type | string | | No |
|
||||
| icon_url | string | | Yes |
|
||||
| privacy_policy | string | | No |
|
||||
| show_workflow_steps | boolean | | Yes |
|
||||
| title | string | | Yes |
|
||||
| use_icon_as_answer_icon | boolean | | Yes |
|
||||
|
||||
#### TagBindingPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -2655,6 +2732,12 @@ Accept the legacy single-tag Service API payload while exposing a normalized tag
|
||||
| text | string | Text to convert to audio | No |
|
||||
| voice | string | Voice to use for TTS | No |
|
||||
|
||||
#### UrlResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| url | string | | Yes |
|
||||
|
||||
#### WeightKeywordSetting
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|
||||
@ -78,14 +78,14 @@ Stop a running chat message task.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Task Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Task Not Found | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /completion-messages
|
||||
|
||||
@ -126,14 +126,14 @@ Stop a running completion message task.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Task Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Task Not Found | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /conversations
|
||||
|
||||
@ -227,14 +227,14 @@ Pin a specific conversation to keep it at the top of the list.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Conversation pinned successfully |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Conversation Not Found or Not a Chat App |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Conversation pinned successfully | [ResultResponse](#resultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Conversation Not Found or Not a Chat App | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /conversations/{c_id}/unpin
|
||||
|
||||
@ -251,14 +251,14 @@ Unpin a specific conversation to remove it from the top of the list.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Conversation unpinned successfully |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Conversation Not Found or Not a Chat App |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Conversation unpinned successfully | [ResultResponse](#resultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Conversation Not Found or Not a Chat App | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /email-code-login
|
||||
|
||||
@ -275,11 +275,11 @@ Send email verification code for login
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Email code sent successfully |
|
||||
| 400 | Bad request - invalid email format |
|
||||
| 404 | Account not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Email code sent successfully | [SimpleResultDataResponse](#simpleresultdataresponse) |
|
||||
| 400 | Bad request - invalid email format | |
|
||||
| 404 | Account not found | |
|
||||
|
||||
### /email-code-login/validity
|
||||
|
||||
@ -296,12 +296,12 @@ Verify email code and complete login
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Email code verified and login successful |
|
||||
| 400 | Bad request - invalid code or token |
|
||||
| 401 | Invalid token or expired code |
|
||||
| 404 | Account not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Email code verified and login successful | [AccessTokenResultResponse](#accesstokenresultresponse) |
|
||||
| 400 | Bad request - invalid code or token | |
|
||||
| 401 | Invalid token or expired code | |
|
||||
| 404 | Account not found | |
|
||||
|
||||
### /files/upload
|
||||
|
||||
@ -359,12 +359,12 @@ Send password reset email
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Password reset email sent successfully |
|
||||
| 400 | Bad request - invalid email format |
|
||||
| 404 | Account not found |
|
||||
| 429 | Too many requests - rate limit exceeded |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Password reset email sent successfully | [SimpleResultDataResponse](#simpleresultdataresponse) |
|
||||
| 400 | Bad request - invalid email format | |
|
||||
| 404 | Account not found | |
|
||||
| 429 | Too many requests - rate limit exceeded | |
|
||||
|
||||
### /forgot-password/resets
|
||||
|
||||
@ -381,12 +381,12 @@ Reset user password with verification token
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Password reset successfully |
|
||||
| 400 | Bad request - invalid parameters or password mismatch |
|
||||
| 401 | Invalid or expired token |
|
||||
| 404 | Account not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Password reset successfully | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 400 | Bad request - invalid parameters or password mismatch | |
|
||||
| 401 | Invalid or expired token | |
|
||||
| 404 | Account not found | |
|
||||
|
||||
### /forgot-password/validity
|
||||
|
||||
@ -403,11 +403,11 @@ Verify password reset token validity
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Token is valid |
|
||||
| 400 | Bad request - invalid token format |
|
||||
| 401 | Invalid or expired token |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Token is valid | [VerificationTokenResponse](#verificationtokenresponse) |
|
||||
| 400 | Bad request - invalid token format | |
|
||||
| 401 | Invalid or expired token | |
|
||||
|
||||
### /form/human_input/files/remote-upload
|
||||
|
||||
@ -529,13 +529,13 @@ Authenticate user for web application access
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Authentication successful |
|
||||
| 400 | Bad request - invalid email or password format |
|
||||
| 401 | Authentication failed - email or password mismatch |
|
||||
| 403 | Account banned or login disabled |
|
||||
| 404 | Account not found |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Authentication successful | [AccessTokenResultResponse](#accesstokenresultresponse) |
|
||||
| 400 | Bad request - invalid email or password format | |
|
||||
| 401 | Authentication failed - email or password mismatch | |
|
||||
| 403 | Account banned or login disabled | |
|
||||
| 404 | Account not found | |
|
||||
|
||||
### /login/status
|
||||
|
||||
@ -546,10 +546,10 @@ Check login status
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Login status |
|
||||
| 401 | Login status |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Login status | [LoginStatusResponse](#loginstatusresponse) |
|
||||
| 401 | Login status | |
|
||||
|
||||
### /logout
|
||||
|
||||
@ -560,9 +560,9 @@ Logout user from web application
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Logout successful |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Logout successful | [SimpleResultResponse](#simpleresultresponse) |
|
||||
|
||||
### /messages
|
||||
|
||||
@ -607,14 +607,14 @@ Submit feedback (like/dislike) for a specific message.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Feedback submitted successfully |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Message Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Feedback submitted successfully | [ResultResponse](#resultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Message Not Found | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /messages/{message_id}/more-like-this
|
||||
|
||||
@ -656,14 +656,14 @@ Get suggested follow-up questions after a message (chat apps only).
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 400 | Bad Request - Not a chat app or feature disabled |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Message Not Found or Conversation Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [SuggestedQuestionsResponse](#suggestedquestionsresponse) |
|
||||
| 400 | Bad Request - Not a chat app or feature disabled | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Message Not Found or Conversation Not Found | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /meta
|
||||
|
||||
@ -840,14 +840,14 @@ Save a specific message for later reference.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Message saved successfully |
|
||||
| 400 | Bad Request - Not a completion app |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Message Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Message saved successfully | [ResultResponse](#resultresponse) |
|
||||
| 400 | Bad Request - Not a completion app | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Message Not Found | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /saved-messages/{message_id}
|
||||
|
||||
@ -923,10 +923,10 @@ Only non-sensitive configuration data should be returned by this endpoint.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | System features retrieved successfully |
|
||||
| 500 | Internal server error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | System features retrieved successfully | [SystemFeatureModel](#systemfeaturemodel) |
|
||||
| 500 | Internal server error | |
|
||||
|
||||
### /text-to-audio
|
||||
|
||||
@ -971,11 +971,11 @@ Retrieve the access mode for a web application (public or restricted).
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 400 | Bad Request |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [AccessModeResponse](#accessmoderesponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /webapp/permission
|
||||
|
||||
@ -992,12 +992,12 @@ Check if user has permission to access a web application.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [BooleanResultResponse](#booleanresultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
### /workflows/run
|
||||
|
||||
@ -1046,14 +1046,14 @@ Stop a running workflow task.
|
||||
|
||||
##### Responses
|
||||
|
||||
| Code | Description |
|
||||
| ---- | ----------- |
|
||||
| 200 | Success |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 403 | Forbidden |
|
||||
| 404 | Task Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description | Schema |
|
||||
| ---- | ----------- | ------ |
|
||||
| 200 | Success | [SimpleResultResponse](#simpleresultresponse) |
|
||||
| 400 | Bad Request | |
|
||||
| 401 | Unauthorized | |
|
||||
| 403 | Forbidden | |
|
||||
| 404 | Task Not Found | |
|
||||
| 500 | Internal Server Error | |
|
||||
|
||||
---
|
||||
## default
|
||||
@ -1087,6 +1087,25 @@ Returns Server-Sent Events stream.
|
||||
---
|
||||
### Models
|
||||
|
||||
#### AccessModeResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| accessMode | string | | Yes |
|
||||
|
||||
#### AccessTokenData
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| access_token | string | | Yes |
|
||||
|
||||
#### AccessTokenResultResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [AccessTokenData](#accesstokendata) | | Yes |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### AppAccessModeQuery
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -1094,6 +1113,22 @@ Returns Server-Sent Events stream.
|
||||
| appCode | string | Application code | No |
|
||||
| appId | string | Application ID | No |
|
||||
|
||||
#### BooleanResultResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| result | boolean | | Yes |
|
||||
|
||||
#### BrandingModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| application_title | string | | Yes |
|
||||
| enabled | boolean | | Yes |
|
||||
| favicon | string | | Yes |
|
||||
| login_page_logo | string | | Yes |
|
||||
| workspace_logo | string | | Yes |
|
||||
|
||||
#### ChatMessagePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -1170,14 +1205,14 @@ Returns Server-Sent Events stream.
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| created_at | integer | | No |
|
||||
| created_by | string | | No |
|
||||
| extension | string | | No |
|
||||
| created_at | integer | | Yes |
|
||||
| created_by | string | | Yes |
|
||||
| extension | string | | Yes |
|
||||
| id | string | | Yes |
|
||||
| mime_type | string | | No |
|
||||
| mime_type | string | | Yes |
|
||||
| name | string | | Yes |
|
||||
| size | integer | | Yes |
|
||||
| url | string | | No |
|
||||
| url | string | | Yes |
|
||||
|
||||
#### ForgotPasswordCheckPayload
|
||||
|
||||
@ -1202,18 +1237,31 @@ Returns Server-Sent Events stream.
|
||||
| email | string | | Yes |
|
||||
| language | string | | No |
|
||||
|
||||
#### HumanInputRemoteFileUploadPayload
|
||||
#### LicenseLimitationModel
|
||||
|
||||
- enabled: whether this limit is enforced
|
||||
- size: current usage count
|
||||
- limit: maximum allowed count; 0 means unlimited
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| url | string (uri) | Remote file URL | Yes |
|
||||
| enabled | boolean | Whether this limit is currently active | Yes |
|
||||
| limit | integer | Maximum number of resources allowed; 0 means no limit | Yes |
|
||||
| size | integer | Number of resources already consumed | Yes |
|
||||
|
||||
#### HumanInputUploadTokenResponse
|
||||
#### LicenseModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| expires_at | integer | | Yes |
|
||||
| upload_token | string | | Yes |
|
||||
| expired_at | string | | Yes |
|
||||
| status | [LicenseStatus](#licensestatus) | | Yes |
|
||||
| workspaces | [LicenseLimitationModel](#licenselimitationmodel) | | Yes |
|
||||
|
||||
#### LicenseStatus
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| LicenseStatus | string | | |
|
||||
|
||||
#### LoginPayload
|
||||
|
||||
@ -1222,6 +1270,13 @@ Returns Server-Sent Events stream.
|
||||
| email | string | | Yes |
|
||||
| password | string | | Yes |
|
||||
|
||||
#### LoginStatusResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_logged_in | boolean | | Yes |
|
||||
| logged_in | boolean | | Yes |
|
||||
|
||||
#### MessageFeedbackPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -1243,6 +1298,25 @@ Returns Server-Sent Events stream.
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| response_mode | string | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | Yes |
|
||||
|
||||
#### PluginInstallationPermissionModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| plugin_installation_scope | [PluginInstallationScope](#plugininstallationscope) | | Yes |
|
||||
| restrict_to_marketplace_only | boolean | | Yes |
|
||||
|
||||
#### PluginInstallationScope
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| PluginInstallationScope | string | | |
|
||||
|
||||
#### PluginManagerModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| enabled | boolean | | Yes |
|
||||
|
||||
#### RemoteFileInfo
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -1256,6 +1330,12 @@ Returns Server-Sent Events stream.
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| url | string (uri) | Remote file URL | Yes |
|
||||
|
||||
#### ResultResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### SavedMessageCreatePayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -1269,6 +1349,52 @@ Returns Server-Sent Events stream.
|
||||
| last_id | string | | No |
|
||||
| limit | integer | | No |
|
||||
|
||||
#### SimpleResultDataResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | string | | Yes |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### SimpleResultResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| result | string | | Yes |
|
||||
|
||||
#### SuggestedQuestionsResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| data | [ string ] | | Yes |
|
||||
|
||||
#### SystemFeatureModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| app_dsl_version | string | | Yes |
|
||||
| branding | [BrandingModel](#brandingmodel) | | Yes |
|
||||
| enable_change_email | boolean | | Yes |
|
||||
| enable_collaboration_mode | boolean | | Yes |
|
||||
| enable_creators_platform | boolean | | Yes |
|
||||
| enable_email_code_login | boolean | | Yes |
|
||||
| enable_email_password_login | boolean | | Yes |
|
||||
| enable_explore_banner | boolean | | Yes |
|
||||
| enable_marketplace | boolean | | Yes |
|
||||
| enable_social_oauth_login | boolean | | Yes |
|
||||
| enable_trial_app | boolean | | Yes |
|
||||
| is_allow_create_workspace | boolean | | Yes |
|
||||
| is_allow_register | boolean | | Yes |
|
||||
| is_email_setup | boolean | | Yes |
|
||||
| license | [LicenseModel](#licensemodel) | | Yes |
|
||||
| max_plugin_package_size | integer | | Yes |
|
||||
| plugin_installation_permission | [PluginInstallationPermissionModel](#plugininstallationpermissionmodel) | | Yes |
|
||||
| plugin_manager | [PluginManagerModel](#pluginmanagermodel) | | Yes |
|
||||
| sso_enforced_for_signin | boolean | | Yes |
|
||||
| sso_enforced_for_signin_protocol | string | | Yes |
|
||||
| trial_models | [ string ] | | Yes |
|
||||
| webapp_auth | [WebAppAuthModel](#webappauthmodel) | | Yes |
|
||||
|
||||
#### TextToAudioPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
@ -1278,6 +1404,30 @@ Returns Server-Sent Events stream.
|
||||
| text | string | Text to convert to audio | No |
|
||||
| voice | string | Voice to use for TTS | No |
|
||||
|
||||
#### VerificationTokenResponse
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| email | string | | Yes |
|
||||
| is_valid | boolean | | Yes |
|
||||
| token | string | | Yes |
|
||||
|
||||
#### WebAppAuthModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| allow_email_code_login | boolean | | Yes |
|
||||
| allow_email_password_login | boolean | | Yes |
|
||||
| allow_sso | boolean | | Yes |
|
||||
| enabled | boolean | | Yes |
|
||||
| sso_config | [WebAppAuthSSOModel](#webappauthssomodel) | | Yes |
|
||||
|
||||
#### WebAppAuthSSOModel
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
| ---- | ---- | ----------- | -------- |
|
||||
| protocol | string | | Yes |
|
||||
|
||||
#### WorkflowRunPayload
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|
||||
Reference in New Issue
Block a user