Console API
Console management APIs for app configuration, monitoring, and administration
Version: 1.0
Available authorizations
Bearer (HTTP, bearer)
Use the Service API key as a Bearer token in the Authorization header.
Bearer format: API_KEY
console
Console management API operations
[GET] /account/avatar
Get account avatar url
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| avatar |
query |
Avatar file ID |
Yes |
string |
Responses
[POST] /account/avatar
DEPRECATED
Deprecated. Use PATCH /account/profile instead.
Request Body
Responses
[POST] /account/change-email
Request Body
Responses
[POST] /account/change-email/check-email-unique
Request Body
Responses
[POST] /account/change-email/reset
Request Body
Responses
[POST] /account/change-email/validity
Request Body
Responses
[POST] /account/delete
Request Body
Responses
[POST] /account/delete/feedback
Request Body
Responses
[GET] /account/delete/verify
Responses
[GET] /account/education
Responses
[POST] /account/education
Request Body
Responses
[GET] /account/education/autocomplete
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| keywords |
query |
|
Yes |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer |
Responses
[GET] /account/education/verify
Responses
[POST] /account/init
Request Body
Responses
[GET] /account/integrates
Responses
[POST] /account/interface-language
DEPRECATED
Deprecated. Use PATCH /account/profile instead.
Request Body
Responses
[POST] /account/interface-theme
DEPRECATED
Deprecated. Use PATCH /account/profile instead.
Request Body
Responses
[POST] /account/name
DEPRECATED
Deprecated. Use PATCH /account/profile instead.
Request Body
Responses
[POST] /account/password
Request Body
Responses
[GET] /account/profile
Responses
[PATCH] /account/profile
Request Body
Responses
[POST] /account/timezone
DEPRECATED
Deprecated. Use PATCH /account/profile instead.
Request Body
Responses
[POST] /activate
Accept an invitation without letting an existing session act for another account
Activate account with invitation token
Token-only activation remains available for legacy clients. When the request already
carries a console session, that session must belong to the account encoded in the
invitation before the token is consumed or tenant membership is changed.
Request Body
Responses
[GET] /activate/check
Check if activation token is valid
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| email |
query |
|
No |
string |
| token |
query |
|
Yes |
string |
| workspace_id |
query |
|
No |
string |
Responses
[GET] /agent
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| creator_ids |
query |
Filter by creator account IDs |
No |
[ string ] |
| is_created_by_me |
query |
Filter by creator |
No |
boolean |
| limit |
query |
Page size (1-100) |
No |
integer,
Default: 20 |
| mode |
query |
App mode filter |
No |
string,
Available values: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow",
Default: all |
| name |
query |
Filter by app name |
No |
string |
| openapi_visible |
query |
Only return apps with API access enabled |
No |
boolean |
| page |
query |
Page number (1-99999) |
No |
integer,
Default: 1 |
| publication_status |
query |
Filter by published or draft Agent configuration status |
No |
string,
Available values: "drafts", "published" |
| sort_by |
query |
Sort apps by last modified, recently created, or earliest created |
No |
string,
Available values: "earliest_created", "last_modified", "recently_created",
Default: last_modified |
| tag_ids |
query |
Filter by tag IDs |
No |
[ string ] |
Responses
[POST] /agent
Request Body
Responses
[GET] /agent/invite-options
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
query |
Workflow app id for in-current-workflow markers |
No |
string |
| keyword |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
Responses
[DELETE] /agent/{agent_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /agent/{agent_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/api-access
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/api-enable
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/api-keys
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 200 |
Agent service API keys |
application/json: ApiKeyList
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /agent/{agent_id}/api-keys
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /agent/{agent_id}/api-keys/{api_key_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| api_key_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Agent service API key deleted |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /agent/{agent_id}/audio-to-text
Transcribe audio using the current Agent debug configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "draft_type": string,
Available values: "debug_build", "draft",
Default: draft, "file": binary }
|
Responses
[POST] /agent/{agent_id}/build-chat/finalize
Run a build-draft Agent App turn that asks the agent to push config updates
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
Responses
[DELETE] /agent/{agent_id}/build-draft
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}/build-draft
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /agent/{agent_id}/build-draft
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /agent/{agent_id}/build-draft/apply
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/build-draft/checkout
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/chat-messages
Get Agent App chat messages for a conversation with pagination
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| conversation_id |
query |
Conversation ID |
Yes |
string |
| first_id |
query |
First message ID for pagination |
No |
string |
| limit |
query |
Number of messages to return (1-100) |
No |
integer,
Default: 20 |
Responses
[GET] /agent/{agent_id}/chat-messages/{message_id}/suggested-questions
Get suggested questions for an Agent App message
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| message_id |
path |
Message ID |
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/chat-messages/{task_id}/stop
Stop a running Agent App chat message generation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| task_id |
path |
Task ID to stop |
Yes |
string |
Responses
[GET] /agent/{agent_id}/composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /agent/{agent_id}/composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/composer/candidates
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/composer/validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/config/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[POST] /agent/{agent_id}/config/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Request Body
Responses
[DELETE] /agent/{agent_id}/config/files/{name}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config file name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/files/{name}/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config file name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/files/{name}/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config file name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/manifest
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/skills
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[POST] /agent/{agent_id}/config/skills/upload
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary }
|
Responses
[DELETE] /agent/{agent_id}/config/skills/{name}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/skills/{name}/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/skills/{name}/files/content
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /agent/{agent_id}/config/skills/{name}/files/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| path |
query |
Normalized zip member path inside the skill package |
Yes |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/skills/{name}/files/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| path |
query |
Normalized zip member path inside the skill package |
Yes |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /agent/{agent_id}/config/skills/{name}/inspect
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[POST] /agent/{agent_id}/copy
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /agent/{agent_id}/debug-conversation/refresh
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/features
Update an Agent App's presentation features (opener, follow-up, citations, ...)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /agent/{agent_id}/feedbacks
Create or update Agent App message feedback
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/log-sources
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}/logs
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| keyword |
query |
Search query, answer, or conversation name |
No |
string |
| limit |
query |
Page size |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| sort_by |
query |
Sort by created_at or updated_at |
No |
string,
Default: updated_at |
| sort_order |
query |
Sort order: asc or desc |
No |
string,
Default: desc |
| source |
query |
Deprecated single source filter |
No |
string |
| sources |
query |
Filter by one or more source IDs, e.g. webapp:<app_id> or workflow:<app_id>. Exact workflow:<app_id>:<workflow_id>::<node_id> IDs remain supported. |
No |
[ string ] |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
| status |
query |
Deprecated single status filter |
No |
string |
| statuses |
query |
Filter by one or more of success, failed, paused |
No |
[ string ] |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}/logs/{conversation_id}/messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| keyword |
query |
Search query, answer, or conversation name |
No |
string |
| limit |
query |
Page size |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| sort_by |
query |
Sort by created_at or updated_at |
No |
string,
Default: updated_at |
| sort_order |
query |
Sort order: asc or desc |
No |
string,
Default: desc |
| source |
query |
Deprecated single source filter |
No |
string |
| sources |
query |
Filter by one or more source IDs, e.g. webapp:<app_id> or workflow:<app_id>. Exact workflow:<app_id>:<workflow_id>::<node_id> IDs remain supported. |
No |
[ string ] |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
| status |
query |
Deprecated single status filter |
No |
string |
| statuses |
query |
Filter by one or more of success, failed, paused |
No |
[ string ] |
| agent_id |
path |
|
Yes |
string (uuid) |
| conversation_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}/messages/{message_id}
Get Agent App message details by ID
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| message_id |
path |
Message ID |
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/publish
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/referencing-workflows
List workflow apps that reference this Agent App's bound Agent (read-only)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}/sandbox
Get basic information for an Agent App conversation sandbox
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| caller_id |
query |
Agent App caller ID |
Yes |
string |
| caller_type |
query |
|
Yes |
string,
Available values: "build_draft", "conversation" |
Responses
[GET] /agent/{agent_id}/sandbox/files
List a directory in an Agent App conversation sandbox
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| caller_id |
query |
Agent App caller ID |
Yes |
string |
| caller_type |
query |
|
Yes |
string,
Available values: "build_draft", "conversation" |
| path |
query |
Binding path: relative paths start in Workspace; exact ~ and paths beginning with ~/ start in Home; ~user is an ordinary relative path from Workspace; absolute paths remain absolute; .. and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction |
No |
string,
Default: . |
Responses
[POST] /agent/{agent_id}/sandbox/files/download
Create a ToolFile from one Agent App Binding file and return its download URL
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/sandbox/files/read
Read a text/binary preview file in an Agent App conversation sandbox
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| caller_id |
query |
Agent App caller ID |
Yes |
string |
| caller_type |
query |
|
Yes |
string,
Available values: "build_draft", "conversation" |
| path |
query |
Binding path: relative paths start in Workspace; exact ~ and paths beginning with ~/ start in Home; ~user is an ordinary relative path from Workspace; absolute paths remain absolute; .. and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction |
Yes |
string |
Responses
[GET] /agent/{agent_id}/statistics/summary
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| source |
query |
Filter by a structured webapp:<app_id> or workflow:<app_id> source ID. Legacy invoke sources and exact workflow version/node source IDs remain supported. |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/text-to-audio
Preview an Agent TTS voice or read an Agent chat message
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /agent/{agent_id}/text-to-audio/voices
Get available TTS voices for an Agent and language
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
Agent ID |
Yes |
string (uuid) |
| language |
query |
Language code |
Yes |
string |
Responses
[GET] /agent/{agent_id}/versions
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /agent/{agent_id}/versions/{version_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| version_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /agent/{agent_id}/versions/{version_id}/restore
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| version_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /all-workspaces
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
Responses
[GET] /api-based-extension
Get all API-based extensions for current tenant
Responses
[POST] /api-based-extension
Create a new API-based extension
Request Body
Responses
[DELETE] /api-based-extension/{id}
Delete API-based extension
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
Extension ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Extension deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /api-based-extension/{id}
Get API-based extension by ID
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
Extension ID |
Yes |
string (uuid) |
Responses
[POST] /api-based-extension/{id}
Update API-based extension
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
Extension ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /api-key-auth/data-source
Responses
[POST] /api-key-auth/data-source/binding
Request Body
Responses
[DELETE] /api-key-auth/data-source/{binding_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| binding_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Binding deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /app-dsl-version
Get current app DSL version for workflow clipboard compatibility
Get current app DSL version
Responses
[GET] /app/prompt-templates
Get advanced prompt templates based on app mode and model configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_mode |
query |
Application mode |
Yes |
string |
| has_context |
query |
Whether has context |
No |
string,
Default: true |
| model_mode |
query |
Model mode |
Yes |
string |
| model_name |
query |
Model name |
Yes |
string |
Responses
[GET] /apps
Get list of applications with pagination and filtering
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| creator_ids |
query |
Filter by creator account IDs |
No |
[ string ] |
| is_created_by_me |
query |
Filter by creator |
No |
boolean |
| limit |
query |
Page size (1-100) |
No |
integer,
Default: 20 |
| mode |
query |
App mode filter |
No |
string,
Available values: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow",
Default: all |
| name |
query |
Filter by app name |
No |
string |
| openapi_visible |
query |
Only return apps with API access enabled |
No |
boolean |
| page |
query |
Page number (1-99999) |
No |
integer,
Default: 1 |
| sort_by |
query |
Sort apps by last modified, recently created, or earliest created |
No |
string,
Available values: "earliest_created", "last_modified", "recently_created",
Default: last_modified |
| tag_ids |
query |
Filter by tag IDs |
No |
[ string ] |
Responses
[POST] /apps
Create a new application
Request Body
Responses
[POST] /apps/imports
Request Body
| Required |
Schema |
| Yes |
application/json: AppImportPayload
multipart/form-data: { "app_id": string, "description": string, "file": binary, "icon": string, "icon_background": string, "icon_type": string, "name": string }
|
Responses
[GET] /apps/imports/{app_id}/check-dependencies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string |
Responses
[POST] /apps/imports/{import_id}/confirm
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| import_id |
path |
|
Yes |
string |
Responses
[GET] /apps/recent
Get recently modified apps for the home Continue Work section
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| limit |
query |
Number of recently modified apps to return (1-8) |
No |
integer,
Default: 8 |
Responses
[GET] /apps/starred
Get applications starred by the current account
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| creator_ids |
query |
Filter by creator account IDs |
No |
[ string ] |
| is_created_by_me |
query |
Filter by creator |
No |
boolean |
| limit |
query |
Page size (1-100) |
No |
integer,
Default: 20 |
| mode |
query |
App mode filter |
No |
string,
Available values: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow",
Default: all |
| name |
query |
Filter by app name |
No |
string |
| openapi_visible |
query |
Only return apps with API access enabled |
No |
boolean |
| page |
query |
Page number (1-99999) |
No |
integer,
Default: 1 |
| sort_by |
query |
Sort apps by last modified, recently created, or earliest created |
No |
string,
Available values: "earliest_created", "last_modified", "recently_created",
Default: last_modified |
| tag_ids |
query |
Filter by tag IDs |
No |
[ string ] |
Responses
[POST] /apps/workflows/online-users
Get workflow online users
Request Body
Responses
[DELETE] /apps/{app_id}
Delete application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
App deleted successfully |
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /apps/{app_id}
Get application details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[PUT] /apps/{app_id}
Update application details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/advanced-chat/workflow-runs
Get advanced chat app workflow run list
Get advanced chat workflow run list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| last_id |
query |
Last run ID for pagination |
No |
string |
| limit |
query |
Number of items per page (1-100) |
No |
integer,
Default: 20 |
| status |
query |
Workflow run status filter |
No |
string,
Available values: "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| triggered_from |
query |
Filter by trigger source: debugging or app-run. Default: debugging |
No |
string,
Available values: "app-run", "debugging" |
Responses
[GET] /apps/{app_id}/advanced-chat/workflow-runs/count
Get advanced chat workflow runs count statistics
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| status |
query |
Workflow run status filter |
No |
string,
Available values: "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| time_range |
query |
Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. |
No |
string |
| triggered_from |
query |
Filter by trigger source: debugging or app-run. Default: debugging |
No |
string,
Available values: "app-run", "debugging" |
Responses
[POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/preview
Preview human input form content and placeholders
Get human input form preview for advanced chat workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/run
Submit human input form preview
Submit human input form preview for advanced chat workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/advanced-chat/workflows/draft/iteration/nodes/{node_id}/run
Run draft workflow iteration node
Run draft workflow iteration node for advanced chat
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/advanced-chat/workflows/draft/loop/nodes/{node_id}/run
Run draft workflow loop node
Run draft workflow loop node for advanced chat
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/advanced-chat/workflows/draft/run
Run draft workflow
Run draft workflow for advanced chat application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/agent/config/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[POST] /apps/{app_id}/agent/config/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Request Body
Responses
[DELETE] /apps/{app_id}/agent/config/files/{name}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config file name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/files/{name}/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config file name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/files/{name}/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config file name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/manifest
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/skills
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[POST] /apps/{app_id}/agent/config/skills/upload
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary }
|
Responses
[DELETE] /apps/{app_id}/agent/config/skills/{name}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/skills/{name}/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/skills/{name}/files/content
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /apps/{app_id}/agent/config/skills/{name}/files/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| path |
query |
Normalized zip member path inside the skill package |
Yes |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/skills/{name}/files/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| path |
query |
Normalized zip member path inside the skill package |
Yes |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/config/skills/{name}/inspect
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| name |
path |
Config skill name |
Yes |
string |
| draft_type |
query |
Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft |
No |
string,
Available values: "debug_build", "draft" |
| node_id |
query |
Workflow node ID (workflow composer variant) |
No |
string |
| version_id |
query |
Published snapshot ID for read-only version view |
No |
string |
Responses
[GET] /apps/{app_id}/agent/logs
Get agent logs
Get agent execution logs for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
query |
Conversation UUID |
Yes |
string |
| message_id |
query |
Message UUID |
Yes |
string |
Responses
[POST] /apps/{app_id}/annotation-reply/{action}
Enable or disable annotation reply for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
Action to perform (enable/disable) |
Yes |
string |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/annotation-reply/{action}/status/{job_id}
Get status of annotation reply action job
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
Action type |
Yes |
string |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| job_id |
path |
Job ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/annotation-setting
Get annotation settings for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/annotation-settings/{annotation_setting_id}
Update annotation settings for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| annotation_setting_id |
path |
Annotation setting ID |
Yes |
string (uuid) |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /apps/{app_id}/annotations
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| annotation_id |
query |
Annotation IDs to delete; omitting it clears all annotations of the app |
No |
[ string ] |
Responses
| Code |
Description |
Schema |
| 204 |
Annotations deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /apps/{app_id}/annotations
Get annotations for an app with pagination
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| keyword |
query |
Search keyword |
No |
string |
| limit |
query |
Page size |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
Responses
| Code |
Description |
Schema |
| 200 |
Annotations retrieved successfully |
application/json: AnnotationList
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/annotations
Create a new annotation for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 201 |
Annotation created successfully |
application/json: Annotation
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/annotations/batch-import
Batch import annotations from CSV file with rate limiting and security checks
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/annotations/batch-import-status/{job_id}
Get status of batch import job
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| job_id |
path |
Job ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/annotations/count
Get count of message annotations for the app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/annotations/export
Export all annotations for an app with CSV injection protection
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[DELETE] /apps/{app_id}/annotations/{annotation_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| annotation_id |
path |
|
Yes |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Annotation deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/annotations/{annotation_id}
Update or delete an annotation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| annotation_id |
path |
Annotation ID |
Yes |
string (uuid) |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Annotation updated successfully |
application/json: Annotation
|
| 204 |
Annotation deleted successfully |
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /apps/{app_id}/annotations/{annotation_id}/hit-histories
Get hit histories for an annotation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| annotation_id |
path |
Annotation ID |
Yes |
string (uuid) |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| limit |
query |
Page size |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
Responses
[POST] /apps/{app_id}/api-enable
Enable or disable app API
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
API status updated successfully |
application/json: AppDetail
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/audio-to-text
Transcript audio to text for chat messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
App ID |
Yes |
string (uuid) |
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary }
|
Responses
[GET] /apps/{app_id}/chat-conversations
Get chat conversations with pagination, filtering and summary
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| annotation_status |
query |
Annotation status filter |
No |
string,
Available values: "all", "annotated", "not_annotated",
Default: all |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| keyword |
query |
Search keyword |
No |
string |
| limit |
query |
Page size (1-100) |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| sort_by |
query |
Sort field and direction |
No |
string,
Available values: "-created_at", "-updated_at", "created_at", "updated_at",
Default: -updated_at |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[DELETE] /apps/{app_id}/chat-conversations/{conversation_id}
Delete a chat conversation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
path |
Conversation ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/chat-conversations/{conversation_id}
Get chat conversation details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
path |
Conversation ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/chat-messages
Get chat messages for a conversation with pagination
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
query |
Conversation ID |
Yes |
string |
| first_id |
query |
First message ID for pagination |
No |
string |
| limit |
query |
Number of messages to return (1-100) |
No |
integer,
Default: 20 |
Responses
[GET] /apps/{app_id}/chat-messages/{message_id}/suggested-questions
Get suggested questions for a message
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| message_id |
path |
Message ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/chat-messages/{task_id}/stop
Stop a running chat message generation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| task_id |
path |
Task ID to stop |
Yes |
string |
Responses
[GET] /apps/{app_id}/completion-conversations
Get completion conversations with pagination and filtering
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| annotation_status |
query |
Annotation status filter |
No |
string,
Available values: "all", "annotated", "not_annotated",
Default: all |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| keyword |
query |
Search keyword |
No |
string |
| limit |
query |
Page size (1-100) |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[DELETE] /apps/{app_id}/completion-conversations/{conversation_id}
Delete a completion conversation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
path |
Conversation ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/completion-conversations/{conversation_id}
Get completion conversation details with messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
path |
Conversation ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/completion-messages
Generate completion message for debugging
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/completion-messages/{task_id}/stop
Stop a running completion message generation
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| task_id |
path |
Task ID to stop |
Yes |
string |
Responses
[GET] /apps/{app_id}/conversation-variables
Get conversation variables for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| conversation_id |
query |
Conversation ID to filter variables |
Yes |
string |
Responses
[POST] /apps/{app_id}/convert-to-workflow
Convert basic mode of chatbot app to workflow mode
Convert application to workflow mode
Convert expert mode of chatbot app to workflow mode
Convert Completion App to Workflow App
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/copy
Create a copy of an existing application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID to copy |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/export
Export application configuration as DSL
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID to export |
Yes |
string (uuid) |
| format |
query |
Export format; defaults to ifpkg for all Apps |
No |
string,
Available values: "ifpkg", "yaml" |
| include_secret |
query |
Include secrets in export |
No |
boolean |
| version_id |
query |
Published Agent version ID to export; requires a paid plan on Cloud. If omitted, exports the shared draft, falling back to the active snapshot when no draft exists. |
No |
string (uuid) |
| workflow_id |
query |
Specific workflow ID to export |
No |
string |
Responses
[POST] /apps/{app_id}/feedbacks
Create or update message feedback (like/dislike)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/icon
Update application icon
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Icon updated successfully |
application/json: AppDetail
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /apps/{app_id}/messages/{message_id}
Get message details by ID
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| message_id |
path |
Message ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/model-config
Modify the app model config and dataset joins in one request transaction
Update application model configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/name
Check if app name is available
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Name availability checked |
application/json: AppDetail
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/publish-to-creators-platform
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/server
Get MCP server configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/server
Create MCP server configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[PUT] /apps/{app_id}/server
Update MCP server configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/server/refresh
Refresh MCP server configuration and regenerate server code
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
App ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/site
Update application site configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/site-enable
Enable or disable app site
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Site status updated successfully |
application/json: AppDetail
|
| 403 |
Insufficient permissions |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/site/access-token-reset
Reset access token for application site
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[DELETE] /apps/{app_id}/star
Remove the current account's star from an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/star
Star an application for the current account
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/statistics/average-response-time
Get average response time statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/average-session-interactions
Get average session interaction statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/daily-conversations
Get daily conversation statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/daily-end-users
Get daily terminal/end-user statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/daily-messages
Get daily message statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/token-costs
Get daily token cost statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/tokens-per-second
Get tokens per second statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/statistics/user-satisfaction-rate
Get user satisfaction rate statistics for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[POST] /apps/{app_id}/text-to-audio
Convert text to speech for chat messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
App ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/text-to-audio/voices
Get available TTS voices for a specific language
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
App ID |
Yes |
string (uuid) |
| language |
query |
Language code |
Yes |
string |
Responses
[GET] /apps/{app_id}/trace
Get app tracing configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 200 |
Trace configuration retrieved successfully |
application/json: AppTraceResponse
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{app_id}/trace
Update app tracing configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /apps/{app_id}/trace-config
Delete an existing trace app configuration
Delete an existing tracing configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| tracing_provider |
query |
Tracing provider name |
Yes |
string |
Responses
[GET] /apps/{app_id}/trace-config
Get tracing configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| tracing_provider |
query |
Tracing provider name |
Yes |
string |
Responses
[PATCH] /apps/{app_id}/trace-config
Update an existing trace app configuration
Update an existing tracing configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/trace-config
Create a new trace app configuration
Create a new tracing configuration for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/trigger-enable
Update app trigger (enable/disable)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/triggers
Get app triggers list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflow-app-logs
Get workflow app logs
Get workflow application execution logs
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| created_at__after |
query |
Filter logs created after this timestamp |
No |
dateTime |
| created_at__before |
query |
Filter logs created before this timestamp |
No |
dateTime |
| created_by_account |
query |
Filter by account |
No |
string |
| created_by_end_user_session_id |
query |
Filter by end user session ID |
No |
string |
| detail |
query |
Whether to return detailed logs |
No |
boolean |
| keyword |
query |
Search keyword for filtering logs |
No |
string |
| limit |
query |
Number of items per page (1-100) |
No |
integer,
Default: 20 |
| page |
query |
Page number (1-99999) |
No |
integer,
Default: 1 |
| status |
query |
Execution status filter |
No |
string,
Available values: "failed", "partial-succeeded", "paused", "running", "scheduled", "stopped", "succeeded" |
Responses
[GET] /apps/{app_id}/workflow-runs
Get workflow run list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| last_id |
query |
Last run ID for pagination |
No |
string |
| limit |
query |
Number of items per page (1-100) |
No |
integer,
Default: 20 |
| status |
query |
Workflow run status filter |
No |
string,
Available values: "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| triggered_from |
query |
Filter by trigger source: debugging or app-run. Default: debugging |
No |
string,
Available values: "app-run", "debugging" |
Responses
[GET] /apps/{app_id}/workflow-runs/count
Get workflow runs count statistics
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| status |
query |
Workflow run status filter |
No |
string,
Available values: "failed", "partial-succeeded", "running", "stopped", "succeeded" |
| time_range |
query |
Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. |
No |
string |
| triggered_from |
query |
Filter by trigger source: debugging or app-run. Default: debugging |
No |
string,
Available values: "app-run", "debugging" |
Responses
[POST] /apps/{app_id}/workflow-runs/tasks/{task_id}/stop
Stop workflow task
Stop running workflow task
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| task_id |
path |
Task ID |
Yes |
string |
Responses
[GET] /apps/{app_id}/workflow-runs/{run_id}
Get workflow run detail
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflow-runs/{run_id}/node-executions
Get workflow run node execution list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files
List a directory in a workflow Agent node sandbox
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Workflow Agent node ID |
Yes |
string |
| workflow_run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
| node_execution_id |
query |
Workflow node execution ID |
Yes |
string |
| path |
query |
Binding path: relative paths start in Workspace; exact ~ and paths beginning with ~/ start in Home; ~user is an ordinary relative path from Workspace; absolute paths remain absolute; .. and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction |
No |
string,
Default: . |
Responses
[POST] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files/download
Create a ToolFile from one workflow Agent Binding file and return its download URL
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
| workflow_run_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files/read
Read a text/binary preview file in a workflow Agent node sandbox
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Workflow Agent node ID |
Yes |
string |
| workflow_run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
| node_execution_id |
query |
Workflow node execution ID |
Yes |
string |
| path |
query |
Binding path: relative paths start in Workspace; exact ~ and paths beginning with ~/ start in Home; ~user is an ordinary relative path from Workspace; absolute paths remain absolute; .. and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction |
Yes |
string |
Responses
Get all comments for a workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
Create a new workflow comment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
Get all users in current tenant for mentions
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
Delete a workflow comment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
Responses
Get a specific workflow comment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
Responses
Update a workflow comment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
Request Body
Responses
Add a reply to a workflow comment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
Request Body
Responses
Delete a comment reply
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
| reply_id |
path |
Reply ID |
Yes |
string |
Responses
Update a comment reply
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
| reply_id |
path |
Reply ID |
Yes |
string |
Request Body
Responses
Resolve a workflow comment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| comment_id |
path |
Comment ID |
Yes |
string |
Responses
[GET] /apps/{app_id}/workflow/statistics/average-app-interactions
Get workflow average app interaction statistics
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date and time (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date and time (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/workflow/statistics/daily-conversations
Get workflow daily runs statistics
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date and time (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date and time (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/workflow/statistics/daily-terminals
Get workflow daily terminals statistics
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date and time (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date and time (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/workflow/statistics/token-costs
Get workflow daily token cost statistics
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| end |
query |
End date and time (YYYY-MM-DD HH:MM) |
No |
string |
| start |
query |
Start date and time (YYYY-MM-DD HH:MM) |
No |
string |
Responses
[GET] /apps/{app_id}/workflows
Get published workflows
Get all published workflows for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| limit |
query |
|
No |
integer,
Default: 10 |
| named_only |
query |
|
No |
boolean |
| page |
query |
|
No |
integer,
Default: 1 |
| user_id |
query |
|
No |
string |
Responses
[GET] /apps/{app_id}/workflows/default-workflow-block-configs
Get default block config
Get default block configurations for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/default-workflow-block-configs/{block_type}
Get default block config
Get default block configuration by type
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| block_type |
path |
Block type |
Yes |
string |
| q |
query |
|
No |
string |
Responses
[GET] /apps/{app_id}/workflows/draft
Get draft workflow
Get draft workflow for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/workflows/draft
Sync draft workflow
Sync draft workflow configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/workflows/draft/conversation-variables
Get conversation variables for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/workflows/draft/conversation-variables
Update conversation variables for workflow draft
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/workflows/draft/environment-variables
Get draft workflow
Get environment variables for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/workflows/draft/environment-variables
Update environment variables for workflow draft
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/features
Update draft workflow features
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/delivery-test
Test human input delivery
Test human input delivery for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/preview
Preview human input form content and placeholders
Get human input form preview for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/run
Submit human input form preview
Submit human input form preview for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/iteration/nodes/{node_id}/run
Run draft workflow iteration node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/loop/nodes/{node_id}/run
Run draft workflow loop node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snapshot_id |
query |
|
No |
string |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Responses
[PUT] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/candidates
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Responses
[POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/copy-from-roster
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/impact
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/save-to-roster
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/last-run
Get last run result for draft workflow node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Responses
[POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/run
Run draft workflow node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/trigger/run
Poll for trigger events and execute single node when event arrives
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Responses
[DELETE] /apps/{app_id}/workflows/draft/nodes/{node_id}/variables
Delete all variables for a specific node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| node_id |
path |
|
Yes |
string |
Responses
[GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/variables
Get variables for a specific node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID |
Yes |
string |
Responses
[POST] /apps/{app_id}/workflows/draft/run
Run draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs
Snapshot of every node's declared outputs for a draft workflow run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/events
Server-Sent Events stream of inspector deltas for a draft workflow run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}
One node's declared outputs for a draft workflow run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID inside the workflow graph |
Yes |
string |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
Full value for one declared output, including signed download URL for files.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID inside the workflow graph |
Yes |
string |
| output_name |
path |
Declared output name as exposed by Composer |
Yes |
string |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/draft/system-variables
Get system variables for workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/workflows/draft/trigger/run
Poll for trigger events and execute full workflow when event arrives
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /apps/{app_id}/workflows/draft/trigger/run-all
Full workflow debug when the start node is a trigger
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /apps/{app_id}/workflows/draft/variables
Delete all draft workflow variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/draft/variables
Get draft workflow
Get draft workflow variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| limit |
query |
Items per page |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
Responses
[DELETE] /apps/{app_id}/workflows/draft/variables/{variable_id}
Delete a workflow variable
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/draft/variables/{variable_id}
Get a specific workflow variable
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| variable_id |
path |
Variable ID |
Yes |
string (uuid) |
Responses
[PATCH] /apps/{app_id}/workflows/draft/variables/{variable_id}
Update a workflow variable
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[PUT] /apps/{app_id}/workflows/draft/variables/{variable_id}/reset
Reset a workflow variable to its default value
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| variable_id |
path |
Variable ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/publish
Get published workflow
Get published workflow for an application
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
Responses
[POST] /apps/{app_id}/workflows/publish
Publish workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs
Snapshot of every node's declared outputs for a published workflow run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/events
Server-Sent Events stream of inspector deltas for a published workflow run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}
One node's declared outputs for a published workflow run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID inside the workflow graph |
Yes |
string |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
Full value for one declared output of a published run.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| node_id |
path |
Node ID inside the workflow graph |
Yes |
string |
| output_name |
path |
Declared output name as exposed by Composer |
Yes |
string |
| run_id |
path |
Workflow run ID |
Yes |
string (uuid) |
Responses
[GET] /apps/{app_id}/workflows/triggers/webhook
Get webhook trigger for a node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
query |
|
Yes |
string |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /apps/{app_id}/workflows/{workflow_id}
Delete workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| workflow_id |
path |
|
Yes |
string |
Responses
[PATCH] /apps/{app_id}/workflows/{workflow_id}
Update workflow attributes
Update workflow by ID
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| workflow_id |
path |
Workflow ID |
Yes |
string |
Request Body
Responses
[POST] /apps/{app_id}/workflows/{workflow_id}/restore
Restore a published workflow version into the draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
Application ID |
Yes |
string (uuid) |
| workflow_id |
path |
Published workflow ID |
Yes |
string |
Responses
[GET] /apps/{resource_id}/api-keys
Get all API keys for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| resource_id |
path |
App ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 200 |
API keys retrieved successfully |
application/json: ApiKeyList
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /apps/{resource_id}/api-keys
Create a new API key for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| resource_id |
path |
App ID |
Yes |
string (uuid) |
Responses
[DELETE] /apps/{resource_id}/api-keys/{api_key_id}
Delete an API key for an app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| api_key_id |
path |
API key ID |
Yes |
string (uuid) |
| resource_id |
path |
App ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
API key deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /auth/plugin/datasource/default-list
Responses
[GET] /auth/plugin/datasource/list
Responses
[GET] /auth/plugin/datasource/{provider_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Responses
[POST] /auth/plugin/datasource/{provider_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Request Body
Responses
[DELETE] /auth/plugin/datasource/{provider_id}/custom-client
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Responses
[POST] /auth/plugin/datasource/{provider_id}/custom-client
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /auth/plugin/datasource/{provider_id}/default
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /auth/plugin/datasource/{provider_id}/delete
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /auth/plugin/datasource/{provider_id}/update
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /auth/plugin/datasource/{provider_id}/update-name
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /billing/invoices
Responses
[GET] /billing/subscription
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| interval |
query |
Billing interval |
Yes |
string,
Available values: "month", "year" |
| plan |
query |
Subscription plan |
Yes |
string,
Available values: "professional", "team" |
Responses
[GET] /code-based-extension
Get code-based extension data by module name
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| module |
query |
|
Yes |
string |
Responses
[GET] /compliance/download
Get compliance document download link
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| doc_name |
query |
Compliance document name |
Yes |
string |
Responses
[GET] /data-source/integrates
Responses
[PATCH] /data-source/integrates/{binding_id}/{action}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
|
Yes |
string |
| binding_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /datasets
Get list of datasets
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| ids |
query |
Filter by dataset IDs |
No |
[ string ] |
| include_all |
query |
Include all datasets |
No |
boolean |
| keyword |
query |
Search keyword |
No |
string |
| limit |
query |
Number of items per page |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| tag_ids |
query |
Filter by tag IDs |
No |
[ string ] |
Responses
[POST] /datasets
Create a new dataset
Request Body
Responses
[GET] /datasets/api-base-info
Get dataset API base information
Responses
[GET] /datasets/api-keys
Get dataset API keys
Responses
| Code |
Description |
Schema |
| 200 |
API keys retrieved successfully |
application/json: ApiKeyList
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /datasets/api-keys
Request Body
Responses
[DELETE] /datasets/api-keys/{api_key_id}
Delete dataset API key
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| api_key_id |
path |
API key ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
API key deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/batch_import_status/{job_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| job_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /datasets/external
Create external knowledge dataset
Request Body
Responses
[GET] /datasets/external-knowledge-api
Get external knowledge API templates
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| keyword |
query |
Search keyword |
No |
string |
| limit |
query |
Number of items per page |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
Responses
[POST] /datasets/external-knowledge-api
Create external knowledge API template
Request Body
Responses
[DELETE] /datasets/external-knowledge-api/{external_knowledge_api_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| external_knowledge_api_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /datasets/external-knowledge-api/{external_knowledge_api_id}
Get external knowledge API template details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| external_knowledge_api_id |
path |
External knowledge API ID |
Yes |
string (uuid) |
Responses
[PATCH] /datasets/external-knowledge-api/{external_knowledge_api_id}
Update external knowledge API template
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| external_knowledge_api_id |
path |
External knowledge API ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /datasets/external-knowledge-api/{external_knowledge_api_id}/use-check
Check if external knowledge API is being used
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| external_knowledge_api_id |
path |
External knowledge API ID |
Yes |
string (uuid) |
Responses
[POST] /datasets/indexing-estimate
Estimate dataset indexing cost
Request Body
Responses
[POST] /datasets/init
Initialize dataset with documents
Request Body
Responses
[GET] /datasets/metadata/built-in
Responses
[POST] /datasets/notion-indexing-estimate
Request Body
Responses
[GET] /datasets/process-rule
Get dataset document processing rules
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| document_id |
query |
Document ID (optional) |
No |
string |
Responses
[GET] /datasets/retrieval-setting
Get dataset retrieval settings
Responses
[GET] /datasets/retrieval-setting/{vector_type}
Get mock dataset retrieval settings by vector type
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| vector_type |
path |
Vector store type |
Yes |
string |
Responses
[DELETE] /datasets/{dataset_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Dataset deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/{dataset_id}
Get dataset details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[PATCH] /datasets/{dataset_id}
Update dataset details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/api-keys/{status}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| status |
path |
|
Yes |
string |
Responses
[GET] /datasets/{dataset_id}/auto-disable-logs
Get dataset auto disable logs
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/batch/{batch}/indexing-estimate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| batch |
path |
|
Yes |
string |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/batch/{batch}/indexing-status
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| batch |
path |
|
Yes |
string |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /datasets/{dataset_id}/documents
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Documents deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/{dataset_id}/documents
Get documents in a dataset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| fetch |
query |
Fetch full details (default: false) |
No |
string |
| keyword |
query |
Search keyword |
No |
string |
| limit |
query |
Number of items per page (default: 20) |
No |
string |
| page |
query |
Page number (default: 1) |
No |
string |
| sort |
query |
Sort order (default: -created_at) |
No |
string |
| status |
query |
Filter documents by display status |
No |
string |
Responses
[POST] /datasets/{dataset_id}/documents
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/documents/download-zip
Stream a ZIP archive containing the requested uploaded documents
Download selected dataset documents as a single ZIP archive (upload-file only)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
ZIP archive downloaded successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /datasets/{dataset_id}/documents/generate-summary
Generate summary index for specified documents
Generate summary index for documents
This endpoint checks if the dataset configuration supports summary generation
(indexing_technique must be 'high_quality' and summary_index_setting.enable must be true),
then asynchronously generates summary indexes for the provided documents.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/documents/metadata
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 204 |
Documents metadata updated successfully |
|
| 404 |
Dataset, document, or metadata not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /datasets/{dataset_id}/documents/status/{action}/batch
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
|
Yes |
string |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /datasets/{dataset_id}/documents/{document_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Document deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/{dataset_id}/documents/{document_id}
Get document details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| metadata |
query |
Metadata inclusion (all/only/without) |
No |
string |
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/download
Get a signed download URL for a dataset document's original uploaded file
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 200 |
Download URL generated successfully |
application/json: UrlResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/{dataset_id}/documents/{document_id}/indexing-estimate
Estimate document indexing cost
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/indexing-status
Get document indexing status
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
Responses
[PUT] /datasets/{dataset_id}/documents/{document_id}/metadata
Update document metadata
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/notion/sync
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/pipeline-execution-log
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/pause
pause document
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/resume
recover document
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/{action}
Update document processing status (pause/resume)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
Action to perform (pause/resume) |
Yes |
string |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
Responses
[POST] /datasets/{dataset_id}/documents/{document_id}/rename
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/documents/{document_id}/segment
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
Request Body
Responses
[PATCH] /datasets/{dataset_id}/documents/{document_id}/segment/{action}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
Action |
Yes |
string |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
query |
Segment IDs |
No |
[ string ] |
Responses
[DELETE] /datasets/{dataset_id}/documents/{document_id}/segments
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
query |
Segment IDs |
No |
[ string ] |
Responses
| Code |
Description |
Schema |
| 204 |
Segments deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/{dataset_id}/documents/{document_id}/segments
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| enabled |
query |
|
No |
string,
Default: all |
| hit_count_gte |
query |
|
No |
integer |
| keyword |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
| status |
query |
|
No |
[ string ] |
Responses
[POST] /datasets/{dataset_id}/documents/{document_id}/segments/batch_import
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Segment ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Segment deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Segment ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Parent segment ID |
Yes |
string (uuid) |
| keyword |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
Responses
[PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Parent segment ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Parent segment ID |
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| child_chunk_id |
path |
Child chunk ID |
Yes |
string (uuid) |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Parent segment ID |
Yes |
string (uuid) |
Responses
[PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| child_chunk_id |
path |
Child chunk ID |
Yes |
string (uuid) |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
| segment_id |
path |
Parent segment ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/summary-status
Get summary index generation status for a document
Get summary index generation status for a document
Returns:
- total_segments: Total number of segments in the document
- summary_status: Dictionary with status counts
- completed: Number of summaries completed
- generating: Number of summaries being generated
- error: Number of summaries with errors
- not_started: Number of segments without summary records
- timeout: Number of summaries that timed out
- summaries: List of summary records with status and content preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
| document_id |
path |
Document ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/documents/{document_id}/website-sync
sync website document
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| document_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/error-docs
Get dataset error documents
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[POST] /datasets/{dataset_id}/external-hit-testing
Test external knowledge retrieval for dataset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/hit-testing
Test dataset knowledge retrieval
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Request Body
Responses
[GET] /datasets/{dataset_id}/indexing-status
Get dataset indexing status
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/metadata
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /datasets/{dataset_id}/metadata
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /datasets/{dataset_id}/metadata/built-in/{action}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
path |
|
Yes |
string |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Action completed successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[DELETE] /datasets/{dataset_id}/metadata/{metadata_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| metadata_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Metadata deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /datasets/{dataset_id}/metadata/{metadata_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| metadata_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /datasets/{dataset_id}/notion/sync
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/permission-part-users
Get dataset permission user list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/queries
Get dataset query history
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{dataset_id}/related-apps
Get applications related to dataset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[POST] /datasets/{dataset_id}/retry
retry document
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 204 |
Documents retry started successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /datasets/{dataset_id}/use-check
Check if dataset is in use
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[GET] /datasets/{resource_id}/api-keys
Get all API keys for a dataset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| resource_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 200 |
API keys retrieved successfully |
application/json: ApiKeyList
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /datasets/{resource_id}/api-keys
Create a new API key for a dataset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| resource_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
[DELETE] /datasets/{resource_id}/api-keys/{api_key_id}
Delete an API key for a dataset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| api_key_id |
path |
API key ID |
Yes |
string (uuid) |
| resource_id |
path |
Dataset ID |
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
API key deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /email-code-login
Request Body
Responses
[POST] /email-code-login/validity
Request Body
Responses
[POST] /email-register
Request Body
Responses
[POST] /email-register/send-email
Request Body
Responses
[POST] /email-register/validity
Request Body
Responses
[GET] /explore/apps
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Language code for recommended app localization |
No |
string,
Default: en-US |
Responses
[GET] /explore/apps/learn-dify
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Language code for recommended app localization |
No |
string,
Default: en-US |
Responses
[GET] /explore/apps/{app_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /features
Get current workspace features
Get feature availability and limits for the current workspace
Responses
[GET] /features/vector-space
Get vector-space usage and limit for current tenant
Responses
[GET] /files/support-type
Responses
[GET] /files/upload
Responses
[POST] /files/upload
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary, "source": string,
Available values: "datasets" }
|
Responses
[GET] /files/{file_id}/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| file_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /forgot-password
Send password reset email
Request Body
Responses
[POST] /forgot-password/resets
Reset password with verification token
Request Body
Responses
[POST] /forgot-password/validity
Verify password reset code
Request Body
Responses
[GET] /form/human_input/{form_token}
Get human input form definition by form token
GET /console/api/form/human_input/<form_token>
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| form_token |
path |
|
Yes |
string |
Responses
[POST] /form/human_input/{form_token}
Submit human input form by form token
POST /console/api/form/human_input/<form_token>
Request body:
{
"inputs": {
"content": "User input content"
},
"action": "Approve"
}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| form_token |
path |
|
Yes |
string |
Request Body
Responses
[GET] /installed-apps
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
query |
App ID to filter by |
No |
string |
| cursor |
query |
Opaque cursor returned by the previous page |
No |
string |
| limit |
query |
Number of installed apps to return |
No |
integer,
Default: 20 |
| name |
query |
App name to search for |
No |
string |
Responses
[GET] /installed-apps/{installed_app_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /installed-apps/{installed_app_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /installed-apps/{installed_app_id}/audio-to-text
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /installed-apps/{installed_app_id}/chat-messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /installed-apps/{installed_app_id}/chat-messages/{task_id}/stop
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[POST] /installed-apps/{installed_app_id}/completion-messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /installed-apps/{installed_app_id}/completion-messages/{task_id}/stop
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[GET] /installed-apps/{installed_app_id}/conversations
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| last_id |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| pinned |
query |
|
No |
boolean |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /installed-apps/{installed_app_id}/conversations/{c_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| c_id |
path |
|
Yes |
string (uuid) |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /installed-apps/{installed_app_id}/conversations/{c_id}/name
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| c_id |
path |
|
Yes |
string (uuid) |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[PATCH] /installed-apps/{installed_app_id}/conversations/{c_id}/pin
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| c_id |
path |
|
Yes |
string (uuid) |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /installed-apps/{installed_app_id}/conversations/{c_id}/unpin
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| c_id |
path |
|
Yes |
string (uuid) |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /installed-apps/{installed_app_id}/messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| conversation_id |
query |
Conversation ID. |
Yes |
string |
| first_id |
query |
The ID of the first chat record on the current page. Omit this value to fetch the latest messages; for subsequent pages, use the first message ID from the current list to fetch older messages. |
No |
string |
| limit |
query |
Number of chat history messages to return per request. |
No |
integer,
Default: 20 |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /installed-apps/{installed_app_id}/messages/{message_id}/feedbacks
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| message_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /installed-apps/{installed_app_id}/messages/{message_id}/more-like-this
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| response_mode |
query |
|
Yes |
string,
Available values: "blocking", "streaming" |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| message_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /installed-apps/{installed_app_id}/messages/{message_id}/suggested-questions
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| message_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /installed-apps/{installed_app_id}/meta
Get app meta
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /installed-apps/{installed_app_id}/parameters
Retrieve app parameters
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /installed-apps/{installed_app_id}/saved-messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| last_id |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /installed-apps/{installed_app_id}/saved-messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /installed-apps/{installed_app_id}/saved-messages/{message_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| message_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /installed-apps/{installed_app_id}/text-to-audio
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /installed-apps/{installed_app_id}/workflows/run
Run workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /installed-apps/{installed_app_id}/workflows/tasks/{task_id}/stop
Stop workflow task
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| installed_app_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[POST] /instruction-generate
Generate instruction for workflow nodes or general use
Request Body
Responses
[POST] /instruction-generate/template
Get instruction generation template
Request Body
Responses
[POST] /login
Authenticate user and login
Request Body
Responses
[POST] /logout
Responses
[GET] /mcp/oauth/callback
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| code |
query |
|
Yes |
string |
| state |
query |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 302 |
Redirect to OAuth callback page |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /notification
Return the active in-product notification for the current user in the requested language (defaults to English when omitted). Unavailable translations fall back to English, then the first available content. The notification is NOT marked as seen here; call POST /notification/dismiss when the user explicitly closes the modal.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Notification language |
No |
string,
Default: en-US |
Responses
[POST] /notification/dismiss
Mark a notification as dismissed for the current user.
Request Body
Responses
[GET] /notion/pages/{page_id}/{page_type}/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| credential_id |
query |
Credential ID |
Yes |
string |
| page_id |
path |
|
Yes |
string (uuid) |
| page_type |
path |
|
Yes |
string |
Responses
[GET] /notion/pre-import/pages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| credential_id |
query |
Credential ID |
Yes |
string |
| dataset_id |
query |
Dataset ID |
No |
string |
Responses
[GET] /oauth/authorize/{provider}
Handle OAuth callback and complete login process
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
OAuth provider name (github/google) |
Yes |
string |
| code |
query |
Authorization code from OAuth provider |
Yes |
string |
| state |
query |
OAuth state parameter |
No |
string |
Responses
[GET] /oauth/data-source/binding/{provider}
Bind OAuth data source with authorization code
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
Data source provider name (notion) |
Yes |
string |
| code |
query |
Authorization code from OAuth provider |
Yes |
string |
Responses
[GET] /oauth/data-source/callback/{provider}
Handle OAuth callback from data source provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
Data source provider name (notion) |
Yes |
string |
| code |
query |
Authorization code from OAuth provider |
No |
string |
| error |
query |
Error message from OAuth provider |
No |
string |
Responses
[GET] /oauth/data-source/{provider}
Get OAuth authorization URL for data source provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
Data source provider name (notion) |
Yes |
string |
Responses
[GET] /oauth/data-source/{provider}/{binding_id}/sync
Sync data from OAuth data source
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| binding_id |
path |
Data source binding ID |
Yes |
string (uuid) |
| provider |
path |
Data source provider name (notion) |
Yes |
string |
Responses
[GET] /oauth/login/{provider}
Initiate OAuth login process
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
OAuth provider name (github/google) |
Yes |
string |
| invite_token |
query |
Optional invitation token |
No |
string |
| language |
query |
Preferred interface language |
No |
string |
| redirect_url |
query |
Relative page to resume after login |
No |
string |
| timezone |
query |
Preferred timezone |
No |
string |
Responses
[GET] /oauth/plugin/{provider_id}/datasource/callback
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| code |
query |
Authorization code from OAuth provider |
No |
string |
| context_id |
query |
OAuth proxy context ID |
No |
string |
| error |
query |
Error message from OAuth provider |
No |
string |
| state |
query |
OAuth state parameter |
No |
string |
| provider_id |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 302 |
Redirect to OAuth callback page |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /oauth/plugin/{provider_id}/datasource/get-authorization-url
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| credential_id |
query |
Credential ID to reauthorize |
No |
string |
| visibility |
query |
Visibility for the credential to be created. Accepts 'only_me' or 'all_team_members'; any other value falls back to 'only_me'. Ignored on reauthorization (credential_id set). |
No |
string |
| provider_id |
path |
|
Yes |
string |
Responses
[GET] /oauth/plugin/{provider}/tool/authorization-url
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| visibility |
query |
Visibility for the OAuth credential. Defaults to 'only_me'. |
No |
string,
Available values: "all_team_members", "only_me" |
| provider |
path |
|
Yes |
string |
Responses
[GET] /oauth/plugin/{provider}/tool/callback
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 302 |
Redirect to OAuth callback page |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /oauth/plugin/{provider}/trigger/callback
Handle OAuth callback for trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 302 |
Redirect to OAuth callback page |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /oauth/provider
Request Body
Responses
[POST] /oauth/provider/account
Request Body
Responses
[POST] /oauth/provider/authorize
Request Body
Responses
[POST] /oauth/provider/token
Request Body
Responses
[GET] /onboarding/step-by-step-tour/state
Get account-level Step-by-step Tour state
Responses
[PATCH] /onboarding/step-by-step-tour/state
Update account-level Step-by-step Tour state
Request Body
Responses
[DELETE] /rag/pipeline/customized/templates/{template_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| template_id |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 204 |
Pipeline template deleted |
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /rag/pipeline/customized/templates/{template_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| template_id |
path |
|
Yes |
string |
Request Body
Responses
| Code |
Description |
Schema |
| 204 |
Pipeline template updated |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /rag/pipeline/customized/templates/{template_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| template_id |
path |
|
Yes |
string |
Responses
[POST] /rag/pipeline/dataset
Request Body
Responses
[POST] /rag/pipeline/empty-dataset
Responses
[GET] /rag/pipeline/templates
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Template language |
No |
string,
Default: en-US |
| type |
query |
Template source: built-in or customized |
No |
string,
Default: built-in |
Responses
[GET] /rag/pipeline/templates/{template_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| type |
query |
Template source: built-in or customized |
No |
string,
Default: built-in |
| template_id |
path |
|
Yes |
string |
Responses
[GET] /rag/pipelines/datasource-plugins
Responses
[POST] /rag/pipelines/imports
Request Body
Responses
[POST] /rag/pipelines/imports/{import_id}/confirm
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| import_id |
path |
|
Yes |
string |
Responses
[GET] /rag/pipelines/imports/{pipeline_id}/check-dependencies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string |
Responses
[GET] /rag/pipelines/recommended-plugins
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| type |
query |
|
No |
string,
Default: all |
Responses
[POST] /rag/pipelines/transform/datasets/{dataset_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/customized/publish
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /rag/pipelines/{pipeline_id}/exports
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| include_secret |
query |
Whether to include secret values in the exported DSL |
No |
string,
Default: false |
| pipeline_id |
path |
|
Yes |
string |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflow-runs
Get workflow run list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| last_id |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflow-runs/tasks/{task_id}/stop
Stop workflow task
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}
Get workflow run detail
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| run_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}/node-executions
Get workflow run node execution list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| run_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows
Get published workflows
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| limit |
query |
|
No |
integer,
Default: 10 |
| named_only |
query |
|
No |
boolean |
| page |
query |
|
No |
integer,
Default: 1 |
| user_id |
query |
|
No |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs
Get default block config
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs/{block_type}
Get default block config
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| q |
query |
|
No |
string |
| block_type |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft
Get draft rag pipeline's workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft
Sync draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft/datasource/nodes/{node_id}/run
Run rag pipeline datasource
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft/datasource/variables-inspect
Set datasource variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/environment-variables
Get draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft/iteration/nodes/{node_id}/run
Run draft workflow iteration node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft/loop/nodes/{node_id}/run
Run draft workflow loop node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/last-run
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/run
Run draft workflow node
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/pre-processing/parameters
Get first step parameters of rag pipeline
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
query |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/processing/parameters
Get second step parameters of rag pipeline
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
query |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/draft/run
Run draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/system-variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/variables
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/variables
Get draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[PUT] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}/reset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/publish
Get published pipeline
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/publish
Publish workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/preview
Run datasource content preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/run
Run rag pipeline datasource
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/published/pre-processing/parameters
Get first step parameters of rag pipeline
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
query |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /rag/pipelines/{pipeline_id}/workflows/published/processing/parameters
Get second step parameters of rag pipeline
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
query |
|
Yes |
string |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/published/run
Run published workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}
Delete a published workflow version that is not currently active on the pipeline
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| workflow_id |
path |
|
Yes |
string |
Responses
[PATCH] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}
Update workflow attributes
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| workflow_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}/restore
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| pipeline_id |
path |
|
Yes |
string (uuid) |
| workflow_id |
path |
|
Yes |
string |
Responses
[POST] /refresh-token
Responses
[POST] /remote-files/upload
Request Body
Responses
[GET] /remote-files/{url}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| url |
path |
|
Yes |
string |
Responses
[POST] /reset-password
Request Body
Responses
[GET] /resource-access-tokens
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| keyword |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
Responses
[POST] /resource-access-tokens
Request Body
Responses
[PATCH] /resource-access-tokens/{token_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| token_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /resource-access-tokens/{token_id}/relations/{relation_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| relation_id |
path |
|
Yes |
string (uuid) |
| token_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Resource access token relation deleted |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /rule-code-generate
Generate code rules using LLM
Request Body
Responses
[POST] /rule-generate
Generate rule configuration using LLM
Request Body
Responses
[POST] /rule-structured-output-generate
Generate structured output rules using LLM
Request Body
Responses
[GET] /snippets/{snippet_id}/workflow-runs
List workflow runs for snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| last_id |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflow-runs/tasks/{task_id}/stop
Stop a running snippet workflow task
Uses both the legacy stop flag mechanism and the graph engine
command channel for backward compatibility.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[GET] /snippets/{snippet_id}/workflow-runs/{run_id}
Get workflow run detail for snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| run_id |
path |
|
Yes |
string (uuid) |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /snippets/{snippet_id}/workflow-runs/{run_id}/node-executions
List node executions for a workflow run
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| run_id |
path |
|
Yes |
string (uuid) |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /snippets/{snippet_id}/workflows
Get all published workflow versions for snippet
Get all published workflows for a snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
| limit |
query |
|
No |
integer,
Default: 10 |
| page |
query |
|
No |
integer,
Default: 1 |
Responses
[GET] /snippets/{snippet_id}/workflows/default-workflow-block-configs
Get default block configurations for snippet workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /snippets/{snippet_id}/workflows/draft
Get draft workflow for snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflows/draft
Sync draft workflow for snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /snippets/{snippet_id}/workflows/draft/config
Get snippet draft workflow configuration limits
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /snippets/{snippet_id}/workflows/draft/conversation-variables
Conversation variables are not used in snippet workflows; returns an empty list for API parity
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /snippets/{snippet_id}/workflows/draft/environment-variables
Get environment variables from snippet draft workflow graph
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflows/draft/iteration/nodes/{node_id}/run
Run a draft workflow iteration node for snippet
Run draft workflow iteration node for snippet
Iteration nodes execute their internal sub-graph multiple times over an input list.
Returns an SSE event stream with iteration progress and results.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
Node ID |
Yes |
string |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Iteration node run started successfully (SSE stream) |
application/json: GeneratedAppResponse
|
| 404 |
Snippet or draft workflow not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /snippets/{snippet_id}/workflows/draft/loop/nodes/{node_id}/run
Run a draft workflow loop node for snippet
Run draft workflow loop node for snippet
Loop nodes execute their internal sub-graph repeatedly until a condition is met.
Returns an SSE event stream with loop progress and results.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
Node ID |
Yes |
string |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Loop node run started successfully (SSE stream) |
application/json: GeneratedAppResponse
|
| 404 |
Snippet or draft workflow not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snapshot_id |
query |
|
No |
string |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/candidates
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/copy-from-roster
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/impact
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/save-to-roster
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/last-run
Get the last run result for a specific node in snippet draft workflow
Get last run result for a node in snippet draft workflow
Returns the most recent execution record for the given node,
including status, inputs, outputs, and timing information.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
Node ID |
Yes |
string |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/run
Run a single node in snippet draft workflow
Run a single node in snippet draft workflow (single-step debugging)
Executes a specific node with provided inputs for single-step debugging.
Returns the node execution result including status, outputs, and timing.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
Node ID |
Yes |
string |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/variables
Delete all variables for a specific node (snippet draft workflow)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Node variables deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/variables
Get variables for a specific node (snippet draft workflow)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| node_id |
path |
|
Yes |
string |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflows/draft/run
Run draft workflow for snippet
Executes the snippet's draft workflow with the provided inputs
and returns an SSE event stream with execution progress and results.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Draft workflow run started successfully (SSE stream) |
application/json: GeneratedAppResponse
|
| 404 |
Snippet or draft workflow not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /snippets/{snippet_id}/workflows/draft/system-variables
System variables are not used in snippet workflows; returns an empty list for API parity
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /snippets/{snippet_id}/workflows/draft/variables
Delete all draft workflow variables for the current user (snippet scope)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Workflow variables deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /snippets/{snippet_id}/workflows/draft/variables
List draft workflow variables without values (paginated, snippet scope)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| limit |
query |
Items per page |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
Delete a draft workflow variable (snippet scope)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Variable deleted successfully |
|
| 404 |
Variable not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
Get a specific draft workflow variable (snippet scope)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
Update a draft workflow variable (snippet scope)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[PUT] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}/reset
Reset a draft workflow variable to its default value (snippet scope)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
| variable_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /snippets/{snippet_id}/workflows/publish
Get published workflow for snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /snippets/{snippet_id}/workflows/publish
Publish snippet workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[DELETE] /snippets/{snippet_id}/workflows/{workflow_id}
Delete a published snippet workflow version
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
| workflow_id |
path |
Workflow ID |
Yes |
string |
Responses
| Code |
Description |
Schema |
| 204 |
Workflow deleted successfully |
|
| 400 |
Workflow is in use |
application/json: ErrorResponse
|
| 404 |
Workflow not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /snippets/{snippet_id}/workflows/{workflow_id}
Update a published snippet workflow version's display metadata
Update published snippet workflow attributes
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
| workflow_id |
path |
Workflow ID |
Yes |
string |
Request Body
Responses
[POST] /snippets/{snippet_id}/workflows/{workflow_id}/restore
Restore a published snippet workflow version into the draft workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
| workflow_id |
path |
Published workflow ID |
Yes |
string |
Responses
[GET] /spec/schema-definitions
Get system JSON Schema definitions specification
Used for frontend component type mapping
Responses
[GET] /system-features
Get the non-sensitive bootstrap snapshot exposed before authentication
Get the non-sensitive bootstrap snapshot exposed before Console or Web authentication. This is not a general feature registry.
Authentication configuration must be available before the authentication flow can be selected.
Authenticated license detail is served separately by SystemFeatureLicenseApi.
Responses
[GET] /system-features/license
Get full license detail (status, expiry, workspace/seat usage)
Get license status and usage detail
Authenticated counterpart to the license status exposed on the public
system-features endpoint.
Responses
[POST] /tag-bindings
Request Body
Responses
[POST] /tag-bindings/remove
Remove one or more tag bindings from a target.
Request Body
Responses
[GET] /tags
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| keyword |
query |
Search keyword |
No |
string |
| type |
query |
Tag type filter |
Yes |
string,
Available values: "app", "knowledge", "skill", "snippet" |
Responses
[POST] /tags
Request Body
Responses
[DELETE] /tags/{tag_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| tag_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Tag deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /tags/{tag_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| tag_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /trial-apps/{app_id}
Get app detail using the viewer's workspace for tool configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /trial-apps/{app_id}/agent-composer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /trial-apps/{app_id}/agent/config/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /trial-apps/{app_id}/agent/config/files/{name}/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /trial-apps/{app_id}/agent/config/files/{name}/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /trial-apps/{app_id}/agent/config/skills
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /trial-apps/{app_id}/agent/config/skills/{name}/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /trial-apps/{app_id}/agent/config/skills/{name}/files/content
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| path |
query |
Normalized member path inside the published Skill package |
Yes |
string |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /trial-apps/{app_id}/agent/config/skills/{name}/files/download
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| path |
query |
Normalized member path inside the published Skill package |
Yes |
string |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /trial-apps/{app_id}/agent/config/skills/{name}/files/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| path |
query |
Normalized member path inside the published Skill package |
Yes |
string |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[GET] /trial-apps/{app_id}/agent/config/skills/{name}/inspect
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| version_id |
query |
Must match the current published template snapshot |
No |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
| name |
path |
|
Yes |
string |
Responses
[POST] /trial-apps/{app_id}/audio-to-text
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /trial-apps/{app_id}/chat-messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /trial-apps/{app_id}/chat-messages/{task_id}/stop
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[POST] /trial-apps/{app_id}/completion-messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /trial-apps/{app_id}/datasets
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| ids |
query |
Dataset IDs |
No |
[ string ] |
| limit |
query |
Number of items per page |
No |
integer,
Default: 20 |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /trial-apps/{app_id}/export
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| format |
query |
Export format; defaults to ifpkg |
No |
string,
Available values: "ifpkg", "yaml",
Default: ifpkg |
| version_id |
query |
Current published template snapshot ID |
Yes |
string (uuid) |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /trial-apps/{app_id}/files/upload
Upload a file into the tenant that owns the trial app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary, "source": string,
Available values: "datasets" }
|
Responses
[GET] /trial-apps/{app_id}/messages/{message_id}/suggested-questions
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| message_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /trial-apps/{app_id}/parameters
Retrieve app parameters
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /trial-apps/{app_id}/remote-files/upload
Upload a remote file into the tenant that owns the trial app
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /trial-apps/{app_id}/site
Retrieve app site info
Returns the site configuration for the application including theme, icons, and text.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /trial-apps/{app_id}/text-to-audio
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /trial-apps/{app_id}/workflows
Get a detached workflow definition after catalog preview admission
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /trial-apps/{app_id}/workflows/run
Run workflow
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /trial-apps/{app_id}/workflows/tasks/{task_id}/stop
Stop workflow task
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| task_id |
path |
|
Yes |
string |
Responses
[GET] /trial-models
Get hosted credit provider configuration for the current workspace
Get hosted credit model provider configuration for the current workspace
Responses
[POST] /website/crawl
Crawl website content
Request Body
Responses
[GET] /website/crawl/status/{job_id}
Get website crawl status
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| job_id |
path |
Crawl job ID |
Yes |
string |
| provider |
query |
Crawl provider (firecrawl/watercrawl/jinareader) |
Yes |
string,
Available values: "firecrawl", "jinareader", "watercrawl" |
Responses
[POST] /workflow-generate
Generate a Dify workflow graph from natural language
Request Body
Responses
[POST] /workflow-generate/stream
Stream a Dify workflow graph (plan then result) via SSE
Request Body
Responses
[POST] /workflow-generate/suggestions
Suggest example workflow-generator instructions for the tenant
Request Body
Responses
[GET] /workflow-run-archives
List monthly workflow-run archive metadata for the current workspace
Responses
[POST] /workflow-run-archives/downloads
Create or return a temporary workflow-run archive download task
Request Body
Responses
[GET] /workflow-run-archives/downloads/{download_id}
Get a temporary workflow-run archive download task
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| download_id |
path |
|
Yes |
string |
Responses
[GET] /workflow-run-archives/downloads/{download_id}/file
Redirect to a prepared workflow-run archive ZIP file
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| download_id |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 302 |
Redirect to pre-signed archive storage URL |
application/json: RedirectResponse
|
| 409 |
Download task is not ready |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[DELETE] /workflow-run-archives/{year}/{month}
Permanently delete this workspace's monthly archive files and archive index
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| month |
path |
|
Yes |
integer |
| year |
path |
|
Yes |
integer |
Responses
[GET] /workflow/{workflow_run_id}/events
Get workflow execution events stream after resume
GET /console/api/workflow/<workflow_run_id>/events
Returns Server-Sent Events stream.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| workflow_run_id |
path |
|
Yes |
string |
Responses
[GET] /workflow/{workflow_run_id}/pause-details
Get workflow pause details
Get workflow pause details
GET /console/api/workflow/<workflow_run_id>/pause-details
Returns information about why and where the workflow is paused.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| workflow_run_id |
path |
Workflow run ID |
Yes |
string |
Responses
[GET] /workspaces
Responses
[GET] /workspaces/current/agent-provider/{provider_name}
Get specific agent provider details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_name |
path |
Agent provider name |
Yes |
string |
Responses
[GET] /workspaces/current/agent-providers
Get list of available agent providers
Responses
[GET] /workspaces/current/agents/{agent_id}/skills
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string |
Responses
[PUT] /workspaces/current/agents/{agent_id}/skills
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/customized-snippets
List customized snippets with pagination and search
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| creators |
query |
Filter by creator account IDs |
No |
[ string ] |
| is_published |
query |
Filter by published status |
No |
boolean |
| keyword |
query |
|
No |
string |
| limit |
query |
|
No |
integer,
Default: 20 |
| page |
query |
|
No |
integer,
Default: 1 |
| tag_ids |
query |
Filter by tag IDs |
No |
[ string ] |
Responses
[POST] /workspaces/current/customized-snippets
Create a new customized snippet
Request Body
Responses
[POST] /workspaces/current/customized-snippets/imports
Import snippet from DSL
Request Body
Responses
[POST] /workspaces/current/customized-snippets/imports/{import_id}/confirm
Confirm a pending snippet import
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| import_id |
path |
Import ID to confirm |
Yes |
string |
Responses
[DELETE] /workspaces/current/customized-snippets/{snippet_id}
Delete customized snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 204 |
Snippet deleted successfully |
|
| 404 |
Snippet not found |
application/json: ErrorResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/customized-snippets/{snippet_id}
Get customized snippet details
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Responses
[PATCH] /workspaces/current/customized-snippets/{snippet_id}
Update customized snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/customized-snippets/{snippet_id}/check-dependencies
Check dependencies for a snippet
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/customized-snippets/{snippet_id}/export
Export snippet as DSL
Export snippet configuration as DSL
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID to export |
Yes |
string (uuid) |
| include_secret |
query |
Whether to include secret variables |
No |
string,
Default: false |
| workflow_id |
query |
Specific published workflow version to export |
No |
string |
Responses
[POST] /workspaces/current/customized-snippets/{snippet_id}/use-count/increment
Increment snippet use count when it is inserted into a workflow
Increment snippet use count by 1
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| snippet_id |
path |
Snippet ID |
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/dataset-operators
Responses
[GET] /workspaces/current/default-model
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| model_type |
query |
Enum class for model type. |
Yes |
string,
Available values: "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
Responses
[POST] /workspaces/current/default-model
Request Body
Responses
[POST] /workspaces/current/endpoints
Create a new plugin endpoint
Request Body
Responses
[POST] /workspaces/current/endpoints/create
DEPRECATED
Deprecated legacy alias for creating a plugin endpoint. Use POST /workspaces/current/endpoints instead.
Request Body
Responses
[POST] /workspaces/current/endpoints/delete
DEPRECATED
Deprecated legacy alias for deleting a plugin endpoint. Use DELETE /workspaces/current/endpoints/{id} instead.
Request Body
Responses
[POST] /workspaces/current/endpoints/disable
Disable a plugin endpoint
Request Body
Responses
[POST] /workspaces/current/endpoints/enable
Enable a plugin endpoint
Request Body
Responses
[GET] /workspaces/current/endpoints/list
List plugin endpoints with pagination
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| page |
query |
|
Yes |
integer |
| page_size |
query |
|
Yes |
integer |
Responses
[GET] /workspaces/current/endpoints/list/plugin
List endpoints for a specific plugin
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| page |
query |
|
Yes |
integer |
| page_size |
query |
|
Yes |
integer |
| plugin_id |
query |
|
Yes |
string |
Responses
[POST] /workspaces/current/endpoints/update
DEPRECATED
Deprecated legacy alias for updating a plugin endpoint. Use PATCH /workspaces/current/endpoints/{id} instead.
Request Body
Responses
[DELETE] /workspaces/current/endpoints/{id}
Delete a plugin endpoint
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
Endpoint ID |
Yes |
string |
Responses
[PATCH] /workspaces/current/endpoints/{id}
Update a plugin endpoint
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| id |
path |
Endpoint ID |
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/members
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
Responses
[POST] /workspaces/current/members/invite-email
Request Body
Responses
[POST] /workspaces/current/members/owner-transfer-check
Request Body
Responses
Request Body
Responses
[DELETE] /workspaces/current/members/{member_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| member_id |
path |
|
Yes |
string (uuid) |
Responses
[POST] /workspaces/current/members/{member_id}/owner-transfer
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| member_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[PUT] /workspaces/current/members/{member_id}/update-role
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| member_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/model-providers
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| model_type |
query |
Enum class for model type. |
No |
string,
Available values: "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
Responses
[GET] /workspaces/current/model-providers/credits
Responses
Responses
[GET] /workspaces/current/model-providers/{provider}/checkout-url
DEPRECATED
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[DELETE] /workspaces/current/model-providers/{provider}/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
| Code |
Description |
Schema |
| 204 |
Credential deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/model-providers/{provider}/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| credential_id |
query |
|
No |
string |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/model-providers/{provider}/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[PUT] /workspaces/current/model-providers/{provider}/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/model-providers/{provider}/credentials/switch
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/model-providers/{provider}/credentials/validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[DELETE] /workspaces/current/model-providers/{provider}/models
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| model |
query |
|
Yes |
string |
| model_type |
query |
Enum class for model type. |
Yes |
string,
Available values: "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 204 |
Model deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/model-providers/{provider}/models
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/model-providers/{provider}/models
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[DELETE] /workspaces/current/model-providers/{provider}/models/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| credential_id |
query |
|
Yes |
string |
| model |
query |
|
Yes |
string |
| model_type |
query |
Enum class for model type. |
Yes |
string,
Available values: "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 204 |
Credential deleted successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/model-providers/{provider}/models/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| config_from |
query |
|
No |
string |
| credential_id |
query |
|
No |
string |
| model |
query |
|
Yes |
string |
| model_type |
query |
Enum class for model type. |
Yes |
string,
Available values: "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/model-providers/{provider}/models/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[PUT] /workspaces/current/model-providers/{provider}/models/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/model-providers/{provider}/models/credentials/switch
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/model-providers/{provider}/models/credentials/validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[PATCH] /workspaces/current/model-providers/{provider}/models/disable
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[PATCH] /workspaces/current/model-providers/{provider}/models/enable
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/model-providers/{provider}/models/load-balancing-configs/credentials-validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/model-providers/{provider}/models/load-balancing-configs/{config_id}/credentials-validate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| config_id |
path |
|
Yes |
string |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/model-providers/{provider}/models/parameter-rules
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| model |
query |
|
Yes |
string |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/model-providers/{provider}/preferred-provider-type
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/models/model-types/{model_type}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| model_type |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/permission
Responses
[GET] /workspaces/current/plugin/asset
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| file_name |
query |
|
Yes |
string |
| plugin_unique_identifier |
query |
|
Yes |
string |
Responses
[POST] /workspaces/current/plugin/auto-upgrade/change
Request Body
Responses
[POST] /workspaces/current/plugin/auto-upgrade/exclude
Request Body
Responses
[GET] /workspaces/current/plugin/auto-upgrade/fetch
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| category |
query |
|
Yes |
string,
Available values: "agent-strategy", "datasource", "extension", "model", "tool", "trigger" |
Responses
[GET] /workspaces/current/plugin/debugging-key
Responses
[GET] /workspaces/current/plugin/fetch-manifest
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| plugin_unique_identifier |
query |
|
Yes |
string |
Responses
[GET] /workspaces/current/plugin/icon
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| filename |
query |
|
Yes |
string |
| tenant_id |
query |
|
Yes |
string |
Responses
[POST] /workspaces/current/plugin/install/github
Request Body
Responses
[POST] /workspaces/current/plugin/install/marketplace
Request Body
Responses
[POST] /workspaces/current/plugin/install/pkg
Request Body
Responses
[GET] /workspaces/current/plugin/installed-ids
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| category |
query |
Plugin category to include |
Yes |
string,
Available values: "agent-strategy", "datasource", "extension", "model", "tool", "trigger" |
Responses
[GET] /workspaces/current/plugin/list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| page_size |
query |
Page size (1-256) |
No |
integer,
Default: 256 |
Responses
[POST] /workspaces/current/plugin/list/installations/ids
Request Body
Responses
[POST] /workspaces/current/plugin/list/latest-versions
Request Body
Responses
[GET] /workspaces/current/plugin/marketplace/pkg
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| plugin_unique_identifier |
query |
|
Yes |
string |
Responses
[GET] /workspaces/current/plugin/parameters/dynamic-options
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| action |
query |
|
Yes |
string |
| credential_id |
query |
|
No |
string |
| parameter |
query |
|
Yes |
string |
| plugin_id |
query |
|
Yes |
string |
| provider |
query |
|
Yes |
string |
| provider_type |
query |
|
Yes |
string,
Available values: "tool", "trigger" |
Responses
[POST] /workspaces/current/plugin/parameters/dynamic-options-with-credentials
Fetch dynamic options using credentials directly (for edit mode)
Request Body
Responses
[POST] /workspaces/current/plugin/permission/change
Request Body
Responses
[GET] /workspaces/current/plugin/permission/fetch
Responses
[GET] /workspaces/current/plugin/readme
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
|
No |
string,
Default: en-US |
| plugin_unique_identifier |
query |
|
Yes |
string |
Responses
[GET] /workspaces/current/plugin/tasks
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| page_size |
query |
Page size (1-256) |
No |
integer,
Default: 256 |
Responses
[POST] /workspaces/current/plugin/tasks/delete_all
Responses
[GET] /workspaces/current/plugin/tasks/{task_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| task_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/plugin/tasks/{task_id}/delete
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| task_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/plugin/tasks/{task_id}/delete/{identifier}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| identifier |
path |
|
Yes |
string |
| task_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/plugin/uninstall
Request Body
Responses
[POST] /workspaces/current/plugin/upgrade/github
Request Body
Responses
[POST] /workspaces/current/plugin/upgrade/marketplace
Request Body
Responses
[POST] /workspaces/current/plugin/upload/bundle
Responses
[POST] /workspaces/current/plugin/upload/github
Request Body
Responses
[POST] /workspaces/current/plugin/upload/pkg
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "pkg": binary }
|
Responses
[GET] /workspaces/current/plugin/{category}/list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Language used for localized label and description search |
No |
string,
Available values: "en_US", "ja_JP", "pt_BR", "zh_Hans",
Default: en_US |
| page |
query |
Page number |
No |
integer,
Default: 1 |
| page_size |
query |
Page size (1-256) |
No |
integer,
Default: 256 |
| query |
query |
Case-insensitive search query |
No |
string |
| tags |
query |
Match any plugin tag |
No |
[ string ] |
| category |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/rbac/access-policies
Responses
[POST] /workspaces/current/rbac/access-policies
Request Body
Responses
[DELETE] /workspaces/current/rbac/access-policies/{policy_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/access-policies/{policy_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/access-policies/{policy_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[POST] /workspaces/current/rbac/access-policies/{policy_id}/copy
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/access-policy-bindings/{binding_id}/lock
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| binding_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/access-policy-bindings/{binding_id}/unlock
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| binding_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/role-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/agents/{agent_id}/access-policy
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/agents/{agent_id}/user-access-policies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| limit |
query |
|
No |
integer |
| page |
query |
|
No |
integer |
| reverse |
query |
|
No |
boolean |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/agents/{agent_id}/users/{target_account_id}/access-policies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
| target_account_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/agents/{agent_id}/whitelist
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/agents/{agent_id}/whitelist
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/agents/{agent_id}/whitelist_config
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| agent_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/role-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/apps/{app_id}/access-policy
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/apps/{app_id}/user-access-policies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| limit |
query |
|
No |
integer |
| page |
query |
|
No |
integer |
| reverse |
query |
|
No |
boolean |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/apps/{app_id}/users/{target_account_id}/access-policies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
| target_account_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/apps/{app_id}/whitelist
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/apps/{app_id}/whitelist
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/apps/{app_id}/whitelist_config
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| app_id |
path |
|
Yes |
string (uuid) |
Responses
[DELETE] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/role-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policy
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/datasets/{dataset_id}/user-access-policies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| limit |
query |
|
No |
integer |
| page |
query |
|
No |
integer |
| reverse |
query |
|
No |
boolean |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/datasets/{dataset_id}/users/{target_account_id}/access-policies
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
| target_account_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/datasets/{dataset_id}/whitelist
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/datasets/{dataset_id}/whitelist
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/datasets/{dataset_id}/whitelist_config
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| dataset_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/members/{member_id}/rbac-roles
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| member_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/members/{member_id}/rbac-roles
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| member_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/my-permissions
Responses
[GET] /workspaces/current/rbac/role-permissions/catalog
Responses
[GET] /workspaces/current/rbac/role-permissions/catalog/agent
Responses
[GET] /workspaces/current/rbac/role-permissions/catalog/app
Responses
[GET] /workspaces/current/rbac/role-permissions/catalog/dataset
Responses
[GET] /workspaces/current/rbac/roles
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| include_owner |
query |
|
No |
integer |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| limit |
query |
|
No |
integer |
| page |
query |
|
No |
integer |
| reverse |
query |
|
No |
boolean |
Responses
[POST] /workspaces/current/rbac/roles
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
Request Body
Responses
| Code |
Description |
Schema |
| 201 |
Role created |
application/json: RBACRole
|
| default |
Error |
application/json: ErrorResponse
|
[DELETE] /workspaces/current/rbac/roles/{role_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| role_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/roles/{role_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| role_id |
path |
|
Yes |
string (uuid) |
Responses
| Code |
Description |
Schema |
| 200 |
Success |
application/json: RBACRole
|
| default |
Error |
application/json: ErrorResponse
|
[PUT] /workspaces/current/rbac/roles/{role_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| role_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
Success |
application/json: RBACRole
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /workspaces/current/rbac/roles/{role_id}/copy
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| role_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
| Code |
Description |
Schema |
| 201 |
Role copied |
application/json: RBACRole
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/rbac/roles/{role_id}/members
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Localized policy label language |
No |
string,
Available values: "en", "ja", "zh" |
| limit |
query |
|
No |
integer |
| page |
query |
|
No |
integer |
| reverse |
query |
|
No |
boolean |
| role_id |
path |
|
Yes |
string (uuid) |
Responses
[PUT] /workspaces/current/rbac/workspace/agents/access-policies/{policy_id}/bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/workspace/agents/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/workspace/agents/access-policies/{policy_id}/role-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/workspace/agents/access-policy
Responses
[PUT] /workspaces/current/rbac/workspace/apps/access-policies/{policy_id}/bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/workspace/apps/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/workspace/apps/access-policies/{policy_id}/role-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/workspace/apps/access-policy
Responses
[PUT] /workspaces/current/rbac/workspace/datasets/access-policies/{policy_id}/bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Request Body
Responses
[GET] /workspaces/current/rbac/workspace/datasets/access-policies/{policy_id}/member-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/workspace/datasets/access-policies/{policy_id}/role-bindings
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| policy_id |
path |
|
Yes |
string (uuid) |
Responses
[GET] /workspaces/current/rbac/workspace/datasets/access-policy
Responses
[GET] /workspaces/current/skills
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| keyword |
query |
Search keyword matching skill name or description. |
No |
string |
| limit |
query |
Number of items per page. |
No |
integer,
Default: 20 |
| page |
query |
Page number. |
No |
integer,
Default: 1 |
| tag |
query |
Skill tag filters. Repeat the parameter for multiple tags. |
No |
[ string ] |
Responses
[POST] /workspaces/current/skills
Request Body
Responses
[POST] /workspaces/current/skills/files/upload
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary }
|
Responses
[POST] /workspaces/current/skills/import
Import a Skill zip package from multipart form field file.
Responses
[GET] /workspaces/current/skills/tags
Responses
[DELETE] /workspaces/current/skills/{skill_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/skills/{skill_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Responses
[PATCH] /workspaces/current/skills/{skill_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/skills/{skill_id}/assist/messages
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/skills/{skill_id}/duplicate
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/skills/{skill_id}/export
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 200 |
Draft Skill zip archive |
|
| default |
Error |
application/json: ErrorResponse
|
[PATCH] /workspaces/current/skills/{skill_id}/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[PUT] /workspaces/current/skills/{skill_id}/files
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/skills/{skill_id}/files/check
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/skills/{skill_id}/files/content
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| download |
query |
Return as an attachment when 1. |
No |
string |
| path |
query |
Skill file path relative to the Skill root. |
Yes |
string |
| version_id |
query |
Optional published version ID. Omit for current draft. |
No |
string |
| skill_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/skills/{skill_id}/files/preview
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| path |
query |
Skill file path relative to the Skill root. |
Yes |
string |
| version_id |
query |
Optional published version ID. Omit for current draft. |
No |
string |
| skill_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/skills/{skill_id}/publish
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/skills/{skill_id}/references
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/skills/{skill_id}/restore
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/skills/{skill_id}/versions
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
Responses
[DELETE] /workspaces/current/skills/{skill_id}/versions/{version_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
| version_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/skills/{skill_id}/versions/{version_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
| version_id |
path |
|
Yes |
string |
Responses
[PATCH] /workspaces/current/skills/{skill_id}/versions/{version_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| skill_id |
path |
|
Yes |
string |
| version_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/summary
Responses
[GET] /workspaces/current/tool-labels
Responses
[POST] /workspaces/current/tool-provider/api/add
Request Body
Responses
[POST] /workspaces/current/tool-provider/api/delete
Request Body
Responses
[GET] /workspaces/current/tool-provider/api/get
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
query |
|
Yes |
string |
Responses
[GET] /workspaces/current/tool-provider/api/remote
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| url |
query |
|
Yes |
string (uri) |
Responses
[POST] /workspaces/current/tool-provider/api/schema
Request Body
Responses
[POST] /workspaces/current/tool-provider/api/test/pre
Request Body
Responses
[GET] /workspaces/current/tool-provider/api/tools
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
query |
|
Yes |
string |
Responses
[POST] /workspaces/current/tool-provider/api/update
Request Body
Responses
[POST] /workspaces/current/tool-provider/builtin/{provider}/add
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/credential/info
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| include_credential_ids |
query |
Credential IDs to include even if visibility would hide them |
No |
[ string ] |
| provider |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/credential/schema/{credential_type}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| credential_type |
path |
|
Yes |
string |
| provider |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/credentials
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| include_credential_ids |
query |
Credential IDs to include even if visibility would hide them |
No |
[ string ] |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/tool-provider/builtin/{provider}/default-credential
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/tool-provider/builtin/{provider}/delete
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/icon
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 200 |
Builtin provider icon |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/tool-provider/builtin/{provider}/info
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/client-schema
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[DELETE] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 200 |
Custom OAuth client retrieved successfully |
|
| default |
Error |
application/json: ErrorResponse
|
[POST] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/tool-provider/builtin/{provider}/tools
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/tool-provider/builtin/{provider}/update
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[DELETE] /workspaces/current/tool-provider/mcp
Request Body
Responses
[POST] /workspaces/current/tool-provider/mcp
Request Body
Responses
[PUT] /workspaces/current/tool-provider/mcp
Request Body
Responses
[POST] /workspaces/current/tool-provider/mcp/auth
Request Body
Responses
| Code |
Description |
Schema |
| 200 |
MCP provider authorized successfully |
application/json: MCPAuthResponse
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/tool-provider/mcp/tools/{provider_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/tool-provider/mcp/update/{provider_id}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/tool-provider/workflow/create
Request Body
Responses
[POST] /workspaces/current/tool-provider/workflow/delete
Request Body
Responses
[GET] /workspaces/current/tool-provider/workflow/get
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| workflow_app_id |
query |
|
No |
string |
| workflow_tool_id |
query |
|
No |
string |
Responses
[GET] /workspaces/current/tool-provider/workflow/tools
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| workflow_tool_id |
query |
|
Yes |
string |
Responses
[POST] /workspaces/current/tool-provider/workflow/update
Request Body
Responses
[GET] /workspaces/current/tool-providers
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| type |
query |
|
No |
string,
Available values: "api", "builtin", "mcp", "model", "workflow" |
Responses
[GET] /workspaces/current/tools/api
Responses
[GET] /workspaces/current/tools/builtin
Responses
[GET] /workspaces/current/tools/mcp
Responses
[GET] /workspaces/current/tools/workflow
Responses
[GET] /workspaces/current/trigger-provider/{provider}/icon
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 200 |
Trigger provider icon |
|
| default |
Error |
application/json: ErrorResponse
|
[GET] /workspaces/current/trigger-provider/{provider}/info
Get info for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[DELETE] /workspaces/current/trigger-provider/{provider}/oauth/client
Remove custom OAuth client configuration
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/trigger-provider/{provider}/oauth/client
Get OAuth client configuration for a provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/trigger-provider/{provider}/oauth/client
Configure custom OAuth client for a provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/build/{subscription_builder_id}
Build a subscription instance for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
| subscription_builder_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/create
Add a new subscription instance for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/logs/{subscription_builder_id}
Get the request logs for a subscription instance for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
| subscription_builder_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/update/{subscription_builder_id}
Update a subscription instance for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
| subscription_builder_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/verify-and-update/{subscription_builder_id}
Verify and update a subscription instance for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
| subscription_builder_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/{subscription_builder_id}
Get a subscription instance for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
| subscription_builder_id |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/trigger-provider/{provider}/subscriptions/list
List all trigger subscriptions for the current tenant's provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[GET] /workspaces/current/trigger-provider/{provider}/subscriptions/oauth/authorize
Initiate OAuth authorization flow for a trigger provider
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/trigger-provider/{provider}/subscriptions/verify/{subscription_id}
Verify credentials for an existing subscription (edit mode only)
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| provider |
path |
|
Yes |
string |
| subscription_id |
path |
|
Yes |
string |
Request Body
Responses
[POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/delete
Delete a subscription instance
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| subscription_id |
path |
|
Yes |
string |
Responses
[POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/update
Update a subscription instance
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| subscription_id |
path |
|
Yes |
string |
Request Body
Responses
[GET] /workspaces/current/triggers
List all trigger providers for the current tenant
Responses
[GET] /workspaces/custom-config
Responses
[POST] /workspaces/custom-config
Request Body
Responses
[POST] /workspaces/custom-config/webapp-logo/upload
Request Body
| Required |
Schema |
| Yes |
multipart/form-data: { "file": binary }
|
Responses
[POST] /workspaces/info
Request Body
Responses
[POST] /workspaces/switch
Request Body
Responses
[GET] /workspaces/{tenant_id}/model-providers/{provider}/{icon_type}/{lang}
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| icon_type |
path |
|
Yes |
string |
| lang |
path |
|
Yes |
string |
| provider |
path |
|
Yes |
string |
| tenant_id |
path |
|
Yes |
string |
Responses
| Code |
Description |
Schema |
| 200 |
Model provider icon |
|
| default |
Error |
application/json: ErrorResponse
|
default
Default namespace
[GET] /explore/banners
Get banner list
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| language |
query |
Banner language |
No |
string,
Default: en-US |
Responses
Schemas
AIModelEntity
Model class for AI model.
AIModelEntityResponse
APIBasedExtensionListResponse
| Name |
Type |
Description |
Required |
| APIBasedExtensionListResponse |
array |
|
|
APIBasedExtensionPayload
| Name |
Type |
Description |
Required |
| api_endpoint |
string |
API endpoint URL |
Yes |
| api_key |
string |
API key for authentication |
Yes |
| name |
string |
Extension name |
Yes |
APIBasedExtensionResponse
| Name |
Type |
Description |
Required |
| api_endpoint |
string |
|
Yes |
| api_key |
string |
|
Yes |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
AccessDeniedError
App access denied.
| Name |
Type |
Description |
Required |
| AccessDeniedError |
|
App access denied. |
|
AccessMatrixItem
AccessPolicy
| Name |
Type |
Description |
Required |
| category |
string |
|
No |
| created_at |
integer |
|
No |
| description |
string |
|
No |
| id |
string |
|
Yes |
| is_builtin |
boolean |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| policy_key |
string |
|
No |
| resource_type |
string |
|
Yes |
| tenant_id |
string |
|
No |
| updated_at |
integer |
|
No |
AccessPolicyAccount
| Name |
Type |
Description |
Required |
| account_id |
string |
|
Yes |
| account_name |
string |
|
Yes |
| avatar |
string |
|
No |
| binding_id |
string |
|
Yes |
| email |
string |
|
No |
| is_locked |
boolean |
|
No |
AccessPolicyBindingState
| Name |
Type |
Description |
Required |
| binding_id |
string |
|
Yes |
| is_locked |
boolean |
|
No |
AccessPolicyMemberBinding
| Name |
Type |
Description |
Required |
| access_policy_id |
string |
|
Yes |
| account_id |
string |
|
Yes |
| account_name |
string |
|
No |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| resource_id |
string |
|
No |
| resource_type |
string |
|
Yes |
| tenant_id |
string |
|
No |
AccessPolicyRole
| Name |
Type |
Description |
Required |
| binding_id |
string |
|
Yes |
| is_locked |
boolean |
|
No |
| role_id |
string |
|
Yes |
| role_name |
string |
|
Yes |
| role_tag |
string |
|
No |
AccessPolicyRoleBinding
| Name |
Type |
Description |
Required |
| access_policy_id |
string |
|
Yes |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| resource_id |
string |
|
No |
| resource_type |
string |
|
Yes |
| role_id |
string |
|
Yes |
| role_name |
string |
|
No |
| tenant_id |
string |
|
No |
AccountAlreadyInitedError
The account has been initialized. Please refresh the page.
| Name |
Type |
Description |
Required |
| AccountAlreadyInitedError |
|
The account has been initialized. Please refresh the page. |
|
AccountAvatarPayload
| Name |
Type |
Description |
Required |
| avatar |
string |
|
Yes |
AccountAvatarQuery
| Name |
Type |
Description |
Required |
| avatar |
string |
Avatar file ID |
Yes |
AccountBannedError
Account is banned.
| Name |
Type |
Description |
Required |
| AccountBannedError |
|
Account is banned. |
|
AccountDeletePayload
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| token |
string |
|
Yes |
AccountDeletionFeedbackPayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| feedback |
string |
|
Yes |
AccountInFreezeError
This email account has been deleted within the past 30 days and is temporarily unavailable for new account registration.
| Name |
Type |
Description |
Required |
| AccountInFreezeError |
|
This email account has been deleted within the past 30 days and is temporarily unavailable for new account registration. |
|
AccountInitPayload
| Name |
Type |
Description |
Required |
| interface_language |
string |
|
Yes |
| invitation_code |
string |
|
No |
| timezone |
string |
|
Yes |
AccountIntegrateListResponse
AccountIntegrateResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| is_bound |
boolean |
|
Yes |
| link |
string |
|
No |
| provider |
string |
|
Yes |
AccountInterfaceLanguagePayload
| Name |
Type |
Description |
Required |
| interface_language |
string |
|
Yes |
AccountInterfaceThemePayload
| Name |
Type |
Description |
Required |
| interface_theme |
string,
Available values: "dark", "light" |
Enum: "dark", "light" |
Yes |
AccountNamePayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
AccountNotFoundError
Account not found.
| Name |
Type |
Description |
Required |
| AccountNotFoundError |
|
Account not found. |
|
AccountNotLinkTenantError
Account not link tenant.
| Name |
Type |
Description |
Required |
| AccountNotLinkTenantError |
|
Account not link tenant. |
|
AccountPasswordPayload
| Name |
Type |
Description |
Required |
| new_password |
string |
|
Yes |
| password |
string |
|
No |
| repeat_new_password |
string |
|
Yes |
AccountProfilePatchPayload
| Name |
Type |
Description |
Required |
| avatar |
string |
|
No |
| interface_language |
string |
|
No |
| interface_theme |
string,
Available values: "dark", "light" |
Enum: "dark", "light" |
No |
| name |
string |
|
No |
| timezone |
string |
|
No |
AccountResponse
| Name |
Type |
Description |
Required |
| avatar |
string |
|
No |
| avatar_url |
string |
|
Yes |
| created_at |
integer |
|
No |
| email |
string |
|
Yes |
| id |
string |
|
Yes |
| interface_language |
string |
|
No |
| interface_theme |
string |
|
No |
| is_password_set |
boolean |
|
Yes |
| last_login_at |
integer |
|
No |
| last_login_ip |
string |
|
No |
| name |
string |
|
Yes |
| timezone |
string |
|
No |
AccountTimezonePayload
| Name |
Type |
Description |
Required |
| timezone |
string |
|
Yes |
AccountWithRoleListResponse
AccountWithRoleResponse
| Name |
Type |
Description |
Required |
| avatar |
string |
|
No |
| avatar_url |
string |
|
Yes |
| created_at |
integer |
|
No |
| email |
string |
|
Yes |
| id |
string |
|
Yes |
| last_active_at |
integer |
|
No |
| last_login_at |
integer |
|
No |
| name |
string |
|
Yes |
| role |
string |
|
Yes |
| roles |
[ MemberRoleSummaryResponse ] |
|
No |
| status |
string |
|
Yes |
ActivateCheckQuery
| Name |
Type |
Description |
Required |
| email |
string |
|
No |
| token |
string |
|
Yes |
| workspace_id |
string |
|
No |
ActivatePayload
| Name |
Type |
Description |
Required |
| email |
string |
|
No |
| interface_language |
string |
|
No |
| name |
string |
|
No |
| timezone |
string |
|
No |
| token |
string |
|
Yes |
| workspace_id |
string |
|
No |
ActivationCheckData
| Name |
Type |
Description |
Required |
| account_status |
string |
|
No |
| email |
string |
|
Yes |
| requires_setup |
boolean |
|
No |
| workspace_id |
string |
|
Yes |
| workspace_name |
string |
|
Yes |
ActivationCheckResponse
| Name |
Type |
Description |
Required |
| data |
ActivationCheckData |
Activation data if valid |
No |
| is_valid |
boolean |
Whether token is valid |
Yes |
ActivationResponse
| Name |
Type |
Description |
Required |
| result |
string |
Operation result |
Yes |
AdvancedChatWorkflowRunForListResponse
| Name |
Type |
Description |
Required |
| conversation_id |
string |
|
No |
| created_at |
integer |
|
No |
| created_by_account |
SimpleAccountResponse |
|
No |
| elapsed_time |
number |
|
No |
| exceptions_count |
integer |
|
No |
| finished_at |
integer |
|
No |
| id |
string |
|
Yes |
| message_id |
string |
|
No |
| retry_index |
integer |
|
No |
| status |
string |
|
No |
| total_steps |
integer |
|
No |
| total_tokens |
integer |
|
No |
| version |
string |
|
No |
AdvancedChatWorkflowRunPayload
| Name |
Type |
Description |
Required |
| conversation_id |
string |
|
No |
| files |
[ object ] |
|
No |
| inputs |
object |
|
No |
| parent_message_id |
string |
|
No |
| query |
string |
|
No |
AdvancedPromptTemplateQuery
| Name |
Type |
Description |
Required |
| app_mode |
string |
Application mode |
Yes |
| has_context |
string,
Default: true |
Whether has context |
No |
| model_mode |
string |
Model mode |
Yes |
| model_name |
string |
Model name |
Yes |
AdvancedPromptTemplateResponse
| Name |
Type |
Description |
Required |
| chat_prompt_config |
object |
|
No |
| completion_prompt_config |
object |
|
No |
AgentAccessMatrix
AgentApiAccessResponse
| Name |
Type |
Description |
Required |
| access_ready |
boolean |
|
Yes |
| api_key_count |
integer |
|
Yes |
| api_rph |
integer |
|
Yes |
| api_rpm |
integer |
|
Yes |
| chat_endpoint |
string |
|
Yes |
| conversations_endpoint |
string |
|
Yes |
| enabled |
boolean |
|
Yes |
| files_upload_endpoint |
string |
|
Yes |
| info_endpoint |
string |
|
Yes |
| messages_endpoint |
string |
|
Yes |
| meta_endpoint |
string |
|
Yes |
| parameters_endpoint |
string |
|
Yes |
| service_api_base_url |
string |
|
Yes |
| stop_endpoint |
string |
|
Yes |
| streaming_only |
boolean,
Default: true |
|
No |
AgentApiStatusPayload
| Name |
Type |
Description |
Required |
| enable_api |
boolean |
Enable or disable Agent service API |
Yes |
AgentAppComposerResponse
AgentAppCopyPayload
| Name |
Type |
Description |
Required |
| description |
string |
Description for the copied agent |
No |
| icon |
string |
Icon |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
| name |
string |
Name for the copied agent |
No |
| role |
string |
Role for the copied agent |
No |
AgentAppCreatePayload
| Name |
Type |
Description |
Required |
| description |
string |
Agent description (max 400 chars) |
No |
| icon |
string |
Icon |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
| name |
string |
Agent name |
Yes |
| role |
string |
Agent role |
No |
AgentAppDetailWithSite
| Name |
Type |
Description |
Required |
| access_mode |
WebAppAccessMode |
|
Yes |
| access_ready |
boolean |
|
No |
| api_base_url |
string |
|
Yes |
| app_id |
string |
|
No |
| backing_app_id |
string |
|
No |
| bound_agent_id |
string |
|
No |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| debug_conversation_has_messages |
boolean |
|
No |
| debug_conversation_id |
string |
|
No |
| debug_conversation_message_count |
integer |
|
No |
| deleted_tools |
[ DeletedTool ] |
|
Yes |
| description |
string |
|
Yes |
| enable_api |
boolean |
|
Yes |
| enable_site |
boolean |
|
Yes |
| hidden_app_backed |
boolean |
|
No |
| icon |
string |
|
Yes |
| icon_background |
string |
|
Yes |
| icon_type |
IconType |
|
Yes |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| maintainer |
string |
|
Yes |
| max_active_requests |
integer |
|
Yes |
| mode |
AppMode |
|
Yes |
| model_config |
AppModelConfigResponse |
|
Yes |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
Yes |
| role |
string |
|
No |
| site |
AppDetailSiteResponse |
|
Yes |
| tags |
[ Tag ] |
|
Yes |
| tracing |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
| workflow |
WorkflowPartial |
|
Yes |
AgentAppFeaturesPayload
Presentation features configurable on an Agent App.
All fields are optional; an omitted field is reset to its disabled/empty
default (the config form sends the full desired feature state on save).
AgentAppListQuery
| Name |
Type |
Description |
Required |
| creator_ids |
[ string ] |
Filter by creator account IDs |
No |
| is_created_by_me |
boolean |
Filter by creator |
No |
| limit |
integer,
Default: 20 |
Page size (1-100) |
No |
| mode |
string,
Available values: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow",
Default: all |
App mode filter
Enum: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow" |
No |
| name |
string |
Filter by app name |
No |
| openapi_visible |
boolean |
Only return apps with API access enabled |
No |
| page |
integer,
Default: 1 |
Page number (1-99999) |
No |
| publication_status |
string,
Available values: "drafts", "published" |
Filter by published or draft Agent configuration status |
No |
| sort_by |
string,
Available values: "earliest_created", "last_modified", "recently_created",
Default: last_modified |
Sort apps by last modified, recently created, or earliest created
Enum: "earliest_created", "last_modified", "recently_created" |
No |
| tag_ids |
[ string ] |
Filter by tag IDs |
No |
AgentAppPartial
| Name |
Type |
Description |
Required |
| access_mode |
WebAppAccessMode |
|
No |
| active_config_is_published |
boolean |
|
No |
| app_id |
string |
|
No |
| author_name |
string |
|
No |
| backing_app_id |
string |
|
No |
| bound_agent_id |
string |
|
No |
| create_user_name |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| debug_conversation_id |
string |
|
No |
| description |
string |
|
No |
| has_draft_trigger |
boolean |
|
No |
| hidden_app_backed |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
IconType |
|
No |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| is_starred |
boolean |
|
No |
| maintainer |
string |
|
No |
| max_active_requests |
integer |
|
No |
| mode |
AppMode |
|
Yes |
| model_config |
ModelConfigPartial |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
Yes |
| published_reference_count |
integer |
|
No |
| published_references |
[ AgentAppPublishedReferenceResponse ] |
|
No |
| reference_count |
integer |
|
No |
| role |
string |
|
No |
| tags |
[ Tag ] |
|
No |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
| use_icon_as_answer_icon |
boolean |
|
No |
| workflow |
WorkflowPartial |
|
No |
AgentAppPublishedReferenceResponse
| Name |
Type |
Description |
Required |
| app_icon |
string |
|
No |
| app_icon_background |
string |
|
No |
| app_icon_type |
string |
|
No |
| app_id |
string |
|
Yes |
| app_name |
string |
|
Yes |
AgentAppUpdatePayload
| Name |
Type |
Description |
Required |
| description |
string |
App description (max 400 chars) |
No |
| icon |
string |
Icon |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
| max_active_requests |
integer |
Maximum active requests |
No |
| name |
string |
App name |
Yes |
| role |
string |
Agent role |
No |
| use_icon_as_answer_icon |
boolean |
Use icon as answer icon |
No |
AgentAudioTranscriptFormPayload
AgentAverageResponseTimeStatisticResponse
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| latency |
number |
|
Yes |
AgentAverageSessionInteractionStatisticResponse
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| interactions |
number |
|
Yes |
AgentBackendUnreachableError
Agent backend is unreachable.
| Name |
Type |
Description |
Required |
| AgentBackendUnreachableError |
|
Agent backend is unreachable. |
|
AgentBuildDraftApplyResponse
| Name |
Type |
Description |
Required |
| draft |
object |
|
Yes |
| result |
string |
|
Yes |
AgentBuildDraftCheckoutPayload
| Name |
Type |
Description |
Required |
| force |
boolean |
Overwrite the existing current-user build draft |
No |
AgentBuildDraftResponse
AgentBuildSandboxNotFoundError
The retained Build Sandbox is no longer available.
| Name |
Type |
Description |
Required |
| AgentBuildSandboxNotFoundError |
|
The retained Build Sandbox is no longer available. |
|
AgentCliToolAuthorizationStatus
Authorization state for Agent-scoped CLI tools.
Missing status keeps backward compatibility with draft rows and CLI tools that
do not need pre-authorization. Explicit denied-like states are blocked by the
composer/publish validators and skipped by runtime request builders.
| Name |
Type |
Description |
Required |
| AgentCliToolAuthorizationStatus |
string |
Authorization state for Agent-scoped CLI tools. Missing status keeps backward compatibility with draft rows and CLI tools that do not need pre-authorization. Explicit denied-like states are blocked by the composer/publish validators and skipped by runtime request builders. |
|
AgentCliToolConfig
| Name |
Type |
Description |
Required |
| approved |
boolean |
|
No |
| authorization_status |
AgentCliToolAuthorizationStatus |
|
No |
| command |
string |
|
No |
| dangerous |
boolean |
|
No |
| dangerous_accepted |
boolean |
|
No |
| dangerous_acknowledged |
boolean |
|
No |
| dangerous_command |
boolean |
|
No |
| description |
string |
|
No |
| enabled |
boolean,
Default: true |
|
No |
| env |
AgentCliToolEnvConfig |
|
No |
| id |
string |
|
No |
| inferred_from |
string |
|
No |
| install |
string |
|
No |
| install_command |
string |
|
No |
| install_commands |
[ string ] |
|
No |
| invoke_metadata |
object |
|
No |
| label |
string |
|
No |
| name |
string |
|
No |
| permission |
AgentPermissionConfig |
|
No |
| pre_authorized |
boolean |
|
No |
| requires_confirmation |
boolean |
|
No |
| risk_accepted |
boolean |
|
No |
| risk_level |
AgentCliToolRiskLevel |
|
No |
| setup_command |
string |
|
No |
| tool_name |
string |
|
No |
AgentCliToolEnvConfig
AgentCliToolRiskLevel
Risk marker for CLI tool bootstrap commands.
| Name |
Type |
Description |
Required |
| AgentCliToolRiskLevel |
string |
Risk marker for CLI tool bootstrap commands. |
|
AgentComposerAgentResponse
| Name |
Type |
Description |
Required |
| active_config_snapshot_id |
string |
|
No |
| app_id |
string |
|
No |
| backing_app_id |
string |
|
No |
| description |
string |
|
Yes |
| hidden_app_backed |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| role |
string |
|
No |
| scope |
AgentScope |
|
Yes |
| source |
AgentSource |
|
No |
| status |
AgentStatus |
|
Yes |
AgentComposerBindingResponse
| Name |
Type |
Description |
Required |
| agent_id |
string |
|
No |
| binding_type |
WorkflowAgentBindingType |
|
Yes |
| current_snapshot_id |
string |
|
No |
| id |
string |
|
Yes |
| node_id |
string |
|
Yes |
| workflow_id |
string |
|
Yes |
AgentComposerCandidatesResponse
AgentComposerDifyToolCandidateResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| granularity |
string |
|
No |
| id |
string |
|
No |
| name |
string |
|
No |
| plugin_id |
string |
|
No |
| provider |
string |
|
No |
| provider_id |
string |
|
No |
| tools_count |
integer |
|
No |
AgentComposerImpactBindingResponse
| Name |
Type |
Description |
Required |
| app_id |
string |
|
Yes |
| node_id |
string |
|
Yes |
| workflow_id |
string |
|
Yes |
AgentComposerImpactResponse
AgentComposerKnowledgeDatasetCandidateResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| id |
string |
|
No |
| missing |
boolean |
|
No |
| name |
string |
|
No |
AgentComposerKnowledgeSetCandidateResponse
AgentComposerNodeJobCandidatesResponse
AgentComposerSoulCandidatesResponse
AgentComposerSoulLockResponse
| Name |
Type |
Description |
Required |
| can_unlock |
boolean |
|
No |
| locked |
boolean |
|
Yes |
| reason |
string |
|
No |
AgentComposerValidateResponse
AgentConfigDeleteResponse
| Name |
Type |
Description |
Required |
| removed_names |
[ string ] |
|
No |
| result |
string |
|
Yes |
AgentConfigDownloadResponse
| Name |
Type |
Description |
Required |
| url |
string |
|
Yes |
AgentConfigDraftSummaryResponse
| Name |
Type |
Description |
Required |
| account_id |
string |
|
No |
| agent_id |
string |
|
Yes |
| base_snapshot_id |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| draft_type |
AgentConfigDraftType |
|
Yes |
| id |
string |
|
Yes |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
AgentConfigDraftType
Editable Agent Soul draft workspace type.
| Name |
Type |
Description |
Required |
| AgentConfigDraftType |
string |
Editable Agent Soul draft workspace type. |
|
AgentConfigFileItemResponse
| Name |
Type |
Description |
Required |
| file_id |
string |
|
No |
| hash |
string |
|
No |
| id |
string |
|
Yes |
| is_missing |
boolean |
|
No |
| mime_type |
string |
|
No |
| name |
string |
|
Yes |
| size |
integer |
|
No |
AgentConfigFileItemsResponse
AgentConfigFileListResponse
AgentConfigFilePreviewResponse
| Name |
Type |
Description |
Required |
| binary |
boolean |
|
Yes |
| name |
string |
|
Yes |
| size |
integer |
|
No |
| text |
string |
|
No |
| truncated |
boolean |
|
Yes |
AgentConfigFileRefConfig
Stable Agent Soul reference to one config file payload.
| Name |
Type |
Description |
Required |
| file_id |
string |
|
No |
| file_kind |
string,
Available values: "tool_file", "upload_file" |
Enum: "tool_file", "upload_file" |
Yes |
| hash |
string |
|
No |
| is_missing |
boolean |
|
No |
| mime_type |
string |
|
No |
| name |
string |
|
Yes |
| size |
integer |
|
No |
AgentConfigFileUploadPayload
| Name |
Type |
Description |
Required |
| upload_file_id |
string |
UploadFile UUID from POST /console/api/files/upload |
Yes |
AgentConfigFileUploadResponse
AgentConfigManifestResponse
AgentConfigRevisionOperation
Audit operation recorded for Agent Soul version/revision changes.
| Name |
Type |
Description |
Required |
| AgentConfigRevisionOperation |
string |
Audit operation recorded for Agent Soul version/revision changes. |
|
AgentConfigRevisionResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| current_snapshot_id |
string |
|
Yes |
| id |
string |
|
Yes |
| operation |
AgentConfigRevisionOperation |
|
Yes |
| previous_snapshot_id |
string |
|
No |
| revision |
integer |
|
Yes |
| summary |
string |
|
No |
| version_note |
string |
|
No |
AgentConfigSkillFilePreviewResponse
| Name |
Type |
Description |
Required |
| binary |
boolean |
|
Yes |
| path |
string |
|
Yes |
| size |
integer |
|
No |
| text |
string |
|
No |
| truncated |
boolean |
|
Yes |
AgentConfigSkillFileResponse
| Name |
Type |
Description |
Required |
| downloadable |
boolean |
|
Yes |
| name |
string |
|
Yes |
| path |
string |
|
Yes |
| previewable |
boolean |
|
Yes |
| type |
string,
Available values: "directory", "file" |
Enum: "directory", "file" |
Yes |
AgentConfigSkillInspectResponse
AgentConfigSkillItemResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| file_id |
string |
|
No |
| hash |
string |
|
No |
| id |
string |
|
Yes |
| is_missing |
boolean |
|
No |
| mime_type |
string |
|
No |
| name |
string |
|
Yes |
| size |
integer |
|
No |
AgentConfigSkillItemsResponse
AgentConfigSkillListResponse
AgentConfigSkillMarkdownResponse
| Name |
Type |
Description |
Required |
| binary |
boolean |
|
Yes |
| path |
string |
|
Yes |
| size |
integer |
|
No |
| text |
string |
|
Yes |
| truncated |
boolean |
|
Yes |
AgentConfigSkillRefConfig
Stable Agent Soul reference to one normalized skill archive.
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| file_id |
string |
|
No |
| file_kind |
string,
Default: tool_file |
|
No |
| hash |
string |
|
No |
| is_missing |
boolean |
|
No |
| mime_type |
string |
|
No |
| name |
string |
|
Yes |
| size |
integer |
|
No |
AgentConfigSkillUploadResponse
AgentConfigSnapshotDetailResponse
| Name |
Type |
Description |
Required |
| agent_id |
string |
|
No |
| config_snapshot |
AgentSoulConfig |
|
Yes |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| display_version |
integer |
|
No |
| id |
string |
|
Yes |
| revisions |
[ AgentConfigRevisionResponse ] |
|
No |
| snapshot_version |
integer |
|
No |
| summary |
string |
|
No |
| version |
integer |
|
Yes |
| version_note |
string |
|
No |
AgentConfigSnapshotListResponse
AgentConfigSnapshotRestoreResponse
| Name |
Type |
Description |
Required |
| active_config_snapshot_id |
string |
|
Yes |
| draft_config_id |
string |
|
No |
| restored_version_id |
string |
|
No |
| result |
string |
|
Yes |
AgentConfigSnapshotSummaryResponse
| Name |
Type |
Description |
Required |
| agent_id |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| display_version |
integer |
|
No |
| id |
string |
|
Yes |
| snapshot_version |
integer |
|
No |
| summary |
string |
|
No |
| version |
integer |
|
Yes |
| version_note |
string |
|
No |
AgentConfigVersionResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| kind |
string,
Available values: "build_draft", "draft", "snapshot" |
Enum: "build_draft", "draft", "snapshot" |
Yes |
| writable |
boolean |
|
Yes |
AgentDailyConversationStatisticResponse
| Name |
Type |
Description |
Required |
| conversation_count |
integer |
|
Yes |
| date |
string |
|
Yes |
AgentDailyEndUserStatisticResponse
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| terminal_count |
integer |
|
Yes |
AgentDailyMessageStatisticResponse
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| message_count |
integer |
|
Yes |
AgentDebugConversationRefreshResponse
| Name |
Type |
Description |
Required |
| debug_conversation_has_messages |
boolean |
|
No |
| debug_conversation_id |
string |
|
Yes |
| debug_conversation_message_count |
integer |
|
No |
AgentEnvVariableConfig
| Name |
Type |
Description |
Required |
| default |
string
integer
number
boolean
[ string ]
[ integer ]
[ number ]
[ boolean ] |
|
No |
| env_name |
string |
|
No |
| key |
string |
|
No |
| name |
string |
|
No |
| required |
boolean |
|
No |
| type |
string |
|
No |
| value |
string
integer
number
boolean
[ string ]
[ integer ]
[ number ]
[ boolean ] |
|
No |
| variable |
string |
|
No |
AgentFeature
Agent Feature, used to describe the features of the agent strategy.
| Name |
Type |
Description |
Required |
| AgentFeature |
string |
Agent Feature, used to describe the features of the agent strategy. |
|
AgentFeatureToggleConfig
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
AgentFileRefConfig
| Name |
Type |
Description |
Required |
| file_id |
string |
|
No |
| id |
string |
|
No |
| name |
string |
|
No |
| reference |
string |
|
No |
| remote_url |
string |
|
No |
| tenant_id |
string |
|
No |
| transfer_method |
string |
|
No |
| type |
string |
|
No |
| upload_file_id |
string |
|
No |
| url |
string |
|
No |
AgentFileUploadFeatureConfig
AgentFileUploadImageFeatureConfig
| Name |
Type |
Description |
Required |
| enabled |
boolean,
Default: true |
|
No |
AgentHomeSnapshotCreateFailedError
Failed to capture the Agent Home Snapshot.
| Name |
Type |
Description |
Required |
| AgentHomeSnapshotCreateFailedError |
|
Failed to capture the Agent Home Snapshot. |
|
AgentHomeSnapshotTooLargeError
The Agent Home Snapshot exceeds the configured size limit.
| Name |
Type |
Description |
Required |
| AgentHomeSnapshotTooLargeError |
|
The Agent Home Snapshot exceeds the configured size limit. |
|
AgentHumanContactConfig
| Name |
Type |
Description |
Required |
| channel |
string |
|
No |
| contact_id |
string |
|
No |
| contact_method |
string |
|
No |
| email |
string |
|
No |
| human_id |
string |
|
No |
| id |
string |
|
No |
| method |
string |
|
No |
| name |
string |
|
No |
| tenant_id |
string |
|
No |
AgentHumanToolConfig
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| enabled |
boolean,
Default: true |
|
No |
| name |
string |
|
No |
AgentIconType
Supported icon storage formats for Agent roster entries.
| Name |
Type |
Description |
Required |
| AgentIconType |
string |
Supported icon storage formats for Agent roster entries. |
|
AgentIdPath
| Name |
Type |
Description |
Required |
| agent_id |
string |
|
Yes |
AgentInviteOptionResponse
| Name |
Type |
Description |
Required |
| active_config_is_published |
boolean |
|
No |
| active_config_snapshot |
AgentConfigSnapshotSummaryResponse |
|
No |
| active_config_snapshot_id |
string |
|
No |
| agent_kind |
AgentKind |
|
Yes |
| app_id |
string |
|
No |
| archived_at |
integer |
|
No |
| archived_by |
string |
|
No |
| backing_app_id |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| description |
string |
|
Yes |
| existing_node_ids |
[ string ] |
|
No |
| hidden_app_backed |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
AgentIconType |
|
No |
| id |
string |
|
Yes |
| in_current_workflow_count |
integer |
|
No |
| is_in_current_workflow |
boolean |
|
No |
| name |
string |
|
Yes |
| published_node_reference_count |
integer |
|
No |
| published_reference_count |
integer |
|
No |
| published_references |
[ AgentPublishedReferenceResponse ] |
|
No |
| reference_count |
integer |
|
No |
| role |
string |
|
No |
| scope |
AgentScope |
|
Yes |
| source |
AgentSource |
|
Yes |
| status |
AgentStatus |
|
Yes |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
| workflow_id |
string |
|
No |
| workflow_node_id |
string |
|
No |
AgentInviteOptionsQuery
| Name |
Type |
Description |
Required |
| app_id |
string |
Workflow app id for in-current-workflow markers |
No |
| keyword |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
AgentInviteOptionsResponse
| Name |
Type |
Description |
Required |
| data |
[ AgentInviteOptionResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
AgentIterationLogResponse
| Name |
Type |
Description |
Required |
| created_at |
string |
|
Yes |
| files |
[ ] |
|
No |
| thought |
string |
|
No |
| tokens |
integer |
|
Yes |
| tool_calls |
[ AgentToolCallResponse ] |
|
Yes |
| tool_raw |
object |
|
Yes |
AgentKind
Agent implementation family.
This leaves room for future non-Dify agent implementations while keeping
the current roster/workflow APIs scoped to Dify Agent.
| Name |
Type |
Description |
Required |
| AgentKind |
string |
Agent implementation family. This leaves room for future non-Dify agent implementations while keeping the current roster/workflow APIs scoped to Dify Agent. |
|
AgentKnowledgeDatasetConfig
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| id |
string |
|
No |
| name |
string |
|
No |
AgentKnowledgeMetadataCondition
One manual metadata filter clause.
id and metadata_id are UI-only bookkeeping the composer sends on
every save (a stable row key and a reference to the selected metadata
field). They are persisted here for round-tripping the composer's draft
state but are stripped before building the Agent runtime request, whose
DTO only accepts name/comparison_operator/value.
| Name |
Type |
Description |
Required |
| comparison_operator |
string,
Available values: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Enum: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Yes |
| id |
string |
|
No |
| metadata_id |
string |
|
No |
| name |
string |
|
Yes |
| value |
string
[ string ]
number |
|
No |
AgentKnowledgeMetadataConditions
| Name |
Type |
Description |
Required |
| conditions |
[ AgentKnowledgeMetadataCondition ] |
|
No |
| logical_operator |
string,
Available values: "and", "or",
Default: and |
Enum: "and", "or" |
No |
AgentKnowledgeMetadataFilteringConfig
Per-set metadata filtering policy.
The Python attribute uses metadata_model_config for clarity because the
model belongs to metadata filtering specifically, while the external API and
generated schema keep the historical model_config field name via alias.
Mode-dependent completeness is enforced by composer publish validation so
draft saves can persist partially configured metadata filters.
AgentKnowledgeModelConfig
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
No |
| mode |
string |
|
Yes |
| name |
string |
|
Yes |
| provider |
string |
|
Yes |
AgentKnowledgeQueryConfig
Per-set query policy for Agent v2 knowledge retrieval.
Agent v2 stores knowledge as explicit knowledge.sets rather than the
legacy flat datasets / query_mode / query_config shape. Each
set owns its own query policy. Mode-dependent completeness, such as
requiring value for user_query, is enforced by composer publish
validation so draft saves can persist partially configured knowledge sets.
AgentKnowledgeQueryMode
| Name |
Type |
Description |
Required |
| AgentKnowledgeQueryMode |
string |
|
|
AgentKnowledgeRerankingModelConfig
| Name |
Type |
Description |
Required |
| model |
string |
|
Yes |
| provider |
string |
|
Yes |
AgentKnowledgeRetrievalConfig
Per-set retrieval policy for Agent v2 knowledge retrieval.
Retrieval settings now live on each knowledge set instead of one shared
flat config. Mode-dependent completeness, such as requiring top_k for
multiple or a model for single, is enforced by composer publish
validation so draft saves can persist partially configured knowledge sets.
AgentKnowledgeSetConfig
One explicit knowledge set in Agent v2.
knowledge.sets replaces the old flat knowledge config. Each set owns
its datasets plus query, retrieval, and metadata policies. An individual
set must contain at least one dataset id even though the overall knowledge
section may be empty, which is how callers express "no knowledge layer".
AgentKnowledgeWeightedScoreConfig
| Name |
Type |
Description |
Required |
| keyword_setting |
object |
|
No |
| vector_setting |
object |
|
No |
| weight_type |
string |
|
No |
AgentLogConversationItemResponse
| Name |
Type |
Description |
Required |
| conversation_id |
string |
|
Yes |
| created_at |
integer |
|
No |
| end_user_id |
string |
|
No |
| id |
string |
|
Yes |
| message_count |
integer |
|
Yes |
| operation_rate |
number |
|
No |
| source |
AgentLogSourceResponse |
|
No |
| status |
string,
Available values: "failed", "paused", "success" |
Enum: "failed", "paused", "success" |
Yes |
| title |
string |
|
No |
| unread |
boolean |
|
Yes |
| updated_at |
integer |
|
No |
| user_rate |
number |
|
No |
AgentLogFeedbackResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| from_source |
string,
Available values: "admin", "user" |
Enum: "admin", "user" |
Yes |
| rating |
string,
Available values: "dislike", "like" |
Enum: "dislike", "like" |
Yes |
AgentLogListResponse
AgentLogMessageItemResponse
| Name |
Type |
Description |
Required |
| answer |
string |
|
Yes |
| answer_tokens |
integer |
|
Yes |
| conversation_id |
string |
|
Yes |
| created_at |
integer |
|
No |
| currency |
string |
|
Yes |
| error |
string |
|
No |
| feedback_enabled |
boolean |
|
No |
| feedbacks |
[ AgentLogFeedbackResponse ] |
|
No |
| from_account_id |
string |
|
No |
| from_end_user_id |
string |
|
No |
| id |
string |
|
Yes |
| latency |
number |
|
Yes |
| message_id |
string |
|
Yes |
| message_tokens |
integer |
|
Yes |
| query |
string |
|
Yes |
| status |
string |
|
Yes |
| total_price |
string |
|
Yes |
| total_tokens |
integer |
|
Yes |
| updated_at |
integer |
|
No |
AgentLogMessageListResponse
| Name |
Type |
Description |
Required |
| data |
[ AgentLogMessageItemResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
AgentLogMetaResponse
| Name |
Type |
Description |
Required |
| agent_mode |
string |
|
Yes |
| elapsed_time |
number |
|
No |
| executor |
string |
|
Yes |
| iterations |
integer |
|
Yes |
| start_time |
string |
|
Yes |
| status |
string |
|
Yes |
| total_tokens |
integer |
|
Yes |
AgentLogResponse
AgentLogSourceGroupResponse
| Name |
Type |
Description |
Required |
| label |
string |
|
Yes |
| sources |
[ AgentLogSourceResponse ] |
|
No |
| type |
string,
Available values: "webapp", "workflow" |
Enum: "webapp", "workflow" |
Yes |
AgentLogSourceListResponse
AgentLogSourceResponse
| Name |
Type |
Description |
Required |
| app_icon |
string |
|
No |
| app_icon_background |
string |
|
No |
| app_icon_type |
string |
|
No |
| app_id |
string |
|
Yes |
| app_name |
string |
|
Yes |
| id |
string |
|
Yes |
| node_id |
string |
|
No |
| type |
string,
Available values: "webapp", "workflow" |
Enum: "webapp", "workflow" |
Yes |
| workflow_id |
string |
|
No |
| workflow_version |
string |
|
No |
AgentLogsQuery
| Name |
Type |
Description |
Required |
| end |
string |
End date (YYYY-MM-DD HH:MM) |
No |
| keyword |
string |
Search query, answer, or conversation name |
No |
| limit |
integer,
Default: 20 |
Page size |
No |
| page |
integer,
Default: 1 |
Page number |
No |
| sort_by |
string,
Default: updated_at |
Sort by created_at or updated_at |
No |
| sort_order |
string,
Default: desc |
Sort order: asc or desc |
No |
| source |
string |
Deprecated single source filter |
No |
| sources |
[ string ] |
Filter by one or more source IDs, e.g. webapp:<app_id> or workflow:<app_id>. Exact workflow:<app_id>:<workflow_id>::<node_id> IDs remain supported. |
No |
| start |
string |
Start date (YYYY-MM-DD HH:MM) |
No |
| status |
string |
Deprecated single status filter |
No |
| statuses |
[ string ] |
Filter by one or more of success, failed, paused |
No |
AgentMemoryArtifactConfig
| Name |
Type |
Description |
Required |
| id |
string |
|
No |
| name |
string |
|
No |
| type |
string |
|
No |
| url |
string |
|
No |
AgentModelNotConfiguredError
Agent App requires the Agent Soul model to be configured.
| Name |
Type |
Description |
Required |
| AgentModelNotConfiguredError |
|
Agent App requires the Agent Soul model to be configured. |
|
AgentModelResponseFormatConfig
| Name |
Type |
Description |
Required |
| type |
string |
|
No |
AgentModerationIOConfig
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| preset_response |
string |
|
No |
AgentModerationProviderConfig
AgentNameConflictError
Agent name already exists.
| Name |
Type |
Description |
Required |
| AgentNameConflictError |
|
Agent name already exists. |
|
AgentNotBoundError
no agent is bound for this app/node
| Name |
Type |
Description |
Required |
| AgentNotBoundError |
|
no agent is bound for this app/node |
|
AgentNotFoundError
Agent not found.
| Name |
Type |
Description |
Required |
| AgentNotFoundError |
|
Agent not found. |
|
AgentNotPublishedError
Publish the Agent before enabling Web App or API access.
| Name |
Type |
Description |
Required |
| AgentNotPublishedError |
|
Publish the Agent before enabling Web App or API access. |
|
AgentPermissionConfig
| Name |
Type |
Description |
Required |
| allowed |
boolean |
|
No |
| state |
string |
|
No |
| status |
string |
|
No |
AgentProviderEntityWithPlugin
AgentProviderListResponse
| Name |
Type |
Description |
Required |
| AgentProviderListResponse |
array |
|
|
AgentProviderResponse
| Name |
Type |
Description |
Required |
| declaration |
AgentProviderEntityWithPlugin |
|
Yes |
| meta |
Meta |
|
Yes |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| provider |
string |
|
Yes |
AgentPublicationCountsResponse
| Name |
Type |
Description |
Required |
| drafts |
integer |
Draft Agent Apps in the current list scope, excluding the publication status filter |
Yes |
| published |
integer |
Published Agent Apps in the current list scope, excluding the publication status filter |
Yes |
AgentPublishPayload
| Name |
Type |
Description |
Required |
| version_note |
string |
Optional note for this published Agent version |
No |
AgentPublishResponse
| Name |
Type |
Description |
Required |
| active_config_snapshot |
AgentConfigSnapshotSummaryResponse |
|
No |
| active_config_snapshot_id |
string |
|
Yes |
| draft |
AgentConfigDraftSummaryResponse |
|
No |
| publication_kind |
string,
Available values: "first", "update" |
Classifies the publication by whether the Agent had a publish-visible active snapshot before publishing: 'first' if none existed, otherwise 'update'. This is not a historical first-publish indicator. It does not depend on draft edits, Web App or API enablement, or the requesting user's access permissions.
Enum: "first", "update" |
Yes |
| result |
string |
|
Yes |
AgentPublishedReferenceResponse
| Name |
Type |
Description |
Required |
| app_icon |
string |
|
No |
| app_icon_background |
string |
|
No |
| app_icon_type |
string |
|
No |
| app_id |
string |
|
Yes |
| app_mode |
string |
|
Yes |
| app_name |
string |
|
Yes |
| app_updated_at |
integer |
|
No |
| node_ids |
[ string ] |
|
No |
| workflow_id |
string |
|
Yes |
| workflow_version |
string |
|
Yes |
AgentReferencingWorkflowResponse
| Name |
Type |
Description |
Required |
| app_icon |
string |
|
No |
| app_icon_background |
string |
|
No |
| app_icon_type |
string |
|
No |
| app_id |
string |
|
Yes |
| app_mode |
string |
|
Yes |
| app_name |
string |
|
Yes |
| app_updated_at |
integer |
|
No |
| node_ids |
[ string ] |
|
No |
| workflow_id |
string |
|
Yes |
| workflow_version |
string |
|
Yes |
AgentReferencingWorkflowsResponse
AgentRosterListResponse
| Name |
Type |
Description |
Required |
| data |
[ AgentRosterResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
AgentRosterResponse
| Name |
Type |
Description |
Required |
| active_config_is_published |
boolean |
|
No |
| active_config_snapshot |
AgentConfigSnapshotSummaryResponse |
|
No |
| active_config_snapshot_id |
string |
|
No |
| agent_kind |
AgentKind |
|
Yes |
| app_id |
string |
|
No |
| archived_at |
integer |
|
No |
| archived_by |
string |
|
No |
| backing_app_id |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| description |
string |
|
Yes |
| hidden_app_backed |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
AgentIconType |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| published_node_reference_count |
integer |
|
No |
| published_reference_count |
integer |
|
No |
| published_references |
[ AgentPublishedReferenceResponse ] |
|
No |
| reference_count |
integer |
|
No |
| role |
string |
|
No |
| scope |
AgentScope |
|
Yes |
| source |
AgentSource |
|
Yes |
| status |
AgentStatus |
|
Yes |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
| workflow_id |
string |
|
No |
| workflow_node_id |
string |
|
No |
AgentSandboxDownloadPayload
| Name |
Type |
Description |
Required |
| caller_id |
string |
Agent App caller ID |
Yes |
| caller_type |
string,
Available values: "build_draft", "conversation" |
Enum: "build_draft", "conversation" |
Yes |
| path |
string |
Binding path: relative paths start in Workspace; exact ~ and paths beginning with ~/ start in Home; ~user is an ordinary relative path from Workspace; absolute paths remain absolute; .. and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction |
Yes |
AgentSandboxProviderConfig
| Name |
Type |
Description |
Required |
| cpu |
integer |
|
No |
| env |
[ AgentEnvVariableConfig ] |
|
No |
| image |
string |
|
No |
| working_dir |
string |
|
No |
AgentScope
Visibility and lifecycle scope of an Agent record.
| Name |
Type |
Description |
Required |
| AgentScope |
string |
Visibility and lifecycle scope of an Agent record. |
|
AgentSecretRefConfig
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
| env_name |
string |
|
No |
| id |
string |
|
No |
| key |
string |
|
No |
| name |
string |
|
No |
| permission |
AgentPermissionConfig |
|
No |
| permission_status |
string |
|
No |
| provider |
string |
|
No |
| provider_credential_id |
string |
|
No |
| ref |
string |
|
No |
| type |
string |
|
No |
| value |
string |
|
No |
| variable |
string |
|
No |
AgentSensitiveWordAvoidanceFeatureConfig
AgentSimpleResultResponse
| Name |
Type |
Description |
Required |
| result |
string |
|
Yes |
AgentSkillBindingItemResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| display_name |
string |
|
Yes |
| file_count |
integer |
|
Yes |
| icon |
string |
|
Yes |
| id |
string |
|
Yes |
| latest_published_at |
integer |
|
No |
| latest_published_version_id |
string |
|
No |
| name |
string |
|
Yes |
| priority |
integer |
|
Yes |
| status |
string |
|
Yes |
| tags |
[ string ] |
|
No |
| updated_at |
integer |
|
Yes |
AgentSkillBindingsPayload
| Name |
Type |
Description |
Required |
| skill_ids |
[ string ] |
Ordered Skill IDs bound to the Agent. |
No |
AgentSkillBindingsResponse
AgentSoulAppFeaturesConfig
AgentSoulConfig
AgentSoulDifyToolConfig
One Dify tool configured on Agent Soul.
The API backend prepares this persisted product shape into
either DifyPluginToolConfig or DifyCoreToolConfig before sending a
run request to Agent backend. plugin providers keep the direct
dify.plugin.tools transport; builtin / api / workflow /
mcp providers are prepared for dify.core.tools. provider_id
keeps compatibility with existing Agent tool config payloads; new callers
should send plugin_id + provider when available.
| Name |
Type |
Description |
Required |
| credential_ref |
AgentSoulDifyToolCredentialRef |
|
No |
| credential_type |
string,
Available values: "api-key", "oauth2", "unauthorized",
Default: api-key |
Enum: "api-key", "oauth2", "unauthorized" |
No |
| description |
string |
|
No |
| enabled |
boolean,
Default: true |
|
No |
| name |
string |
|
No |
| plugin_id |
string |
|
No |
| provider |
string |
|
No |
| provider_id |
string |
|
No |
| provider_type |
ToolProviderType |
|
Yes |
| runtime_parameters |
object |
|
No |
| tool_name |
string |
|
No |
AgentSoulDifyToolCredentialRef
Reference to a stored Dify Plugin Tool credential.
Secret values are resolved only at runtime. The legacy credential_id
field is accepted by :class:AgentSoulDifyToolConfig and normalized here so
old Agent tool payloads can be read while new payloads stay explicit.
| Name |
Type |
Description |
Required |
| id |
string |
|
No |
| provider |
string |
|
No |
| type |
string,
Available values: "provider", "tool",
Default: tool |
Enum: "provider", "tool" |
No |
AgentSoulEnvConfig
AgentSoulHumanConfig
AgentSoulKnowledgeConfig
Top-level Agent v2 knowledge config.
Agent v2 models knowledge as explicit sets instead of one flat
datasets / query_mode / query_config block. An empty sets
list means no knowledge layer should be emitted at runtime, while set-name
uniqueness stays case-insensitive because runtime selection addresses sets
by name.
AgentSoulLockedError
Agent Soul is locked for this workflow node.
| Name |
Type |
Description |
Required |
| AgentSoulLockedError |
|
Agent Soul is locked for this workflow node. |
|
AgentSoulMemoryConfig
AgentSoulModelConfig
Stable model selection for Agent runtime without storing secret values.
AgentSoulModelCredentialRef
Reference to model credentials resolved only at runtime.
| Name |
Type |
Description |
Required |
| id |
string |
|
No |
| provider |
string |
|
No |
| type |
string |
|
Yes |
AgentSoulModelSettings
Model parameters for the Agent Soul model.
Model plugins can declare arbitrary parameters via parameter_rules
(e.g. Qwen/Tongyi's enable_thinking) beyond the common OpenAI-style
fields typed below, so extra keys must round-trip through persistence
rather than being dropped.
| Name |
Type |
Description |
Required |
| frequency_penalty |
number |
|
No |
| max_tokens |
integer |
|
No |
| presence_penalty |
number |
|
No |
| response_format |
AgentModelResponseFormatConfig |
|
No |
| stop |
[ string ] |
|
No |
| temperature |
number |
|
No |
| top_p |
number |
|
No |
AgentSoulPromptConfig
| Name |
Type |
Description |
Required |
| system_prompt |
string |
|
No |
AgentSoulSandboxConfig
AgentSoulToolsConfig
AgentSource
Origin that created or imported the Agent.
| Name |
Type |
Description |
Required |
| AgentSource |
string |
Origin that created or imported the Agent. |
|
AgentStatisticChartsResponse
AgentStatisticSummaryEnvelopeResponse
AgentStatisticSummaryResponse
| Name |
Type |
Description |
Required |
| average_response_time |
number |
|
Yes |
| average_session_interactions |
number |
|
Yes |
| currency |
string |
|
Yes |
| tokens_per_second |
number |
|
Yes |
| total_conversations |
integer |
|
Yes |
| total_end_users |
integer |
|
Yes |
| total_messages |
integer |
|
Yes |
| total_price |
string |
|
Yes |
| total_tokens |
integer |
|
Yes |
| user_satisfaction_rate |
number |
|
Yes |
AgentStatisticsQuery
| Name |
Type |
Description |
Required |
| end |
string |
End date (YYYY-MM-DD HH:MM) |
No |
| source |
string |
Filter by a structured webapp:<app_id> or workflow:<app_id> source ID. Legacy invoke sources and exact workflow version/node source IDs remain supported. |
No |
| start |
string |
Start date (YYYY-MM-DD HH:MM) |
No |
AgentStatus
Soft lifecycle state for Agent records.
| Name |
Type |
Description |
Required |
| AgentStatus |
string |
Soft lifecycle state for Agent records. |
|
AgentStrategyEntity
AgentStrategyIdentity
Inherits from ToolIdentity, without any additional fields.
| Name |
Type |
Description |
Required |
| author |
string |
The author of the tool |
Yes |
| icon |
string |
|
No |
| label |
I18nObject |
The label of the tool |
Yes |
| name |
string |
The name of the tool |
Yes |
| provider |
string |
The provider of the tool |
Yes |
AgentStrategyParameter
AgentStrategyParameterType
Keep all the types from PluginParameterType
| Name |
Type |
Description |
Required |
| AgentStrategyParameterType |
string |
Keep all the types from PluginParameterType |
|
AgentStrategyProviderEntity
AgentStrategyProviderIdentity
Inherits from ToolProviderIdentity, without any additional fields.
| Name |
Type |
Description |
Required |
| author |
string |
The author of the tool |
Yes |
| description |
I18nObject |
The description of the tool |
Yes |
| icon |
string |
The icon of the tool |
Yes |
| icon_dark |
string |
The dark icon of the tool |
No |
| label |
I18nObject |
The label of the tool |
Yes |
| name |
string |
The name of the tool |
Yes |
| tags |
[ ToolLabelEnum ] |
The tags of the tool |
No |
AgentSuggestedQuestionsAfterAnswerFeatureConfig
AgentSuggestedQuestionsAfterAnswerModelConfig
Legacy Chat App model config used only for follow-up question generation.
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
No |
| mode |
string |
|
No |
| name |
string |
|
Yes |
| provider |
string |
|
Yes |
AgentTextToSpeechFeatureConfig
| Name |
Type |
Description |
Required |
| autoPlay |
string,
Available values: "disabled", "enabled" |
|
No |
| enabled |
boolean |
|
No |
| language |
string |
|
No |
| voice |
string |
|
No |
AgentThought
| Name |
Type |
Description |
Required |
| answer |
string |
|
No |
| chain_id |
string |
|
No |
| created_at |
integer |
|
No |
| files |
[ string ] |
|
Yes |
| id |
string |
|
Yes |
| message_id |
string |
|
Yes |
| observation |
string |
|
No |
| position |
integer |
|
Yes |
| thought |
string |
|
No |
| tool |
string |
|
No |
| tool_input |
string |
|
No |
| tool_labels |
AnyJSONValue |
Labels for tools used. |
Yes |
AgentTokenUsageStatisticResponse
| Name |
Type |
Description |
Required |
| currency |
string |
|
Yes |
| date |
string |
|
Yes |
| token_count |
integer |
|
Yes |
| total_price |
string |
|
Yes |
AgentTokensPerSecondStatisticResponse
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| tps |
number |
|
Yes |
AgentToolCallResponse
| Name |
Type |
Description |
Required |
| error |
string |
|
No |
| status |
string |
|
Yes |
| time_cost |
number
integer |
|
Yes |
| tool_icon |
string
object |
Icon URL or emoji icon |
No |
| tool_input |
object |
|
Yes |
| tool_label |
string
object |
Tool name or its i18n labels keyed by locale |
Yes |
| tool_name |
string |
|
Yes |
| tool_output |
object |
|
Yes |
| tool_parameters |
object |
|
Yes |
AgentUserSatisfactionRateStatisticResponse
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| rate |
number |
|
Yes |
AgentVersionConflictError
Agent config version changed. Please reload and try again.
| Name |
Type |
Description |
Required |
| AgentVersionConflictError |
|
Agent config version changed. Please reload and try again. |
|
AgentVersionNotFoundError
Agent config version not found.
| Name |
Type |
Description |
Required |
| AgentVersionNotFoundError |
|
Agent config version not found. |
|
AllowedExtensionsResponse
| Name |
Type |
Description |
Required |
| allowed_extensions |
[ string ] |
|
Yes |
AlreadyActivateError
Auth Token is invalid or account already activated, please check again.
| Name |
Type |
Description |
Required |
| AlreadyActivateError |
|
Auth Token is invalid or account already activated, please check again. |
|
Annotation
| Name |
Type |
Description |
Required |
| answer |
string |
|
No |
| created_at |
integer |
|
No |
| hit_count |
integer |
|
No |
| id |
string (uuid) |
|
Yes |
| question |
string |
|
No |
AnnotationBatchImportResponse
| Name |
Type |
Description |
Required |
| error_msg |
string |
|
No |
| job_id |
string |
|
No |
| job_status |
string |
|
No |
| record_count |
integer |
|
No |
AnnotationCountResponse
| Name |
Type |
Description |
Required |
| count |
integer |
Number of annotations |
Yes |
AnnotationExportList
| Name |
Type |
Description |
Required |
| data |
[ Annotation ] |
|
Yes |
AnnotationFilePayload
| Name |
Type |
Description |
Required |
| message_id |
string |
Message ID |
Yes |
AnnotationHitHistory
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| match |
string |
|
No |
| question |
string |
|
No |
| response |
string |
|
No |
| score |
number |
|
No |
| source |
string |
|
No |
AnnotationHitHistoryList
| Name |
Type |
Description |
Required |
| data |
[ AnnotationHitHistory ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
AnnotationHitHistoryListQuery
| Name |
Type |
Description |
Required |
| limit |
integer,
Default: 20 |
Page size |
No |
| page |
integer,
Default: 1 |
Page number |
No |
AnnotationJobStatusDetailResponse
| Name |
Type |
Description |
Required |
| error_msg |
string |
|
No |
| job_id |
string (uuid) |
|
Yes |
| job_status |
string |
|
Yes |
AnnotationJobStatusResponse
| Name |
Type |
Description |
Required |
| job_id |
string (uuid) |
|
Yes |
| job_status |
string |
|
Yes |
AnnotationList
| Name |
Type |
Description |
Required |
| data |
[ Annotation ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
AnnotationListQuery
| Name |
Type |
Description |
Required |
| keyword |
string |
Search keyword |
No |
| limit |
integer,
Default: 20 |
Page size |
No |
| page |
integer,
Default: 1 |
Page number |
No |
AnnotationReplyPayload
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
Embedding model name |
Yes |
| embedding_provider_name |
string |
Embedding provider name |
Yes |
| score_threshold |
number |
Score threshold for annotation matching |
Yes |
AnnotationReplyStatusQuery
| Name |
Type |
Description |
Required |
| action |
string,
Available values: "disable", "enable" |
Enum: "disable", "enable" |
Yes |
AnnotationSettingEmbeddingModelResponse
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
|
No |
| embedding_provider_name |
string |
|
No |
AnnotationSettingResponse
AnnotationSettingUpdatePayload
| Name |
Type |
Description |
Required |
| score_threshold |
number |
Score threshold |
Yes |
AnyJSONValue
| Name |
Type |
Description |
Required |
| AnyJSONValue |
|
|
|
ApiBaseUrlResponse
| Name |
Type |
Description |
Required |
| api_base_url |
string |
|
Yes |
ApiKeyAuthBindingPayload
ApiKeyAuthConfigPayload
| Name |
Type |
Description |
Required |
| api_key |
string |
|
Yes |
ApiKeyAuthCredentialsPayload
ApiKeyAuthDataSourceItem
| Name |
Type |
Description |
Required |
| category |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| disabled |
boolean |
|
Yes |
| id |
string |
|
Yes |
| provider |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
ApiKeyAuthDataSourceListResponse
ApiKeyItem
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| dataset_ids |
[ string ],
Default: |
|
No |
| id |
string |
|
Yes |
| last_used_at |
integer |
|
No |
| token |
string |
|
Yes |
| type |
string |
|
Yes |
ApiKeyList
| Name |
Type |
Description |
Required |
| data |
[ ApiKeyItem ] |
|
Yes |
ApiProviderDetailResponse
| Name |
Type |
Description |
Required |
| credentials |
object |
|
No |
| custom_disclaimer |
string |
|
No |
| description |
string |
|
No |
| icon |
ToolEmojiIcon |
|
Yes |
| labels |
[ string ] |
|
No |
| privacy_policy |
string |
|
No |
| schema |
string |
|
Yes |
| schema_type |
ApiProviderSchemaType |
|
Yes |
| tools |
[ ApiToolBundle ] |
|
Yes |
ApiProviderRemoteSchemaResponse
| Name |
Type |
Description |
Required |
| schema |
string |
|
Yes |
ApiProviderSchemaType
Enum class for api provider schema type.
| Name |
Type |
Description |
Required |
| ApiProviderSchemaType |
string |
Enum class for api provider schema type. |
|
ApiSchemaParseResponse
ApiToolBundle
This class is used to store the schema information of an api based tool.
such as the url, the method, the parameters, etc.
| Name |
Type |
Description |
Required |
| author |
string |
|
Yes |
| icon |
string |
|
No |
| method |
string |
|
Yes |
| openapi |
object |
|
Yes |
| operation_id |
string |
|
No |
| output_schema |
object |
|
No |
| parameters |
[ ToolParameter ] |
|
No |
| server_url |
string |
|
Yes |
| summary |
string |
|
No |
ApiToolPreviewResponse
| Name |
Type |
Description |
Required |
| ApiToolPreviewResponse |
|
|
|
ApiToolPreviewResult
| Name |
Type |
Description |
Required |
| error |
string |
|
No |
| result |
string |
|
No |
ApiToolProviderAddPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| custom_disclaimer |
string |
|
No |
| icon |
ToolEmojiIcon |
|
Yes |
| labels |
[ string ] |
|
No |
| privacy_policy |
string |
|
No |
| provider |
string |
|
Yes |
| schema |
string |
|
Yes |
| schema_type |
ApiProviderSchemaType |
|
Yes |
ApiToolProviderDeletePayload
| Name |
Type |
Description |
Required |
| provider |
string |
|
Yes |
ApiToolProviderUpdatePayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| custom_disclaimer |
string |
|
No |
| icon |
ToolEmojiIcon |
|
Yes |
| labels |
[ string ] |
|
No |
| original_provider |
string |
|
Yes |
| privacy_policy |
string |
|
No |
| provider |
string |
|
Yes |
| schema |
string |
|
Yes |
| schema_type |
ApiProviderSchemaType |
|
Yes |
ApiToolSchemaPayload
| Name |
Type |
Description |
Required |
| schema |
string |
|
Yes |
ApiToolTestPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| parameters |
object |
|
Yes |
| provider_name |
string |
|
No |
| schema |
string |
|
Yes |
| schema_type |
ApiProviderSchemaType |
|
Yes |
| tool_name |
string |
|
Yes |
AppAccessMatrix
AppAgentModePayload
AppAgentModeResponse
AppAgentPromptPayload
| Name |
Type |
Description |
Required |
| first_prompt |
string |
|
No |
| next_iteration |
string |
|
No |
AppAgentPromptResponse
| Name |
Type |
Description |
Required |
| first_prompt |
string |
|
No |
| next_iteration |
string |
|
No |
AppAgentToolPayload
AppAnnotationReplyDisabledResponse
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
Yes |
AppAnnotationReplyEnabledResponse
| Name |
Type |
Description |
Required |
| embedding_model |
AppEmbeddingModelResponse |
|
Yes |
| enabled |
boolean |
|
Yes |
| id |
string |
|
Yes |
| score_threshold |
number |
|
Yes |
AppApiStatusPayload
| Name |
Type |
Description |
Required |
| enable_api |
boolean |
Enable or disable API |
Yes |
AppChatPromptConfigResponse
AppChatPromptMessageResponse
| Name |
Type |
Description |
Required |
| role |
string |
|
Yes |
| text |
string |
|
Yes |
AppChatPromptPayload
AppCheckboxFormResponse
AppCheckboxInputPayload
AppCompletionPromptConfigResponse
AppCompletionPromptPayload
AppCompletionPromptTextPayload
| Name |
Type |
Description |
Required |
| text |
string |
|
Yes |
AppCompletionPromptTextResponse
| Name |
Type |
Description |
Required |
| text |
string |
|
Yes |
AppConfigJsonValue
| Name |
Type |
Description |
Required |
| AppConfigJsonValue |
string
integer
number
boolean
[ AppConfigJsonValue ]
object |
|
|
AppConversationHistoriesRoleResponse
| Name |
Type |
Description |
Required |
| assistant_prefix |
string |
|
Yes |
| user_prefix |
string |
|
Yes |
AppConversationRolesPayload
| Name |
Type |
Description |
Required |
| assistant_prefix |
string |
|
Yes |
| user_prefix |
string |
|
Yes |
AppDatasetCollectionPayload
AppDatasetConfigPayload
AppDatasetConfigsResponse
AppDatasetItemResponse
AppDatasetListResponse
AppDatasetReferenceResponse
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| id |
string |
|
No |
AppDatasetSelectionPayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| id |
string |
|
No |
AppDatasetToolPayload
AppDetail
| Name |
Type |
Description |
Required |
| access_mode |
WebAppAccessMode |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| description |
string |
|
Yes |
| enable_api |
boolean |
|
Yes |
| enable_site |
boolean |
|
Yes |
| icon |
string |
|
Yes |
| icon_background |
string |
|
Yes |
| id |
string |
|
Yes |
| maintainer |
string |
|
Yes |
| mode |
AppMode |
|
Yes |
| model_config |
AppModelConfigResponse |
|
Yes |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
Yes |
| tags |
[ Tag ] |
|
Yes |
| tracing |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
| workflow |
WorkflowPartial |
|
Yes |
AppDetailSiteResponse
| Name |
Type |
Description |
Required |
| access_token |
string |
|
Yes |
| app_base_url |
string |
|
Yes |
| chat_color_theme |
string |
|
Yes |
| chat_color_theme_inverted |
boolean |
|
Yes |
| code |
string |
|
Yes |
| copyright |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| custom_disclaimer |
string |
|
Yes |
| customize_domain |
string |
|
Yes |
| customize_token_strategy |
CustomizeTokenStrategy |
|
Yes |
| default_language |
string |
|
Yes |
| description |
string |
|
Yes |
| icon |
string |
|
Yes |
| icon_background |
string |
|
Yes |
| icon_type |
IconType |
|
Yes |
| icon_url |
string |
|
Yes |
| input_placeholder |
string |
|
Yes |
| privacy_policy |
string |
|
Yes |
| prompt_public |
boolean |
|
Yes |
| show_workflow_steps |
boolean |
|
Yes |
| title |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
AppDetailWithSite
| Name |
Type |
Description |
Required |
| access_mode |
WebAppAccessMode |
|
Yes |
| api_base_url |
string |
|
Yes |
| app_id |
string |
|
Yes |
| bound_agent_id |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| deleted_tools |
[ DeletedTool ] |
|
Yes |
| description |
string |
|
Yes |
| enable_api |
boolean |
|
Yes |
| enable_site |
boolean |
|
Yes |
| icon |
string |
|
Yes |
| icon_background |
string |
|
Yes |
| icon_type |
IconType |
|
Yes |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| maintainer |
string |
|
Yes |
| max_active_requests |
integer |
|
Yes |
| mode |
AppMode |
|
Yes |
| model_config |
AppModelConfigResponse |
|
Yes |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
Yes |
| site |
AppDetailSiteResponse |
|
Yes |
| tags |
[ Tag ] |
|
Yes |
| tracing |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
| workflow |
WorkflowPartial |
|
Yes |
AppDisabledExternalDataToolResponse
| Name |
Type |
Description |
Required |
| config |
object |
|
No |
| enabled |
boolean |
|
Yes |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| label |
string |
|
No |
| type |
string |
|
No |
| variable |
string |
|
No |
AppDslVersionResponse
| Name |
Type |
Description |
Required |
| app_dsl_version |
string |
|
Yes |
AppEmbeddingModelResponse
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
|
Yes |
| embedding_provider_name |
string |
|
Yes |
AppEmptyDatasetCollectionPayload
| Name |
Type |
Description |
Required |
AppEnabledConfigResponse
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
Yes |
AppEnabledExternalDataToolResponse
| Name |
Type |
Description |
Required |
| config |
object |
|
Yes |
| enabled |
boolean |
|
Yes |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| label |
string |
|
No |
| type |
string |
|
Yes |
| variable |
string |
|
Yes |
AppExportQuery
| Name |
Type |
Description |
Required |
| format |
string,
Available values: "ifpkg", "yaml" |
Export format; defaults to ifpkg for all Apps |
No |
| include_secret |
boolean |
Include secrets in export |
No |
| version_id |
string |
Published Agent version ID to export; requires a paid plan on Cloud. If omitted, exports the shared draft, falling back to the active snapshot when no draft exists. |
No |
| workflow_id |
string |
Specific workflow ID to export |
No |
AppExportResponse
| Name |
Type |
Description |
Required |
| data |
string |
|
Yes |
AppExternalDataInputPayload
AppExternalDataToolFormResponse
AppExternalDataToolPayload
| Name |
Type |
Description |
Required |
| config |
object |
|
No |
| enabled |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| label |
string |
|
No |
| type |
string |
|
No |
| variable |
string |
|
No |
AppFeaturePayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
AppFileFormResponse
AppFileListFormResponse
AppFilePreviewPayload
| Name |
Type |
Description |
Required |
| file_type_list |
[ string ] |
|
No |
| mode |
string |
|
No |
AppFileTypeUploadPayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| number_limits |
integer |
|
No |
| transfer_methods |
[ FileTransferMethod ] |
|
No |
AppFileUploadPayload
AppFileUploadResponse
AppIconPayload
| Name |
Type |
Description |
Required |
| icon |
string |
Icon data |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
AppImageConfigPayload
| Name |
Type |
Description |
Required |
| detail |
string,
Available values: "high", "low" |
|
No |
| number_limits |
integer |
|
No |
| transfer_methods |
[ FileTransferMethod ] |
|
No |
AppImageUploadPayload
| Name |
Type |
Description |
Required |
| detail |
string,
Available values: "high", "low" |
|
No |
| enabled |
boolean |
|
No |
| number_limits |
integer |
|
No |
| transfer_methods |
[ FileTransferMethod ] |
|
No |
AppImageUploadResponse
| Name |
Type |
Description |
Required |
| detail |
string,
Available values: "high", "low" |
|
No |
| enabled |
boolean |
|
No |
| number_limits |
integer |
|
No |
| transfer_methods |
[ FileTransferMethod ] |
|
No |
AppImportPayload
| Name |
Type |
Description |
Required |
| app_id |
string |
|
No |
| description |
string |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| mode |
string |
Import mode |
Yes |
| name |
string |
|
No |
| package_url |
string |
|
No |
| template_id |
string |
|
No |
| version_id |
string |
|
No |
| yaml_content |
string |
|
No |
| yaml_url |
string |
|
No |
AppImportResponse
| Name |
Type |
Description |
Required |
| app_id |
string |
|
No |
| app_mode |
AppMode |
|
No |
| current_dsl_version |
string |
|
Yes |
| error |
string |
|
No |
| id |
string |
|
Yes |
| imported_dsl_version |
string |
|
No |
| status |
ImportStatus |
|
Yes |
| warnings |
[ DslImportWarning ] |
|
No |
AppInputFieldPayload
| Name |
Type |
Description |
Required |
| config |
object |
|
No |
| default |
AppConfigJsonValue |
|
No |
| description |
string |
|
No |
| enabled |
boolean |
|
No |
| hide |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| json_schema |
string
object |
|
No |
| label |
string |
|
Yes |
| max_length |
integer |
|
No |
| options |
[ string ] |
|
No |
| required |
boolean |
|
No |
| type |
string |
|
No |
| variable |
string |
|
Yes |
AppJsonObjectFormResponse
AppKeywordSettingResponse
| Name |
Type |
Description |
Required |
| keyword_weight |
number |
|
Yes |
AppKeywordWeightPayload
| Name |
Type |
Description |
Required |
| keyword_weight |
number |
|
Yes |
AppLegacyCurrentDatetimeToolPayload
AppLegacyCurrentDatetimeToolResponse
| Name |
Type |
Description |
Required |
| current_datetime |
object |
|
Yes |
AppLegacyDatasetSelectionPayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| id |
string |
|
No |
AppLegacyDatasetToolPayload
AppLegacyDatasetToolResponse
AppLegacyGoogleSearchToolPayload
AppLegacyGoogleSearchToolResponse
| Name |
Type |
Description |
Required |
| google_search |
object |
|
Yes |
AppLegacySensitiveWordConfigPayload
| Name |
Type |
Description |
Required |
| canned_response |
string |
|
Yes |
| enabled |
boolean |
|
Yes |
| words |
[ string ] |
|
Yes |
AppLegacySensitiveWordToolPayload
AppLegacySensitiveWordToolResponse
| Name |
Type |
Description |
Required |
| canned_response |
string |
|
Yes |
| enabled |
boolean |
|
Yes |
| words |
[ string ] |
|
Yes |
AppLegacySensitiveWordToolResponseItem
AppLegacyWebReaderToolPayload
AppLegacyWebReaderToolResponse
| Name |
Type |
Description |
Required |
| web_reader |
object |
|
Yes |
AppLegacyWikipediaToolPayload
AppLegacyWikipediaToolResponse
| Name |
Type |
Description |
Required |
| wikipedia |
object |
|
Yes |
AppListQuery
| Name |
Type |
Description |
Required |
| creator_ids |
[ string ] |
Filter by creator account IDs |
No |
| is_created_by_me |
boolean |
Filter by creator |
No |
| limit |
integer,
Default: 20 |
Page size (1-100) |
No |
| mode |
string,
Available values: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow",
Default: all |
App mode filter
Enum: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow" |
No |
| name |
string |
Filter by app name |
No |
| openapi_visible |
boolean |
Only return apps with API access enabled |
No |
| page |
integer,
Default: 1 |
Page number (1-99999) |
No |
| sort_by |
string,
Available values: "earliest_created", "last_modified", "recently_created",
Default: last_modified |
Sort apps by last modified, recently created, or earliest created
Enum: "earliest_created", "last_modified", "recently_created" |
No |
| tag_ids |
[ string ] |
Filter by tag IDs |
No |
AppMCPServerResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| description |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| parameters |
object
[ object ]
string |
|
Yes |
| server_code |
string |
|
Yes |
| status |
AppMCPServerStatus |
|
Yes |
| updated_at |
integer |
|
No |
AppMCPServerStatus
Publication state of a Dify app exposed as an MCP server; only ACTIVE servers accept MCP calls.
| Name |
Type |
Description |
Required |
| AppMCPServerStatus |
string |
Publication state of a Dify app exposed as an MCP server; only ACTIVE servers accept MCP calls. |
|
AppMessageFeedbackPayload
| Name |
Type |
Description |
Required |
| content |
string |
Optional text feedback providing additional detail. |
No |
| message_id |
string |
Message ID |
Yes |
| rating |
string,
Available values: "dislike", "like" |
Feedback rating. Set to null to revoke previously submitted feedback. |
No |
AppMetadataConditionPayload
| Name |
Type |
Description |
Required |
| comparison_operator |
string,
Available values: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Enum: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Yes |
| id |
string |
|
No |
| metadata_id |
string |
|
No |
| name |
string |
|
Yes |
| value |
string
[ string ]
integer
number |
|
No |
AppMetadataConditionResponse
| Name |
Type |
Description |
Required |
| comparison_operator |
string,
Available values: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Enum: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Yes |
| id |
string |
|
No |
| metadata_id |
string |
|
No |
| name |
string |
|
Yes |
| value |
string
[ string ]
integer
number |
|
No |
AppMetadataFilteringConditionsResponse
AppMetadataFilteringPayload
AppMetadataModelPayload
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
No |
| mode |
LLMMode
string |
|
No |
| name |
string |
|
No |
| provider |
string |
|
No |
AppMode
| Name |
Type |
Description |
Required |
| AppMode |
string |
|
|
AppModelConfigPayload
Write transport; app-mode validators own defaults and feature-specific rules.
AppModelConfigResponse
AppModelSelectionPayload
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
Yes |
| mode |
string |
|
No |
| name |
string |
|
Yes |
| provider |
string |
|
Yes |
AppModelSelectionResponse
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
No |
| mode |
LLMMode
string |
|
No |
| name |
string |
|
No |
| provider |
string |
|
No |
AppModerationConfigPayload
AppModerationContentPayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| preset_response |
string |
|
No |
AppModerationPayload
AppMoreLikeThisDisabledError
The 'More like this' feature is disabled. Please refresh your page.
| Name |
Type |
Description |
Required |
| AppMoreLikeThisDisabledError |
|
The 'More like this' feature is disabled. Please refresh your page. |
|
AppNamePayload
| Name |
Type |
Description |
Required |
| name |
string |
Name to check |
Yes |
AppNotFoundError
App not found.
| Name |
Type |
Description |
Required |
| AppNotFoundError |
|
App not found. |
|
AppNumberFormResponse
AppNumberInputPayload
AppOwnerUnavailableError
The app preview owner is unavailable.
| Name |
Type |
Description |
Required |
| AppOwnerUnavailableError |
|
The app preview owner is unavailable. |
|
| Name |
Type |
Description |
Required |
| data |
[ AppPartial ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
AppParagraphFormResponse
AppParagraphInputPayload
AppPartial
| Name |
Type |
Description |
Required |
| access_mode |
WebAppAccessMode |
|
No |
| app_id |
string |
|
No |
| author_name |
string |
|
No |
| bound_agent_id |
string |
|
No |
| create_user_name |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| description |
string |
|
No |
| has_draft_trigger |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
IconType |
|
No |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| is_starred |
boolean |
|
No |
| maintainer |
string |
|
No |
| max_active_requests |
integer |
|
No |
| mode |
AppMode |
|
Yes |
| model_config |
ModelConfigPartial |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| tags |
[ Tag ] |
|
No |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
| use_icon_as_answer_icon |
boolean |
|
No |
| workflow |
WorkflowPartial |
|
No |
AppPromptMessagePayload
| Name |
Type |
Description |
Required |
| role |
string |
|
Yes |
| text |
string |
|
Yes |
AppProviderAgentToolPayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
| enabled |
boolean |
|
No |
| isDeleted |
boolean |
|
No |
| notAuthor |
boolean |
|
No |
| plugin_unique_identifier |
string |
|
No |
| provider_id |
string |
|
Yes |
| provider_name |
string |
|
No |
| provider_type |
ToolProviderType |
|
Yes |
| tool_label |
string |
|
No |
| tool_name |
string |
|
Yes |
| tool_parameters |
object |
|
Yes |
AppProviderAgentToolResponse
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
| enabled |
boolean |
|
No |
| isDeleted |
boolean |
|
No |
| notAuthor |
boolean |
|
No |
| plugin_unique_identifier |
string |
|
No |
| provider_id |
string |
|
Yes |
| provider_name |
string |
|
No |
| provider_type |
ToolProviderType |
|
Yes |
| tool_label |
string |
|
No |
| tool_name |
string |
|
Yes |
| tool_parameters |
object |
|
Yes |
AppRerankingModelPayload
| Name |
Type |
Description |
Required |
| reranking_model_name |
string |
|
No |
| reranking_provider_name |
string |
|
No |
AppRerankingModelResponse
| Name |
Type |
Description |
Required |
| reranking_model_name |
string |
|
No |
| reranking_provider_name |
string |
|
No |
AppRetrievalWeightsPayload
| Name |
Type |
Description |
Required |
| keyword_setting |
AppKeywordWeightPayload |
|
Yes |
| vector_setting |
AppVectorWeightPayload |
|
Yes |
| weight_type |
string,
Available values: "customized", "keyword_first", "semantic_first" |
Enum: "customized", "keyword_first", "semantic_first" |
No |
AppSelectFieldPayload
| Name |
Type |
Description |
Required |
| config |
object |
|
No |
| default |
AppConfigJsonValue |
|
No |
| description |
string |
|
No |
| enabled |
boolean |
|
No |
| hide |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| json_schema |
string
object |
|
No |
| label |
string |
|
Yes |
| max_length |
integer |
|
No |
| options |
[ string ] |
|
No |
| required |
boolean |
|
No |
| type |
string |
|
No |
| variable |
string |
|
Yes |
AppSelectFormResponse
AppSelectInputPayload
AppSelectorScope
| Name |
Type |
Description |
Required |
| AppSelectorScope |
string |
|
|
AppSensitiveWordAvoidanceResponse
| Name |
Type |
Description |
Required |
| config |
object |
|
No |
| configs |
[ JsonValue ] |
|
No |
| enabled |
boolean |
|
Yes |
| type |
string |
|
No |
AppSiteResponse
| Name |
Type |
Description |
Required |
| app_id |
string |
|
Yes |
| code |
string |
|
No |
| copyright |
string |
|
No |
| custom_disclaimer |
string |
|
No |
| customize_domain |
string |
|
No |
| customize_token_strategy |
string |
|
Yes |
| default_language |
string |
|
Yes |
| description |
string |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| input_placeholder |
string |
|
No |
| privacy_policy |
string |
|
No |
| prompt_public |
boolean |
|
Yes |
| show_workflow_steps |
boolean |
|
Yes |
| title |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
AppSiteStatusPayload
| Name |
Type |
Description |
Required |
| enable_site |
boolean |
Enable or disable site |
Yes |
AppSiteUnavailableError
The app preview site is unavailable.
| Name |
Type |
Description |
Required |
| AppSiteUnavailableError |
|
The app preview site is unavailable. |
|
AppSiteUpdatePayload
| Name |
Type |
Description |
Required |
| chat_color_theme |
string |
|
No |
| chat_color_theme_inverted |
boolean |
|
No |
| copyright |
string |
|
No |
| custom_disclaimer |
string |
|
No |
| customize_domain |
string |
|
No |
| customize_token_strategy |
string,
Available values: "allow", "must", "not_allow" |
|
No |
| default_language |
string |
|
No |
| description |
string |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| input_placeholder |
string |
|
No |
| privacy_policy |
string |
|
No |
| prompt_public |
boolean |
|
No |
| show_workflow_steps |
boolean |
|
No |
| title |
string |
|
No |
| use_icon_as_answer_icon |
boolean |
|
No |
AppSuggestedQuestionsAfterAnswerDisabledError
Function Suggested questions after answer disabled.
| Name |
Type |
Description |
Required |
| AppSuggestedQuestionsAfterAnswerDisabledError |
|
Function Suggested questions after answer disabled. |
|
AppSuggestedQuestionsAfterAnswerResponse
AppSuggestedQuestionsModelPayload
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
No |
| mode |
LLMMode
string |
|
No |
| name |
string |
|
Yes |
| provider |
string |
|
Yes |
AppSuggestedQuestionsPayload
AppTextInputFormResponse
AppTextInputPayload
AppTextToSpeechPayload
| Name |
Type |
Description |
Required |
| autoPlay |
string,
Available values: "disabled", "enabled" |
Enum: "disabled", "enabled" |
No |
| enabled |
boolean |
|
No |
| language |
string |
|
No |
| voice |
string |
|
No |
AppTextToSpeechResponse
| Name |
Type |
Description |
Required |
| autoPlay |
string,
Available values: "disabled", "enabled" |
Enum: "disabled", "enabled" |
No |
| enabled |
boolean |
|
Yes |
| language |
string |
|
No |
| voice |
string |
|
No |
AppTracePayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
Enable or disable tracing |
Yes |
| tracing_provider |
string |
Tracing provider |
No |
AppTraceResponse
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| tracing_provider |
string |
|
No |
AppUnavailableError
App unavailable, please check your app configurations.
| Name |
Type |
Description |
Required |
| AppUnavailableError |
|
App unavailable, please check your app configurations. |
|
AppUserInputFormConfigResponse
| Name |
Type |
Description |
Required |
| allowed_file_extensions |
[ string ] |
|
No |
| allowed_file_types |
[ FileType ] |
|
No |
| allowed_file_upload_methods |
[ FileTransferMethod ] |
|
No |
| config |
object |
|
No |
| default |
JsonValue |
|
No |
| description |
string |
|
No |
| enabled |
boolean |
|
No |
| hide |
boolean |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| json_schema |
string
object |
|
No |
| label |
string |
|
Yes |
| max_length |
integer |
|
No |
| options |
[ string ] |
|
No |
| required |
boolean |
|
No |
| type |
string |
|
No |
| variable |
string |
|
Yes |
AppUserInputFormPayload
AppVariableConfig
| Name |
Type |
Description |
Required |
| default |
|
|
No |
| name |
string |
|
Yes |
| required |
boolean |
|
No |
| type |
string |
|
Yes |
AppVectorSettingResponse
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
|
Yes |
| embedding_provider_name |
string |
|
Yes |
| vector_weight |
number |
|
Yes |
AppVectorWeightPayload
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
|
Yes |
| embedding_provider_name |
string |
|
Yes |
| vector_weight |
number |
|
Yes |
AppWeightsResponse
| Name |
Type |
Description |
Required |
| keyword_setting |
AppKeywordSettingResponse |
|
Yes |
| vector_setting |
AppVectorSettingResponse |
|
Yes |
| weight_type |
string,
Available values: "customized", "keyword_first", "semantic_first" |
Enum: "customized", "keyword_first", "semantic_first" |
No |
ArchivedDocumentImmutableError
The archived document is not editable.
| Name |
Type |
Description |
Required |
| ArchivedDocumentImmutableError |
|
The archived document is not editable. |
|
AudioBinaryResponse
| Name |
Type |
Description |
Required |
| AudioBinaryResponse |
string |
|
|
AudioTooLargeError
Audio size exceeded. {message}
| Name |
Type |
Description |
Required |
| AudioTooLargeError |
|
Audio size exceeded. {message} |
|
AudioTranscriptResponse
| Name |
Type |
Description |
Required |
| text |
string |
Transcribed text from audio |
Yes |
AuthenticationFailedError
Invalid email or password.
| Name |
Type |
Description |
Required |
| AuthenticationFailedError |
|
Invalid email or password. |
|
AuthorizedCategory
| Name |
Type |
Description |
Required |
| AuthorizedCategory |
string |
|
|
AutoDisableLogsResponse
| Name |
Type |
Description |
Required |
| count |
integer |
|
Yes |
| document_ids |
[ string ] |
|
Yes |
AvailableModelListResponse
AvatarUrlResponse
| Name |
Type |
Description |
Required |
| avatar_url |
string |
|
Yes |
AverageResponseTimeStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| latency |
number |
|
Yes |
AverageResponseTimeStatisticResponse
AverageSessionInteractionStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| interactions |
number |
|
Yes |
AverageSessionInteractionStatisticResponse
BannerContentResponse
| Name |
Type |
Description |
Required |
| category |
string |
|
Yes |
| description |
string |
|
Yes |
| img-src |
string |
|
Yes |
| title |
string |
|
Yes |
BannerListResponse
| Name |
Type |
Description |
Required |
| BannerListResponse |
array |
|
|
BannerResponse
BannerStatus
ExporleBanner status
| Name |
Type |
Description |
Required |
| BannerStatus |
string |
ExporleBanner status |
|
BatchImportPayload
| Name |
Type |
Description |
Required |
| upload_file_id |
string |
|
Yes |
BillingInvoiceResponse
| Name |
Type |
Description |
Required |
| url |
string |
|
Yes |
BillingModel
BillingOperationFailedError
We couldn't complete this request. Please try again. If the problem persists, contact support.
| Name |
Type |
Description |
Required |
| BillingOperationFailedError |
|
We couldn't complete this request. Please try again. If the problem persists, contact support. |
|
BillingOperationFailedErrorResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| message |
string |
|
Yes |
| status |
integer |
|
Yes |
BillingSubscriptionResponse
| Name |
Type |
Description |
Required |
| url |
string |
|
Yes |
BillingUnavailableError
This operation is temporarily unavailable. Please try again later.
| Name |
Type |
Description |
Required |
| BillingUnavailableError |
|
This operation is temporarily unavailable. Please try again later. |
|
BillingUnavailableErrorResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| message |
string |
|
Yes |
| status |
integer |
|
Yes |
BillingUnprocessableEntityErrorResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| message |
string |
|
Yes |
| status |
integer |
|
Yes |
BinaryFileResponse
| Name |
Type |
Description |
Required |
| BinaryFileResponse |
string |
|
|
BindingFileDownloadUnavailableError
Sandbox file download is unavailable.
| Name |
Type |
Description |
Required |
| BindingFileDownloadUnavailableError |
|
Sandbox file download is unavailable. |
|
BrandingModel
| Name |
Type |
Description |
Required |
| application_title |
string |
|
Yes |
| enabled |
boolean |
|
Yes |
| favicon |
string |
|
Yes |
| login_page_logo |
string |
|
Yes |
| workspace_logo |
string |
|
Yes |
BuiltinCredentialListQuery
| Name |
Type |
Description |
Required |
| include_credential_ids |
[ string ] |
Credential IDs to include even if visibility would hide them |
No |
BuiltinProviderDefaultCredentialPayload
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
BuiltinProviderOAuthClientSchemaResponse
| Name |
Type |
Description |
Required |
| client_params |
object |
|
No |
| is_oauth_custom_client_enabled |
boolean |
|
Yes |
| is_system_oauth_params_exists |
boolean |
|
Yes |
| redirect_uri |
string |
|
Yes |
| schema |
[ ProviderConfig ] |
|
Yes |
BuiltinToolAddPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| name |
string |
|
No |
| type |
CredentialType |
|
Yes |
| visibility |
string |
|
No |
BuiltinToolCredentialDeletePayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
BuiltinToolUpdatePayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| credentials |
object |
|
No |
| name |
string |
|
No |
ButtonStyle
Button styles for user actions.
| Name |
Type |
Description |
Required |
| ButtonStyle |
string |
Button styles for user actions. |
|
CannotOperateSelfError
Cannot operate on yourself.
| Name |
Type |
Description |
Required |
| CannotOperateSelfError |
|
Cannot operate on yourself. |
|
CannotTransferOwnerToSelfError
You cannot transfer ownership to yourself.
| Name |
Type |
Description |
Required |
| CannotTransferOwnerToSelfError |
|
You cannot transfer ownership to yourself. |
|
ChangeEmailResetPayload
| Name |
Type |
Description |
Required |
| new_email |
string |
|
Yes |
| token |
string |
|
Yes |
ChangeEmailSendPayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| language |
string |
|
No |
| phase |
string |
|
No |
| token |
string |
|
No |
ChangeEmailValidityPayload
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| email |
string |
|
Yes |
| token |
string |
|
Yes |
ChatConversationQuery
| Name |
Type |
Description |
Required |
| annotation_status |
string,
Available values: "all", "annotated", "not_annotated",
Default: all |
Annotation status filter
Enum: "all", "annotated", "not_annotated" |
No |
| end |
string |
End date (YYYY-MM-DD HH:MM) |
No |
| keyword |
string |
Search keyword |
No |
| limit |
integer,
Default: 20 |
Page size (1-100) |
No |
| page |
integer,
Default: 1 |
Page number |
No |
| sort_by |
string,
Available values: "-created_at", "-updated_at", "created_at", "updated_at",
Default: -updated_at |
Sort field and direction
Enum: "-created_at", "-updated_at", "created_at", "updated_at" |
No |
| start |
string |
Start date (YYYY-MM-DD HH:MM) |
No |
ChatMessageExplorePayload
| Name |
Type |
Description |
Required |
| conversation_id |
string |
|
No |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
| parent_message_id |
string |
|
No |
| query |
string |
|
Yes |
| retriever_from |
string,
Default: explore_app |
|
No |
ChatMessagePayload
| Name |
Type |
Description |
Required |
| conversation_id |
string |
Conversation ID |
No |
| draft_type |
string,
Available values: "debug_build", "draft",
Default: draft |
Agent App debug config source. Use debug_build while the Agent is in build mode.
Enum: "debug_build", "draft" |
No |
| files |
[ object ] |
Uploaded files |
No |
| inputs |
object |
|
Yes |
| model_config |
object |
|
No |
| parent_message_id |
string |
Parent message ID |
No |
| query |
string |
User query |
Yes |
| response_mode |
string,
Available values: "blocking", "streaming",
Default: blocking |
Response mode
Enum: "blocking", "streaming" |
No |
| retriever_from |
string,
Default: dev |
Retriever source |
No |
ChatMessagesQuery
| Name |
Type |
Description |
Required |
| conversation_id |
string |
Conversation ID |
Yes |
| first_id |
string |
First message ID for pagination |
No |
| limit |
integer,
Default: 20 |
Number of messages to return (1-100) |
No |
ChatRequest
| Name |
Type |
Description |
Required |
| conversation_id |
string |
|
No |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
| parent_message_id |
string |
|
No |
| query |
string |
|
Yes |
| retriever_from |
string,
Default: explore_app |
|
No |
CheckDependenciesResult
CheckEmailUniquePayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
CheckResultView
type_check / output_check per-output summary block.
| Name |
Type |
Description |
Required |
| passed |
boolean |
|
Yes |
| reason |
string |
|
No |
ChildChunkBatchUpdatePayload
ChildChunkBatchUpdateResponse
ChildChunkCreatePayload
| Name |
Type |
Description |
Required |
| content |
string |
Child chunk text content. |
Yes |
ChildChunkDeleteIndexError
Delete child chunk index failed: {message}
| Name |
Type |
Description |
Required |
| ChildChunkDeleteIndexError |
|
Delete child chunk index failed: {message} |
|
ChildChunkDetailResponse
ChildChunkIndexingError
Create child chunk index failed: {message}
| Name |
Type |
Description |
Required |
| ChildChunkIndexingError |
|
Create child chunk index failed: {message} |
|
ChildChunkListQuery
| Name |
Type |
Description |
Required |
| keyword |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
ChildChunkListResponse
| Name |
Type |
Description |
Required |
| data |
[ ChildChunkResponse ] |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
| total_pages |
integer |
|
Yes |
ChildChunkResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| id |
string |
|
Yes |
| position |
integer |
|
Yes |
| segment_id |
string |
|
Yes |
| type |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
| word_count |
integer |
|
Yes |
ChildChunkUpdateArgs
| Name |
Type |
Description |
Required |
| content |
string |
Child chunk text content. |
Yes |
| id |
string |
Existing child chunk ID. Omit to create a new child chunk. |
No |
ChildChunkUpdatePayload
| Name |
Type |
Description |
Required |
| content |
string |
Child chunk text content. |
Yes |
CloudPlan
Enum representing user plan types in the cloud platform.
SANDBOX: Free/default plan with limited features
PROFESSIONAL: Professional paid plan
TEAM: Team collaboration paid plan
| Name |
Type |
Description |
Required |
| CloudPlan |
string |
Enum representing user plan types in the cloud platform. SANDBOX: Free/default plan with limited features PROFESSIONAL: Professional paid plan TEAM: Team collaboration paid plan |
|
CodeBasedExtensionItemResponse
| Name |
Type |
Description |
Required |
| form_schema |
[ object ] |
|
No |
| label |
object |
|
No |
| name |
string |
|
Yes |
CodeBasedExtensionQuery
| Name |
Type |
Description |
Required |
| module |
string |
|
Yes |
CodeBasedExtensionResponse
CompletionConversationQuery
| Name |
Type |
Description |
Required |
| annotation_status |
string,
Available values: "all", "annotated", "not_annotated",
Default: all |
Annotation status filter
Enum: "all", "annotated", "not_annotated" |
No |
| end |
string |
End date (YYYY-MM-DD HH:MM) |
No |
| keyword |
string |
Search keyword |
No |
| limit |
integer,
Default: 20 |
Page size (1-100) |
No |
| page |
integer,
Default: 1 |
Page number |
No |
| start |
string |
Start date (YYYY-MM-DD HH:MM) |
No |
CompletionMessageExplorePayload
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
| query |
string |
|
No |
| response_mode |
string,
Available values: "blocking", "streaming" |
|
No |
| retriever_from |
string,
Default: explore_app |
|
No |
CompletionMessagePayload
| Name |
Type |
Description |
Required |
| files |
[ object ] |
Uploaded files |
No |
| inputs |
object |
|
Yes |
| model_config |
object |
|
No |
| query |
string |
Query text |
No |
| response_mode |
string,
Available values: "blocking", "streaming",
Default: blocking |
Response mode
Enum: "blocking", "streaming" |
No |
| retriever_from |
string,
Default: dev |
Retriever source |
No |
CompletionRequest
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
| query |
string |
|
No |
| response_mode |
string,
Available values: "blocking", "streaming" |
|
No |
| retriever_from |
string,
Default: explore_app |
|
No |
CompletionRequestError
Completion request failed.
| Name |
Type |
Description |
Required |
| CompletionRequestError |
|
Completion request failed. |
|
ComplianceDownloadQuery
| Name |
Type |
Description |
Required |
| doc_name |
string |
Compliance document name |
Yes |
ComplianceDownloadResponse
| Name |
Type |
Description |
Required |
| url |
string |
|
Yes |
ComplianceRateLimitError
Rate limit exceeded for downloading compliance report.
| Name |
Type |
Description |
Required |
| ComplianceRateLimitError |
|
Rate limit exceeded for downloading compliance report. |
|
ComplianceRateLimitErrorResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| message |
string |
|
Yes |
| status |
integer |
|
Yes |
ComposerBindingPayload
| Name |
Type |
Description |
Required |
| agent_id |
string |
|
No |
| binding_type |
string,
Available values: "inline_agent", "roster_agent" |
Enum: "inline_agent", "roster_agent" |
Yes |
| current_snapshot_id |
string |
|
No |
ComposerCandidateCapabilities
| Name |
Type |
Description |
Required |
| human_roster_available |
boolean |
|
No |
ComposerKnowledgePlaceholderResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| placeholder_name |
string |
|
Yes |
ComposerSavePayload
ComposerSaveStrategy
| Name |
Type |
Description |
Required |
| ComposerSaveStrategy |
string |
|
|
ComposerSoulLockPayload
| Name |
Type |
Description |
Required |
| locked |
boolean,
Default: true |
|
No |
| unlocked_from_version_id |
string |
|
No |
ComposerValidationFindingsResponse
ComposerValidationWarningResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| id |
string |
|
No |
| kind |
string |
|
No |
| message |
string |
|
No |
| surface |
string |
|
No |
ComposerVariant
| Name |
Type |
Description |
Required |
| ComposerVariant |
string |
|
|
Condition
Condition detail
| Name |
Type |
Description |
Required |
| comparison_operator |
string,
Available values: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Comparison to apply. String operators (contains, not contains, start with, end with, is, is not, empty, not empty, in, not in) act on string or array metadata; numeric operators (=, ≠, >, <, ≥, ≤) act on numeric metadata; time operators (before, after) act on time metadata.
Enum: "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" |
Yes |
| name |
string |
Metadata field name to compare against. |
Yes |
| value |
string
[ string ]
number |
Value to compare against. Type depends on comparison_operator: string for most string operators, array of strings for in and not in, number for numeric operators, and omit or use null for empty and not empty. |
No |
ConfigurateMethod
Enum class for configurate method of provider model.
| Name |
Type |
Description |
Required |
| ConfigurateMethod |
string |
Enum class for configurate method of provider model. |
|
ConsoleDatasetListQuery
| Name |
Type |
Description |
Required |
| ids |
[ string ] |
Filter by dataset IDs |
No |
| include_all |
boolean |
Include all datasets |
No |
| keyword |
string |
Search keyword |
No |
| limit |
integer,
Default: 20 |
Number of items per page |
No |
| page |
integer,
Default: 1 |
Page number |
No |
| tag_ids |
[ string ] |
Filter by tag IDs |
No |
ConsoleHumanInputFormDefinitionResponse
| Name |
Type |
Description |
Required |
| ConsoleHumanInputFormDefinitionResponse |
object |
|
|
ConsoleHumanInputFormSubmitResponse
| Name |
Type |
Description |
Required |
| ConsoleHumanInputFormSubmitResponse |
object |
|
|
ConsoleSegmentListResponse
| Name |
Type |
Description |
Required |
| data |
[ SegmentResponse ] |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
| total_pages |
integer |
|
Yes |
Conversation
| Name |
Type |
Description |
Required |
| admin_feedback_stats |
FeedbackStat |
|
No |
| annotation |
ConversationAnnotation |
|
No |
| created_at |
integer |
|
No |
| from_account_id |
string |
|
No |
| from_account_name |
string |
|
No |
| from_end_user_id |
string |
|
No |
| from_end_user_session_id |
string |
|
No |
| from_source |
string |
|
Yes |
| id |
string |
|
Yes |
| message |
SimpleMessageDetail |
|
No |
| model_config |
SimpleModelConfig |
|
No |
| read_at |
integer |
|
No |
| status |
string |
|
Yes |
| updated_at |
integer |
|
No |
| user_feedback_stats |
FeedbackStat |
|
No |
ConversationAnnotation
| Name |
Type |
Description |
Required |
| account |
SimpleAccount |
|
No |
| content |
string |
|
Yes |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| question |
string |
|
No |
ConversationAnnotationHitHistory
| Name |
Type |
Description |
Required |
| annotation_create_account |
SimpleAccount |
|
No |
| annotation_id |
string |
|
Yes |
| created_at |
integer |
|
No |
ConversationCursorNotFoundError
The conversation cursor is not in the current list. Refresh the list and try again.
| Name |
Type |
Description |
Required |
| ConversationCursorNotFoundError |
|
The conversation cursor is not in the current list. Refresh the list and try again. |
|
ConversationDetail
| Name |
Type |
Description |
Required |
| admin_feedback_stats |
FeedbackStat |
|
No |
| annotated |
boolean |
|
Yes |
| created_at |
integer |
|
No |
| from_account_id |
string |
|
No |
| from_end_user_id |
string |
|
No |
| from_source |
string |
|
Yes |
| id |
string |
|
Yes |
| introduction |
string |
|
No |
| message_count |
integer |
|
Yes |
| model_config |
ConversationModelConfig |
|
No |
| status |
string |
|
Yes |
| updated_at |
integer |
|
No |
| user_feedback_stats |
FeedbackStat |
|
No |
ConversationFirstMessageNotFoundError
The conversation has no message from which to generate a name.
| Name |
Type |
Description |
Required |
| ConversationFirstMessageNotFoundError |
|
The conversation has no message from which to generate a name. |
|
| Name |
Type |
Description |
Required |
| data |
[ SimpleConversation ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
ConversationListQuery
| Name |
Type |
Description |
Required |
| last_id |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| pinned |
boolean |
|
No |
ConversationMessageDetail
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| from_account_id |
string |
|
No |
| from_end_user_id |
string |
|
No |
| from_source |
string |
|
Yes |
| id |
string |
|
Yes |
| message |
MessageDetail |
|
No |
| model_config |
ConversationModelConfig |
|
No |
| status |
string |
|
Yes |
ConversationModelConfig
ConversationNameRequiredError
A name is required when automatic naming is disabled.
| Name |
Type |
Description |
Required |
| ConversationNameRequiredError |
|
A name is required when automatic naming is disabled. |
|
ConversationNotFoundError
The conversation was not found for this account and app.
| Name |
Type |
Description |
Required |
| ConversationNotFoundError |
|
The conversation was not found for this account and app. |
|
| Name |
Type |
Description |
Required |
| data |
[ Conversation ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
ConversationRenamePayload
| Name |
Type |
Description |
Required |
| auto_generate |
boolean |
Automatically generate the conversation name. When true, the name field is ignored. |
No |
| name |
string |
Conversation name. Required when auto_generate is false. |
No |
ConversationVariableItemPayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| id |
string |
|
No |
| name |
string |
|
No |
| value |
|
|
No |
| value_type |
string |
|
No |
ConversationVariableResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| description |
string |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| updated_at |
integer |
|
No |
| value |
string |
|
No |
| value_type |
string |
|
Yes |
ConversationVariableUpdatePayload
ConversationVariablesQuery
| Name |
Type |
Description |
Required |
| conversation_id |
string |
Conversation ID to filter variables |
Yes |
ConversationWithSummary
| Name |
Type |
Description |
Required |
| admin_feedback_stats |
FeedbackStat |
|
No |
| annotated |
boolean |
|
Yes |
| created_at |
integer |
|
No |
| from_account_id |
string |
|
No |
| from_account_name |
string |
|
No |
| from_end_user_id |
string |
|
No |
| from_end_user_session_id |
string |
|
No |
| from_source |
string |
|
Yes |
| id |
string |
|
Yes |
| message_count |
integer |
|
Yes |
| model_config |
SimpleModelConfig |
|
No |
| name |
string |
|
Yes |
| read_at |
integer |
|
No |
| status |
string |
|
Yes |
| status_count |
StatusCount |
|
No |
| summary |
string |
|
Yes |
| updated_at |
integer |
|
No |
| user_feedback_stats |
FeedbackStat |
|
No |
| Name |
Type |
Description |
Required |
| data |
[ ConversationWithSummary ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
ConvertToWorkflowPayload
| Name |
Type |
Description |
Required |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| name |
string |
|
No |
CopyAppPayload
| Name |
Type |
Description |
Required |
| description |
string |
Description for the copied app |
No |
| icon |
string |
Icon |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
| name |
string |
Name for the copied app |
No |
CopyRoleParam
| Name |
Type |
Description |
Required |
| copy_member |
boolean,
Default: true |
|
No |
CrawlFailedError
{message}
| Name |
Type |
Description |
Required |
| CrawlFailedError |
|
{message} |
|
CreateAnnotationPayload
| Name |
Type |
Description |
Required |
| annotation_reply |
object |
Annotation reply data |
No |
| answer |
string |
Answer text |
No |
| content |
string |
Content text |
No |
| message_id |
string |
Message ID |
No |
| question |
string |
Question text |
No |
CreateAppPayload
| Name |
Type |
Description |
Required |
| description |
string |
App description (max 400 chars) |
No |
| icon |
string |
Icon |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
| mode |
string,
Available values: "advanced-chat", "agent-chat", "chat", "completion", "workflow" |
App mode
Enum: "advanced-chat", "agent-chat", "chat", "completion", "workflow" |
Yes |
| name |
string |
App name |
Yes |
CreateSnippetPayload
Payload for creating a new snippet.
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| graph |
object |
|
No |
| icon_info |
IconInfo |
|
No |
| input_fields |
[ InputFieldDefinition ] |
|
No |
| name |
string |
|
Yes |
| type |
string,
Available values: "group", "node",
Default: node |
Enum: "group", "node" |
No |
CredentialConfiguration
Model class for credential configuration.
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| credential_name |
string |
|
Yes |
CredentialFormSchema
Model class for credential form schema.
CredentialType
| Name |
Type |
Description |
Required |
| CredentialType |
string |
|
|
CurrentPasswordIncorrectError
Current password is incorrect.
| Name |
Type |
Description |
Required |
| CurrentPasswordIncorrectError |
|
Current password is incorrect. |
|
CurrentWorkspaceArchivedError
The current workspace has been archived.
| Name |
Type |
Description |
Required |
| CurrentWorkspaceArchivedError |
|
The current workspace has been archived. |
|
CurrentWorkspaceSummaryResponse
| Name |
Type |
Description |
Required |
| credits |
integer |
Remaining credits in the effective pool; -1 means unlimited. |
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| plan |
CloudPlan |
|
Yes |
| role |
TenantAccountRole |
|
Yes |
CustomConfigurationResponse
Model class for provider custom configuration response.
CustomConfigurationStatus
Enum class for custom configuration status.
| Name |
Type |
Description |
Required |
| CustomConfigurationStatus |
string |
Enum class for custom configuration status. |
|
CustomModelConfiguration
Model class for provider custom model configuration.
| Name |
Type |
Description |
Required |
| available_model_credentials |
[ CredentialConfiguration ],
Default: |
|
No |
| credentials |
object |
|
Yes |
| current_credential_id |
string |
|
No |
| current_credential_name |
string |
|
No |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
| unadded_to_model_list |
boolean |
|
No |
CustomizeTokenStrategy
Site token customization strategy
| Name |
Type |
Description |
Required |
| CustomizeTokenStrategy |
string |
Site token customization strategy |
|
CustomizedPipelineTemplatePayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| icon_info |
object |
|
No |
| name |
string |
|
Yes |
DailyConversationStatisticItem
| Name |
Type |
Description |
Required |
| conversation_count |
integer |
|
Yes |
| date |
string |
|
Yes |
DailyConversationStatisticResponse
DailyMessageStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| message_count |
integer |
|
Yes |
DailyMessageStatisticResponse
DailyTerminalStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| terminal_count |
integer |
|
Yes |
DailyTerminalStatisticResponse
DailyTokenCostStatisticItem
| Name |
Type |
Description |
Required |
| currency |
string |
|
No |
| date |
string |
|
Yes |
| token_count |
integer |
|
No |
| total_price |
string |
|
No |
DailyTokenCostStatisticResponse
DataSource
| Name |
Type |
Description |
Required |
| info_list |
InfoList |
|
Yes |
DataSourceApiKeyAuthProviderUnavailableError
The data-source API-key authentication provider is temporarily unavailable.
| Name |
Type |
Description |
Required |
| DataSourceApiKeyAuthProviderUnavailableError |
|
The data-source API-key authentication provider is temporarily unavailable. |
|
DataSourceIntegrateIconResponse
| Name |
Type |
Description |
Required |
| emoji |
string |
|
No |
| type |
string |
|
No |
| url |
string |
|
No |
DataSourceIntegrateListResponse
DataSourceIntegrateResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| disabled |
boolean |
|
Yes |
| id |
string |
|
Yes |
| is_bound |
boolean |
|
Yes |
| link |
string |
|
Yes |
| provider |
string |
|
Yes |
| source_info |
DataSourceIntegrateWorkspaceResponse |
|
Yes |
DataSourceIntegrateWorkspaceResponse
| Name |
Type |
Description |
Required |
| pages |
[ DataSourceIntegratePageResponse ] |
|
Yes |
| total |
integer |
|
Yes |
| workspace_icon |
string |
|
Yes |
| workspace_id |
string |
|
Yes |
| workspace_name |
string |
|
Yes |
DatasetAccessDeniedError
Dataset access denied.
| Name |
Type |
Description |
Required |
| DatasetAccessDeniedError |
|
Dataset access denied. |
|
DatasetAccessMatrix
| Name |
Type |
Description |
Required |
| dataset_id |
string |
|
No |
| items |
[ AccessMatrixItem ] |
|
No |
DatasetAndDocumentResponse
DatasetApiKeyCreatePayload
| Name |
Type |
Description |
Required |
| dataset_ids |
[ string ] |
|
No |
DatasetCreatePayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| external_knowledge_api_id |
string |
|
No |
| external_knowledge_id |
string |
|
No |
| indexing_technique |
string |
|
No |
| name |
string |
|
Yes |
| permission |
PermissionEnum |
|
No |
| provider |
string,
Default: vendor |
|
No |
DatasetDetailResponse
| Name |
Type |
Description |
Required |
| app_count |
integer |
|
Yes |
| author_name |
string |
|
Yes |
| built_in_field_enabled |
boolean |
|
Yes |
| chunk_structure |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| data_source_type |
string |
|
Yes |
| description |
string |
|
Yes |
| doc_form |
string |
|
Yes |
| doc_metadata |
[ DatasetDocMetadataResponse ] |
|
Yes |
| document_count |
integer |
|
Yes |
| embedding_available |
boolean |
|
No |
| embedding_model |
string |
|
Yes |
| embedding_model_provider |
string |
|
Yes |
| enable_api |
boolean |
|
Yes |
| external_knowledge_info |
DatasetExternalKnowledgeInfoResponse |
Connection details for external knowledge bases. Populated when provider is external; otherwise its properties are null. |
No |
| external_retrieval_model |
DatasetExternalRetrievalModelResponse |
|
Yes |
| icon_info |
DatasetIconInfoResponse |
Icon display configuration for the knowledge base. |
No |
| id |
string |
|
Yes |
| indexing_technique |
string |
|
Yes |
| is_multimodal |
boolean |
|
Yes |
| is_published |
boolean |
|
Yes |
| maintainer |
string |
|
No |
| name |
string |
|
Yes |
| permission |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| pipeline_id |
string |
|
Yes |
| provider |
string |
|
Yes |
| retrieval_model_dict |
DatasetRetrievalModelResponse |
Retrieval configuration for the knowledge base. |
Yes |
| runtime_mode |
string |
|
Yes |
| summary_index_setting |
DatasetSummaryIndexSettingResponse |
Summary index configuration. |
No |
| tags |
[ DatasetTagResponse ] |
|
Yes |
| total_available_documents |
integer |
|
Yes |
| total_documents |
integer |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| word_count |
integer |
|
Yes |
DatasetDetailWithPartialMembersResponse
| Name |
Type |
Description |
Required |
| app_count |
integer |
|
Yes |
| author_name |
string |
|
Yes |
| built_in_field_enabled |
boolean |
|
Yes |
| chunk_structure |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| data_source_type |
string |
|
Yes |
| description |
string |
|
Yes |
| doc_form |
string |
|
Yes |
| doc_metadata |
[ DatasetDocMetadataResponse ] |
|
Yes |
| document_count |
integer |
|
Yes |
| embedding_available |
boolean |
|
No |
| embedding_model |
string |
|
Yes |
| embedding_model_provider |
string |
|
Yes |
| enable_api |
boolean |
|
Yes |
| external_knowledge_info |
DatasetExternalKnowledgeInfoResponse |
Connection details for external knowledge bases. Populated when provider is external; otherwise its properties are null. |
No |
| external_retrieval_model |
DatasetExternalRetrievalModelResponse |
|
Yes |
| icon_info |
DatasetIconInfoResponse |
Icon display configuration for the knowledge base. |
No |
| id |
string |
|
Yes |
| indexing_technique |
string |
|
Yes |
| is_multimodal |
boolean |
|
Yes |
| is_published |
boolean |
|
Yes |
| maintainer |
string |
|
No |
| name |
string |
|
Yes |
| partial_member_list |
[ string ] |
|
No |
| permission |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| pipeline_id |
string |
|
Yes |
| provider |
string |
|
Yes |
| retrieval_model_dict |
DatasetRetrievalModelResponse |
Retrieval configuration for the knowledge base. |
Yes |
| runtime_mode |
string |
|
Yes |
| summary_index_setting |
DatasetSummaryIndexSettingResponse |
Summary index configuration. |
No |
| tags |
[ DatasetTagResponse ] |
|
Yes |
| total_available_documents |
integer |
|
Yes |
| total_documents |
integer |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| word_count |
integer |
|
Yes |
DatasetDocMetadataResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
DatasetExternalKnowledgeInfoResponse
| Name |
Type |
Description |
Required |
| external_knowledge_api_endpoint |
string |
|
No |
| external_knowledge_api_id |
string |
|
No |
| external_knowledge_api_name |
string |
|
No |
| external_knowledge_id |
string |
|
No |
DatasetExternalRetrievalModelResponse
| Name |
Type |
Description |
Required |
| score_threshold |
number |
|
No |
| score_threshold_enabled |
boolean |
|
No |
| top_k |
integer |
|
Yes |
DatasetIconInfoResponse
| Name |
Type |
Description |
Required |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| icon_url |
string |
|
No |
DatasetKeywordSettingResponse
| Name |
Type |
Description |
Required |
| keyword_weight |
number |
|
No |
DatasetListItemResponse
| Name |
Type |
Description |
Required |
| app_count |
integer |
|
Yes |
| author_name |
string |
|
Yes |
| built_in_field_enabled |
boolean |
|
Yes |
| chunk_structure |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| data_source_type |
string |
|
Yes |
| description |
string |
|
Yes |
| doc_form |
string |
|
Yes |
| doc_metadata |
[ DatasetDocMetadataResponse ] |
|
Yes |
| document_count |
integer |
|
Yes |
| embedding_available |
boolean |
|
No |
| embedding_model |
string |
|
Yes |
| embedding_model_provider |
string |
|
Yes |
| enable_api |
boolean |
|
Yes |
| external_knowledge_info |
DatasetExternalKnowledgeInfoResponse |
Connection details for external knowledge bases. Populated when provider is external; otherwise its properties are null. |
No |
| external_retrieval_model |
DatasetExternalRetrievalModelResponse |
|
Yes |
| icon_info |
DatasetIconInfoResponse |
Icon display configuration for the knowledge base. |
No |
| id |
string |
|
Yes |
| indexing_technique |
string |
|
Yes |
| is_multimodal |
boolean |
|
Yes |
| is_published |
boolean |
|
Yes |
| maintainer |
string |
|
No |
| name |
string |
|
Yes |
| partial_member_list |
[ string ] |
|
Yes |
| permission |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| pipeline_id |
string |
|
Yes |
| provider |
string |
|
Yes |
| retrieval_model_dict |
DatasetRetrievalModelResponse |
Retrieval configuration for the knowledge base. |
Yes |
| runtime_mode |
string |
|
Yes |
| summary_index_setting |
DatasetSummaryIndexSettingResponse |
Summary index configuration. |
No |
| tags |
[ DatasetTagResponse ] |
|
Yes |
| total_available_documents |
integer |
|
Yes |
| total_documents |
integer |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| word_count |
integer |
|
Yes |
DatasetListResponse
| Name |
Type |
Description |
Required |
| data |
[ DatasetListItemResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
DatasetMetadataBuiltInFieldResponse
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
DatasetMetadataBuiltInFieldsResponse
DatasetMetadataListItemResponse
| Name |
Type |
Description |
Required |
| count |
integer |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
DatasetMetadataListResponse
DatasetMetadataResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
DatasetNameDuplicateError
The dataset name already exists. Please modify your dataset name.
| Name |
Type |
Description |
Required |
| DatasetNameDuplicateError |
|
The dataset name already exists. Please modify your dataset name. |
|
DatasetQueryContentResponse
DatasetQueryDetailResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| created_by_role |
string |
|
Yes |
| id |
string |
|
Yes |
| queries |
[ DatasetQueryContentResponse ] |
|
Yes |
| source |
string |
|
Yes |
| source_app_id |
string |
|
Yes |
DatasetQueryFileInfoResponse
| Name |
Type |
Description |
Required |
| extension |
string |
|
Yes |
| id |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| name |
string |
|
Yes |
| size |
integer |
|
Yes |
| source_url |
string |
|
Yes |
DatasetQueryListResponse
| Name |
Type |
Description |
Required |
| data |
[ DatasetQueryDetailResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
DatasetRerankingModelResponse
| Name |
Type |
Description |
Required |
| reranking_model_name |
string |
|
No |
| reranking_provider_name |
string |
|
No |
DatasetResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| data_source_type |
string |
|
No |
| description |
string |
|
No |
| id |
string |
|
Yes |
| indexing_technique |
string |
|
No |
| name |
string |
|
Yes |
| permission |
string |
|
No |
DatasetRetrievalModelResponse
| Name |
Type |
Description |
Required |
| reranking_enable |
boolean |
|
Yes |
| reranking_mode |
string |
|
No |
| reranking_model |
DatasetRerankingModelResponse |
Reranking model configuration. |
No |
| score_threshold |
number |
|
No |
| score_threshold_enabled |
boolean |
|
Yes |
| search_method |
string |
|
Yes |
| top_k |
integer |
|
Yes |
| weights |
DatasetWeightedScoreResponse |
|
No |
DatasetSummaryIndexSettingResponse
| Name |
Type |
Description |
Required |
| enable |
boolean |
|
No |
| model_name |
string |
|
No |
| model_provider_name |
string |
|
No |
| summary_prompt |
string |
|
No |
DatasetTagResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
DatasetUpdatePayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| embedding_model |
string |
|
No |
| embedding_model_provider |
string |
|
No |
| external_knowledge_api_id |
string |
|
No |
| external_knowledge_id |
string |
|
No |
| external_retrieval_model |
object |
|
No |
| icon_info |
object |
|
No |
| indexing_technique |
string |
|
No |
| is_multimodal |
boolean |
|
No |
| name |
string |
|
No |
| partial_member_list |
[ object ] |
|
No |
| permission |
PermissionEnum |
|
No |
| retrieval_model |
object |
|
No |
| summary_index_setting |
object |
|
No |
DatasetVectorSettingResponse
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
|
No |
| embedding_provider_name |
string |
|
No |
| vector_weight |
number |
|
No |
DatasetWeightedScoreResponse
DatasourceContentPreviewPayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
| datasource_type |
string |
|
Yes |
| inputs |
object |
|
Yes |
DatasourceCredentialDeletePayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
DatasourceCredentialListResponse
DatasourceCredentialPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
Plugin-defined credential parameters. The schema is declared by the datasource provider. |
Yes |
| name |
string |
|
No |
DatasourceCredentialResponse
| Name |
Type |
Description |
Required |
| avatar_url |
string |
|
Yes |
| credential |
object |
Obfuscated plugin-defined credential parameters from the datasource provider. |
Yes |
| id |
string |
|
Yes |
| is_default |
boolean |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
DatasourceCredentialUpdatePayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| credentials |
object |
Plugin-defined credential parameters. The schema is declared by the datasource provider. |
No |
| name |
string |
|
No |
DatasourceCustomClientPayload
| Name |
Type |
Description |
Required |
| client_params |
object |
Plugin-defined OAuth client parameters. The schema is declared by the datasource provider. |
No |
| enable_oauth_custom_client |
boolean |
|
No |
DatasourceDefaultPayload
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
DatasourceEntity
DatasourceIdentity
| Name |
Type |
Description |
Required |
| author |
string |
The author of the datasource |
Yes |
| icon |
string |
|
No |
| label |
I18nObject |
The label of the datasource |
Yes |
| name |
string |
The name of the datasource |
Yes |
| provider |
string |
The provider of the datasource |
Yes |
DatasourceNodeRunPayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
| datasource_type |
string |
|
Yes |
| inputs |
object |
|
Yes |
DatasourceOAuthAuthorizationQuery
| Name |
Type |
Description |
Required |
| credential_id |
string |
Credential ID to reauthorize |
No |
| visibility |
string |
Visibility for the credential to be created. Accepts 'only_me' or 'all_team_members'; any other value falls back to 'only_me'. Ignored on reauthorization (credential_id set). |
No |
DatasourceOAuthCallbackQuery
| Name |
Type |
Description |
Required |
| code |
string |
Authorization code from OAuth provider |
No |
| context_id |
string |
OAuth proxy context ID |
No |
| error |
string |
Error message from OAuth provider |
No |
| state |
string |
OAuth state parameter |
No |
DatasourceOAuthSchemaResponse
| Name |
Type |
Description |
Required |
| client_schema |
[ ProviderConfig ] |
|
Yes |
| credentials_schema |
[ ProviderConfig ] |
|
Yes |
| is_oauth_custom_client_enabled |
boolean |
|
Yes |
| is_system_oauth_params_exists |
boolean |
|
Yes |
| oauth_custom_client_params |
object |
Masked plugin-defined OAuth client parameters, when configured for the tenant. |
Yes |
| redirect_uri |
string |
|
Yes |
DatasourceParameter
Overrides type
DatasourceParameterType
removes TOOLS_SELECTOR from PluginParameterType
| Name |
Type |
Description |
Required |
| DatasourceParameterType |
string |
removes TOOLS_SELECTOR from PluginParameterType |
|
DatasourceProviderAuthListResponse
DatasourceProviderAuthResponse
DatasourceProviderEntity
Datasource provider entity
DatasourceProviderEntityWithPlugin
DatasourceProviderIdentity
| Name |
Type |
Description |
Required |
| author |
string |
The author of the tool |
Yes |
| description |
I18nObject |
The description of the tool |
Yes |
| icon |
string |
The icon of the tool |
Yes |
| label |
I18nObject |
The label of the tool |
Yes |
| name |
string |
The name of the tool |
Yes |
| tags |
[ ToolLabelEnum ] |
The tags of the tool |
No |
DatasourceProviderType
Enum class for datasource provider
| Name |
Type |
Description |
Required |
| DatasourceProviderType |
string |
Enum class for datasource provider |
|
DatasourceUpdateNamePayload
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| name |
string |
|
Yes |
DatasourceVariablesPayload
| Name |
Type |
Description |
Required |
| datasource_info |
object |
|
Yes |
| datasource_type |
string |
|
Yes |
| start_node_id |
string |
|
Yes |
| start_node_title |
string |
|
Yes |
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 |
| children |
[ { "array_item": , "children": [ object ], "description": , "file": , "name": string, "required": boolean, "type": string,
Available values: "array", "boolean", "file", "number", "object", "string" } ] |
|
No |
| description |
string |
|
No |
| type |
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.
DeclaredOutputConfig
One declared output of a Workflow Agent Node.
Stage 4 normalizes the shape: check is singular (was checks: list in
stage 3), and failure_strategy defaults to a populated value so runtime
code can call output.failure_strategy.on_failure without None-guards.
| Name |
Type |
Description |
Required |
| array_item |
DeclaredArrayItem |
|
No |
| check |
DeclaredOutputCheckConfig |
|
No |
| children |
[ { "array_item": , "children": [ object ], "description": , "file": , "name": string, "required": boolean, "type": string,
Available values: "array", "boolean", "file", "number", "object", "string" } ] |
|
No |
| description |
string |
|
No |
| failure_strategy |
DeclaredOutputFailureStrategy |
|
No |
| file |
DeclaredOutputFileConfig |
|
No |
| id |
string |
|
No |
| name |
string |
|
Yes |
| required |
boolean,
Default: true |
|
No |
| type |
DeclaredOutputType |
|
Yes |
DeclaredOutputFailureStrategy
Per-output failure handling.
A single strategy applies to both type_check and output_check failures
(PRD does not distinguish them at the UX level). Stage 4 §4.4.
DeclaredOutputFileConfig
File-type output metadata. Both lists empty means "any file accepted".
| Name |
Type |
Description |
Required |
| extensions |
[ string ] |
|
No |
| mime_types |
[ string ] |
|
No |
DeclaredOutputRetryConfig
Per-output retry configuration that mirrors graphon.RetryConfig shape.
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| max_retries |
integer |
|
No |
| retry_interval_ms |
integer |
|
No |
DeclaredOutputType
| Name |
Type |
Description |
Required |
| DeclaredOutputType |
string |
|
|
DefaultBlockConfigQuery
| Name |
Type |
Description |
Required |
| q |
string |
|
No |
DefaultBlockConfigResponse
| Name |
Type |
Description |
Required |
| DefaultBlockConfigResponse |
object |
|
|
DefaultBlockConfigsResponse
| Name |
Type |
Description |
Required |
| DefaultBlockConfigsResponse |
array |
|
|
DefaultModelDataResponse
DefaultModelResponse
Default model entity.
DeletedTool
| Name |
Type |
Description |
Required |
| provider_id |
string |
|
Yes |
| tool_name |
string |
|
Yes |
| type |
string |
|
Yes |
DeploymentEdition
Enum representing the deployment edition of the platform.
| Name |
Type |
Description |
Required |
| DeploymentEdition |
string |
Enum representing the deployment edition of the platform. |
|
DismissNotificationPayload
| Name |
Type |
Description |
Required |
| notification_id |
string |
|
Yes |
DocumentAlreadyFinishedError
The document has been processed. Please refresh the page or go to the document details.
| Name |
Type |
Description |
Required |
| DocumentAlreadyFinishedError |
|
The document has been processed. Please refresh the page or go to the document details. |
|
DocumentBatchDownloadZipPayload
Request payload for bulk downloading documents as a zip archive.
| Name |
Type |
Description |
Required |
| document_ids |
[ string (uuid) ] |
List of document IDs to include in the ZIP download. |
Yes |
DocumentDetailResponse
| Name |
Type |
Description |
Required |
| archived |
boolean |
|
No |
| average_segment_length |
number |
|
No |
| completed_at |
integer |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| created_from |
string |
|
No |
| data_source_detail_dict |
|
|
No |
| data_source_info |
|
|
No |
| data_source_type |
string |
|
No |
| dataset_process_rule |
|
|
No |
| dataset_process_rule_id |
string |
|
No |
| disabled_at |
integer |
|
No |
| disabled_by |
string |
|
No |
| display_status |
string |
|
No |
| doc_form |
string |
|
No |
| doc_language |
string |
|
No |
| doc_metadata |
[ DocumentMetadataResponse ] |
|
No |
| doc_type |
string |
|
No |
| document_process_rule |
|
|
No |
| enabled |
boolean |
|
No |
| error |
string |
|
No |
| hit_count |
integer |
|
No |
| id |
string |
|
Yes |
| indexing_latency |
number |
|
No |
| indexing_status |
string |
|
No |
| name |
string |
|
No |
| need_summary |
boolean |
|
No |
| position |
integer |
|
No |
| segment_count |
integer |
|
No |
| tokens |
integer |
|
No |
| updated_at |
integer |
|
No |
DocumentIndexingError
The document is being processed and cannot be edited.
| Name |
Type |
Description |
Required |
| DocumentIndexingError |
|
The document is being processed and cannot be edited. |
|
DocumentMetadataOperation
| Name |
Type |
Description |
Required |
| document_id |
string (uuid) |
Document ID whose metadata should be updated. |
Yes |
| metadata_list |
[ MetadataDetail ] |
Metadata fields to update. |
Yes |
| partial_update |
boolean |
Whether to partially update metadata, keeping existing values for unspecified fields. |
No |
DocumentMetadataResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
| value |
string
integer
number
boolean |
|
No |
DocumentMetadataUpdatePayload
| Name |
Type |
Description |
Required |
| doc_metadata |
|
|
No |
| doc_type |
string |
|
No |
DocumentPipelineExecutionLogResponse
| Name |
Type |
Description |
Required |
| datasource_info |
JsonValue |
|
No |
| datasource_node_id |
string |
|
No |
| datasource_type |
string |
|
No |
| input_data |
JsonValue |
|
No |
DocumentRenamePayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
DocumentResponse
| Name |
Type |
Description |
Required |
| archived |
boolean |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| created_from |
string |
|
No |
| data_source_detail_dict |
object |
|
Yes |
| data_source_info |
object |
|
No |
| data_source_type |
string |
|
No |
| dataset_process_rule_id |
string |
|
No |
| disabled_at |
integer |
|
No |
| disabled_by |
string |
|
No |
| display_status |
string |
|
No |
| doc_form |
string |
|
No |
| doc_metadata |
[ DocumentMetadataResponse ] |
|
No |
| enabled |
boolean |
|
No |
| error |
string |
|
No |
| hit_count |
integer |
|
No |
| id |
string |
|
Yes |
| indexing_status |
string |
|
No |
| name |
string |
|
Yes |
| need_summary |
boolean |
|
No |
| position |
integer |
|
No |
| summary_index_status |
string |
|
No |
| tokens |
integer |
|
No |
| word_count |
integer |
|
No |
DocumentRetryPayload
| Name |
Type |
Description |
Required |
| document_ids |
[ string ] |
|
Yes |
DocumentStatusListResponse
DocumentStatusResponse
| Name |
Type |
Description |
Required |
| cleaning_completed_at |
integer |
|
Yes |
| completed_at |
integer |
|
Yes |
| completed_segments |
integer |
|
No |
| error |
string |
|
Yes |
| id |
string |
|
Yes |
| indexing_status |
string |
|
Yes |
| parsing_completed_at |
integer |
|
Yes |
| paused_at |
integer |
|
Yes |
| processing_started_at |
integer |
|
Yes |
| splitting_completed_at |
integer |
|
Yes |
| stopped_at |
integer |
|
Yes |
| total_segments |
integer |
|
No |
DocumentSummaryStatusResponse
DocumentWithSegmentsListResponse
| Name |
Type |
Description |
Required |
| data |
[ DocumentWithSegmentsResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
DocumentWithSegmentsResponse
| Name |
Type |
Description |
Required |
| archived |
boolean |
|
No |
| completed_segments |
integer |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| created_from |
string |
|
No |
| data_source_detail_dict |
object |
|
Yes |
| data_source_info |
object |
|
No |
| data_source_type |
string |
|
No |
| dataset_process_rule_id |
string |
|
No |
| disabled_at |
integer |
|
No |
| disabled_by |
string |
|
No |
| display_status |
string |
|
No |
| doc_form |
string |
|
No |
| doc_metadata |
[ DocumentMetadataResponse ] |
|
No |
| enabled |
boolean |
|
No |
| error |
string |
|
No |
| hit_count |
integer |
|
No |
| id |
string |
|
Yes |
| indexing_status |
string |
|
No |
| name |
string |
|
Yes |
| need_summary |
boolean |
|
No |
| position |
integer |
|
No |
| process_rule_dict |
|
|
No |
| summary_index_status |
string |
|
No |
| tokens |
integer |
|
No |
| total_segments |
integer |
|
No |
| word_count |
integer |
|
No |
DraftWorkflowNodeRunPayload
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
| query |
string |
|
No |
DraftWorkflowNotExistError
Draft workflow need to be initialized.
| Name |
Type |
Description |
Required |
| DraftWorkflowNotExistError |
|
Draft workflow need to be initialized. |
|
DraftWorkflowNotSyncError
Workflow graph might have been modified, please refresh and resubmit.
| Name |
Type |
Description |
Required |
| DraftWorkflowNotSyncError |
|
Workflow graph might have been modified, please refresh and resubmit. |
|
DraftWorkflowRunPayload
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
DraftWorkflowSyncPayload
| Name |
Type |
Description |
Required |
| conversation_variables |
[ object ] |
|
No |
| environment_variables |
[ object ] |
|
No |
| features |
object |
|
No |
| graph |
object |
|
Yes |
| hash |
string |
|
No |
| rag_pipeline_variables |
[ object ] |
|
No |
DraftWorkflowTriggerRunAllPayload
| Name |
Type |
Description |
Required |
| node_ids |
[ string ] |
|
Yes |
DraftWorkflowTriggerRunPayload
| Name |
Type |
Description |
Required |
| node_id |
string |
|
Yes |
DslImportWarning
Portable DSL reference that could not be restored in the target workspace.
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| details |
object |
|
No |
| message |
string |
|
Yes |
| path |
string |
|
Yes |
EducationActivateLimitError
Rate limit exceeded
| Name |
Type |
Description |
Required |
| EducationActivateLimitError |
|
Rate limit exceeded |
|
EducationActivatePayload
| Name |
Type |
Description |
Required |
| institution |
string |
|
Yes |
| role |
string |
|
Yes |
| token |
string |
|
Yes |
EducationActivateResponse
| Name |
Type |
Description |
Required |
| message |
string |
|
Yes |
EducationAutocompleteQuery
| Name |
Type |
Description |
Required |
| keywords |
string |
|
Yes |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer |
|
No |
EducationAutocompleteResponse
| Name |
Type |
Description |
Required |
| curr_page |
integer |
|
No |
| data |
[ string ] |
|
No |
| has_next |
boolean |
|
No |
EducationModel
| Name |
Type |
Description |
Required |
| activated |
boolean |
|
Yes |
| enabled |
boolean |
|
Yes |
EducationStatusResponse
| Name |
Type |
Description |
Required |
| allow_refresh |
boolean |
|
No |
| expire_at |
integer |
|
No |
| is_student |
boolean |
|
No |
| result |
boolean |
|
No |
EducationVerifyLimitError
Rate limit exceeded
| Name |
Type |
Description |
Required |
| EducationVerifyLimitError |
|
Rate limit exceeded |
|
EducationVerifyResponse
| Name |
Type |
Description |
Required |
| token |
string |
|
No |
EmailAlreadyInUseError
A user with this email already exists.
| Name |
Type |
Description |
Required |
| EmailAlreadyInUseError |
|
A user with this email already exists. |
|
EmailChangeLimitError
Too many failed email change attempts. Please try again in 24 hours.
| Name |
Type |
Description |
Required |
| EmailChangeLimitError |
|
Too many failed email change attempts. Please try again in 24 hours. |
|
EmailChangeRateLimitExceededError
Too many email change emails have been sent. Please try again in {minutes} minutes.
| Name |
Type |
Description |
Required |
| EmailChangeRateLimitExceededError |
|
Too many email change emails have been sent. Please try again in {minutes} minutes. |
|
EmailCodeAccountDeletionRateLimitExceededError
Too many account deletion emails have been sent. Please try again in {minutes} minutes.
| Name |
Type |
Description |
Required |
| EmailCodeAccountDeletionRateLimitExceededError |
|
Too many account deletion emails have been sent. Please try again in {minutes} minutes. |
|
EmailCodeError
Email code is invalid or expired.
| Name |
Type |
Description |
Required |
| EmailCodeError |
|
Email code is invalid or expired. |
|
EmailCodeLoginLimitError
Too many incorrect password attempts. Please try again later.
| Name |
Type |
Description |
Required |
| EmailCodeLoginLimitError |
|
Too many incorrect password attempts. Please try again later. |
|
EmailCodeLoginPayload
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| email |
string |
|
Yes |
| language |
string |
|
No |
| timezone |
string |
|
No |
| token |
string (uuid) |
|
Yes |
| turnstile_token |
string |
Cloudflare Turnstile token for email-code verification. |
No |
EmailCodeLoginRateLimitExceededError
Too many login emails have been sent. Please try again in {minutes} minutes.
| Name |
Type |
Description |
Required |
| EmailCodeLoginRateLimitExceededError |
|
Too many login emails have been sent. Please try again in {minutes} minutes. |
|
EmailCodeLoginServiceUnavailableError
Email code verification is temporarily unavailable. Please try again later.
| Name |
Type |
Description |
Required |
| EmailCodeLoginServiceUnavailableError |
|
Email code verification is temporarily unavailable. Please try again later. |
|
EmailCodeSendPayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| language |
string |
|
No |
| turnstile_token |
string |
Cloudflare Turnstile token. Required at runtime for Dify Cloud. |
No |
EmailDomainSuspendedError
This email domain has been suspended.
| Name |
Type |
Description |
Required |
| EmailDomainSuspendedError |
|
This email domain has been suspended. |
|
EmailPasswordResetLimitError
Too many failed password reset attempts. Please try again in 24 hours.
| Name |
Type |
Description |
Required |
| EmailPasswordResetLimitError |
|
Too many failed password reset attempts. Please try again in 24 hours. |
|
EmailPayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| language |
string |
|
No |
EmailRegisterLimitError
Too many failed email register attempts. Please try again in 24 hours.
| Name |
Type |
Description |
Required |
| EmailRegisterLimitError |
|
Too many failed email register attempts. Please try again in 24 hours. |
|
EmailRegisterRateLimitExceededError
Too many email register emails have been sent. Please try again in {minutes} minutes.
| Name |
Type |
Description |
Required |
| EmailRegisterRateLimitExceededError |
|
Too many email register emails have been sent. Please try again in {minutes} minutes. |
|
EmailRegisterResetPayload
| Name |
Type |
Description |
Required |
| language |
string |
|
No |
| new_password |
string |
|
Yes |
| password_confirm |
string |
|
Yes |
| timezone |
string |
|
No |
| token |
string |
|
Yes |
EmailRegisterResetResponse
EmailRegisterSendPayload
| Name |
Type |
Description |
Required |
| email |
string |
Email address |
Yes |
| language |
string |
Language code |
No |
EmailRegisterTokenPairResponse
| Name |
Type |
Description |
Required |
| access_token |
string |
|
Yes |
| csrf_token |
string |
|
Yes |
| refresh_token |
string |
|
Yes |
EmailRegisterValidityPayload
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| email |
string |
|
Yes |
| token |
string |
|
Yes |
EmailSendIpLimitError
Too many emails have been sent from this IP address recently. Please try again later.
| Name |
Type |
Description |
Required |
| EmailSendIpLimitError |
|
Too many emails have been sent from this IP address recently. Please try again later. |
|
EmptyObjectResponse
| Name |
Type |
Description |
Required |
| EmptyObjectResponse |
object |
|
|
Endpoint
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
EndpointCreatePayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| settings |
object |
|
Yes |
EndpointDeclaration
declaration of an endpoint
| Name |
Type |
Description |
Required |
| hidden |
boolean |
|
No |
| method |
string |
|
Yes |
| path |
string |
|
Yes |
EndpointDeclarationResponse
| Name |
Type |
Description |
Required |
| hidden |
boolean |
|
No |
| method |
string |
|
Yes |
| path |
string |
|
Yes |
EndpointIdPayload
| Name |
Type |
Description |
Required |
| endpoint_id |
string |
|
Yes |
EndpointListForPluginQuery
| Name |
Type |
Description |
Required |
| page |
integer |
|
Yes |
| page_size |
integer |
|
Yes |
| plugin_id |
string |
|
Yes |
EndpointListItemResponse
| Name |
Type |
Description |
Required |
| created_at |
dateTime |
|
Yes |
| declaration |
EndpointProviderDeclarationResponse |
|
No |
| enabled |
boolean |
|
Yes |
| expired_at |
dateTime |
|
Yes |
| hook_id |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| settings |
object |
|
Yes |
| tenant_id |
string |
|
Yes |
| updated_at |
dateTime |
|
Yes |
| url |
string |
|
Yes |
EndpointListQuery
| Name |
Type |
Description |
Required |
| page |
integer |
|
Yes |
| page_size |
integer |
|
Yes |
EndpointListResponse
EndpointMutationResponse
| Name |
Type |
Description |
Required |
| success |
boolean |
Always true on success. Failures are returned as HTTP errors. |
Yes |
EndpointProviderConfigI18nResponse
| Name |
Type |
Description |
Required |
| en_US |
string |
|
Yes |
| ja_JP |
string |
|
No |
| pt_BR |
string |
|
No |
| zh_Hans |
string |
|
No |
EndpointProviderConfigOptionResponse
EndpointProviderConfigResponse
EndpointProviderConfigScope
| Name |
Type |
Description |
Required |
| EndpointProviderConfigScope |
string |
|
|
EndpointProviderDeclaration
declaration of an endpoint group
EndpointProviderDeclarationResponse
EndpointSettingsPayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
| settings |
object |
|
Yes |
EndpointUpdatePayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
| settings |
object |
|
Yes |
EnvironmentVariableItemPayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| id |
string |
|
No |
| name |
string |
|
No |
| value |
|
|
No |
| value_type |
string |
|
No |
EnvironmentVariableItemResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| editable |
boolean |
|
Yes |
| edited |
boolean |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| selector |
[ string ] |
|
Yes |
| type |
string |
|
Yes |
| value |
|
|
Yes |
| value_type |
string |
|
Yes |
| visible |
boolean |
|
Yes |
EnvironmentVariableListResponse
EnvironmentVariableUpdatePayload
| Name |
Type |
Description |
Required |
| deleted_environment_variable_ids |
[ string ] |
Environment variable IDs to delete when patch is true |
No |
| environment_variables |
[ EnvironmentVariableItemPayload ] |
Environment variables for the draft workflow |
Yes |
| patch |
boolean |
Treat environment_variables as per-ID upserts instead of replacing the full collection |
No |
ErrorDocsResponse
ErrorMessageResponse
Legacy {"error": message} body a few endpoints return instead of the standard error body.
| Name |
Type |
Description |
Required |
| error |
string |
|
Yes |
ErrorResponse
Documented non-2xx body emitted by register_external_error_handlers.
params and details appear only on the errors that set them. The schema
stays open because HTTPException.data may carry extra keys.
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| details |
object |
|
No |
| message |
string |
|
Yes |
| params |
string |
|
No |
| status |
integer |
|
Yes |
EventApiEntity
| Name |
Type |
Description |
Required |
| description |
I18nObject |
The description of the trigger |
Yes |
| identity |
EventIdentity |
The identity of the trigger |
Yes |
| name |
string |
The name of the trigger |
Yes |
| output_schema |
object |
The output schema of the trigger |
Yes |
| parameters |
[ EventParameter ] |
The parameters of the trigger |
Yes |
EventEntity
The configuration of an event
| Name |
Type |
Description |
Required |
| description |
I18nObject |
The description of the event |
Yes |
| identity |
EventIdentity |
|
Yes |
| output_schema |
object |
The output schema that this event produces |
No |
| parameters |
[ EventParameter ] |
The parameters of the event |
No |
EventIdentity
The identity of the event
| Name |
Type |
Description |
Required |
| author |
string |
The author of the event |
Yes |
| label |
I18nObject |
The label of the event |
Yes |
| name |
string |
The name of the event |
Yes |
| provider |
string |
The provider of the event |
No |
EventParameter
The parameter of the event
| Name |
Type |
Description |
Required |
| auto_generate |
PluginParameterAutoGenerate |
The auto generate of the parameter |
No |
| default |
integer
number
string
[ object ] |
|
No |
| description |
I18nObject |
|
No |
| label |
I18nObject |
The label presented to the user |
Yes |
| max |
number
integer |
|
No |
| min |
number
integer |
|
No |
| multiple |
boolean |
Whether the parameter is multiple select, only valid for select or dynamic-select type |
No |
| name |
string |
The name of the parameter |
Yes |
| options |
[ PluginParameterOption ] |
|
No |
| precision |
integer |
|
No |
| required |
boolean |
|
No |
| scope |
string |
|
No |
| template |
PluginParameterTemplate |
The template of the parameter |
No |
| type |
EventParameterType |
|
Yes |
EventParameterType
The type of the parameter
| Name |
Type |
Description |
Required |
| EventParameterType |
string |
The type of the parameter |
|
EventStreamResponse
| Name |
Type |
Description |
Required |
| EventStreamResponse |
string |
|
|
ExecutionContentType
| Name |
Type |
Description |
Required |
| ExecutionContentType |
string |
|
|
ExploreAppMetaResponse
Metadata consumed by the installed-app chat UI.
Built-in tool icons are URL strings; API-based tool icons are provider-defined payload objects.
| Name |
Type |
Description |
Required |
| tool_icons |
object |
|
No |
ExploreMessageListItem
| Name |
Type |
Description |
Required |
| agent_thoughts |
[ AgentThought ] |
|
Yes |
| answer |
string |
|
Yes |
| answer_tokens |
integer |
|
No |
| conversation_id |
string (uuid) |
|
Yes |
| created_at |
integer |
|
No |
| currency |
string |
|
No |
| error |
string |
|
No |
| extra_contents |
[ HumanInputContent ] |
|
Yes |
| feedback |
SimpleFeedback |
|
No |
| id |
string (uuid) |
|
Yes |
| inputs |
object |
|
Yes |
| message_files |
[ MessageFile ] |
|
Yes |
| message_tokens |
integer |
|
No |
| metadata |
JSONValueType |
|
No |
| parent_message_id |
string |
|
No |
| provider_response_latency |
float |
|
No |
| query |
string |
|
Yes |
| retriever_resources |
[ RetrieverResource ] |
|
Yes |
| status |
string |
|
Yes |
| total_price |
string |
|
No |
| total_tokens |
integer |
|
Yes |
ExternalApiTemplateListQuery
| Name |
Type |
Description |
Required |
| keyword |
string |
Search keyword |
No |
| limit |
integer,
Default: 20 |
Number of items per page |
No |
| page |
integer,
Default: 1 |
Page number |
No |
ExternalDatasetCreatePayload
Validated fields required to create an external dataset binding.
The console controller owns HTTP concerns, but the service also needs this
contract when creating the tenant-scoped dataset and external knowledge
binding. Keep it outside controllers so service imports do not depend on
Flask blueprint initialization.
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| external_knowledge_api_id |
string |
|
Yes |
| external_knowledge_id |
string |
|
Yes |
| external_retrieval_model |
object |
|
No |
| name |
string |
|
Yes |
ExternalHitTestingPayload
| Name |
Type |
Description |
Required |
| external_retrieval_model |
object |
|
No |
| metadata_filtering_conditions |
object |
|
No |
| query |
string |
|
Yes |
ExternalHitTestingQueryResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
ExternalHitTestingRecordResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| metadata |
object |
|
No |
| score |
number |
|
No |
| title |
string |
|
No |
ExternalHitTestingResponse
ExternalKnowledgeApiBindingResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
ExternalKnowledgeApiListResponse
| Name |
Type |
Description |
Required |
| data |
[ ExternalKnowledgeApiResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
ExternalKnowledgeApiPayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
| settings |
object |
|
Yes |
ExternalKnowledgeApiResponse
| Name |
Type |
Description |
Required |
| created_at |
string |
|
Yes |
| created_by |
string |
|
Yes |
| dataset_bindings |
[ ExternalKnowledgeApiBindingResponse ] |
|
Yes |
| description |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| settings |
object |
|
Yes |
| tenant_id |
string |
|
Yes |
FeatureModel
Effective feature availability and limits for the current workspace.
Feedback
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| from_account |
SimpleAccount |
|
No |
| from_end_user_id |
string |
|
No |
| from_source |
string |
|
Yes |
| rating |
string |
|
Yes |
FeedbackStat
| Name |
Type |
Description |
Required |
| dislike |
integer |
|
Yes |
| like |
integer |
|
Yes |
FetchFrom
Enum class for fetch from.
| Name |
Type |
Description |
Required |
| FetchFrom |
string |
Enum class for fetch from. |
|
FieldModelSchema
FileExtensionBlockedError
The file extension is blocked for security reasons.
| Name |
Type |
Description |
Required |
| FileExtensionBlockedError |
|
The file extension is blocked for security reasons. |
|
FileInfo
| Name |
Type |
Description |
Required |
| extension |
string |
|
Yes |
| filename |
string |
|
Yes |
| mimetype |
string |
|
Yes |
| size |
integer |
|
Yes |
FileInputConfig
| Name |
Type |
Description |
Required |
| allowed_file_extensions |
[ string ] |
|
No |
| allowed_file_types |
[ FileType ] |
|
No |
| allowed_file_upload_methods |
[ FileTransferMethod ] |
|
No |
| output_variable_name |
string |
|
Yes |
| type |
string |
|
No |
FileListInputConfig
| Name |
Type |
Description |
Required |
| allowed_file_extensions |
[ string ] |
|
No |
| allowed_file_types |
[ FileType ] |
|
No |
| allowed_file_upload_methods |
[ FileTransferMethod ] |
|
No |
| number_limits |
integer |
|
No |
| output_variable_name |
string |
|
Yes |
| type |
string |
|
No |
FileResponse
| Name |
Type |
Description |
Required |
| conversation_id |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| extension |
string |
|
No |
| file_key |
string |
|
No |
| id |
string (uuid) |
|
Yes |
| mime_type |
string |
|
No |
| name |
string |
|
Yes |
| original_url |
string |
|
No |
| preview_url |
string |
|
No |
| reference |
string |
|
No |
| size |
integer |
|
Yes |
| source_url |
string |
|
No |
| tenant_id |
string |
|
No |
| user_id |
string |
|
No |
FileTooLargeError
File size exceeded. {message}
| Name |
Type |
Description |
Required |
| FileTooLargeError |
|
File size exceeded. {message} |
|
FileTransferMethod
| Name |
Type |
Description |
Required |
| FileTransferMethod |
string |
|
|
FileType
| Name |
Type |
Description |
Required |
| FileType |
string |
|
|
FileWithSignedUrl
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| extension |
string |
|
Yes |
| id |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| name |
string |
|
Yes |
| size |
integer |
|
Yes |
| url |
string |
|
Yes |
FilenameMissingError
filename is required
| Name |
Type |
Description |
Required |
| FilenameMissingError |
|
filename is required |
|
FilenameNotExistsError
The specified filename does not exist.
| Name |
Type |
Description |
Required |
| FilenameNotExistsError |
|
The specified filename does not exist. |
|
ForbiddenError
You don't have the permission to access the requested resource.
| Name |
Type |
Description |
Required |
| ForbiddenError |
|
You don't have the permission to access the requested resource. |
|
ForgotPasswordCheckPayload
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| email |
string |
|
Yes |
| token |
string |
|
Yes |
ForgotPasswordCheckResponse
| Name |
Type |
Description |
Required |
| email |
string |
Email address |
Yes |
| is_valid |
boolean |
Whether code is valid |
Yes |
| token |
string |
New reset token |
Yes |
ForgotPasswordEmailResponse
| Name |
Type |
Description |
Required |
| data |
string |
Reset token |
No |
| result |
string |
Operation result |
Yes |
ForgotPasswordResetPayload
| Name |
Type |
Description |
Required |
| new_password |
string |
|
Yes |
| password_confirm |
string |
|
Yes |
| token |
string |
|
Yes |
ForgotPasswordResetResponse
| Name |
Type |
Description |
Required |
| result |
string |
Operation result |
Yes |
ForgotPasswordSendPayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| language |
string |
|
No |
FormInputConfig
FormOption
Model class for form option.
FormShowOnObject
Model class for form show on.
| Name |
Type |
Description |
Required |
| value |
string |
|
Yes |
| variable |
string |
|
Yes |
FormType
Enum class for form type.
| Name |
Type |
Description |
Required |
| FormType |
string |
Enum class for form type. |
|
GenerateSummaryPayload
| Name |
Type |
Description |
Required |
| document_list |
[ string ] |
|
Yes |
GeneratedAppResponse
| Name |
Type |
Description |
Required |
| GeneratedAppResponse |
|
|
|
GeneratorResponse
| Name |
Type |
Description |
Required |
| GeneratorResponse |
|
|
|
HitTestingChildChunk
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
| id |
string |
|
Yes |
| position |
integer |
|
Yes |
| score |
number |
|
Yes |
HitTestingDocument
| Name |
Type |
Description |
Required |
| data_source_type |
string |
|
Yes |
| doc_metadata |
|
|
Yes |
| doc_type |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
HitTestingFile
| Name |
Type |
Description |
Required |
| extension |
string |
|
Yes |
| id |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| name |
string |
|
Yes |
| size |
integer |
|
Yes |
| source_url |
string |
|
Yes |
HitTestingPayload
| Name |
Type |
Description |
Required |
| attachment_ids |
[ string ] |
List of attachment IDs to include in the retrieval context. |
No |
| external_retrieval_model |
object |
Retrieval settings for external knowledge bases. |
No |
| query |
string |
Search query text. |
Yes |
| retrieval_model |
RetrievalModel |
Retrieval model configuration. Controls how chunks are searched and ranked when querying this knowledge base. |
No |
HitTestingQuery
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
HitTestingRecord
HitTestingResponse
HitTestingSegment
| Name |
Type |
Description |
Required |
| answer |
string |
|
Yes |
| completed_at |
integer |
|
Yes |
| content |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| disabled_at |
integer |
|
Yes |
| disabled_by |
string |
|
Yes |
| document |
HitTestingDocument |
Parent document information for the matched chunk. |
Yes |
| document_id |
string |
|
Yes |
| enabled |
boolean |
|
Yes |
| error |
string |
|
Yes |
| hit_count |
integer |
|
Yes |
| id |
string |
|
Yes |
| index_node_hash |
string |
|
Yes |
| index_node_id |
string |
|
Yes |
| indexing_at |
integer |
|
Yes |
| keywords |
[ string ] |
|
Yes |
| position |
integer |
|
Yes |
| sign_content |
string |
|
Yes |
| status |
string |
|
Yes |
| stopped_at |
integer |
|
Yes |
| tokens |
integer |
|
Yes |
| word_count |
integer |
|
Yes |
HumanInputContent
HumanInputDeliveryTestPayload
| Name |
Type |
Description |
Required |
| delivery_method_id |
string |
Delivery method ID |
Yes |
| inputs |
object |
Values used to fill missing upstream variables referenced in form_content |
No |
HumanInputFormDefinition
| Name |
Type |
Description |
Required |
| actions |
[ UserActionConfig ] |
|
No |
| display_in_ui |
boolean |
|
No |
| expiration_time |
integer |
|
Yes |
| form_content |
string |
|
Yes |
| form_id |
string |
|
Yes |
| form_token |
string |
|
No |
| inputs |
[ FormInputConfig ] |
|
No |
| node_id |
string |
|
Yes |
| node_title |
string |
|
Yes |
| resolved_default_values |
object |
|
No |
HumanInputFormExpiredError
| Name |
Type |
Description |
Required |
| HumanInputFormExpiredError |
|
|
|
HumanInputFormPreviewPayload
| Name |
Type |
Description |
Required |
| inputs |
object |
Values used to fill missing upstream variables referenced in form_content |
No |
HumanInputFormPreviewResponse
| Name |
Type |
Description |
Required |
| actions |
[ object ] |
|
No |
| display_in_ui |
boolean |
|
No |
| expiration_time |
integer |
|
No |
| form_content |
string |
|
Yes |
| form_id |
string |
|
Yes |
| form_token |
string |
|
No |
| inputs |
[ object ] |
|
No |
| node_id |
string |
|
Yes |
| node_title |
string |
|
Yes |
| resolved_default_values |
object |
|
No |
HumanInputFormPreviewSubmitPayload
| Name |
Type |
Description |
Required |
| action |
string |
Selected action ID |
Yes |
| form_inputs |
object |
Values the user provides for the form's own fields |
Yes |
| inputs |
object |
Values used to fill missing upstream variables referenced in form_content |
Yes |
HumanInputFormSubmissionData
| Name |
Type |
Description |
Required |
| action_id |
string |
|
Yes |
| action_text |
string |
|
Yes |
| node_id |
string |
|
Yes |
| node_title |
string |
|
Yes |
| rendered_content |
string |
|
Yes |
| submitted_data |
object |
|
No |
HumanInputFormSubmitPayload
| Name |
Type |
Description |
Required |
| action |
string |
ID of the action button the recipient selected. Must match one of the id values from the form's user_actions list. |
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 |
HumanInputFormSubmitResponse
| Name |
Type |
Description |
Required |
| HumanInputFormSubmitResponse |
object |
|
|
HumanInputFormSubmittedError
This form has already been submitted by another user, form_id={form_id}
| Name |
Type |
Description |
Required |
| HumanInputFormSubmittedError |
|
This form has already been submitted by another user, form_id={form_id} |
|
HumanInputPauseTypeResponse
| Name |
Type |
Description |
Required |
| backstage_input_url |
string |
|
No |
| form_id |
string |
|
Yes |
| type |
string |
|
Yes |
I18nObject
Model class for i18n object.
| Name |
Type |
Description |
Required |
| en_US |
string |
|
Yes |
| ja_JP |
string |
|
No |
| pt_BR |
string |
|
No |
| zh_Hans |
string |
|
No |
IconInfo
Icon information model.
| Name |
Type |
Description |
Required |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string,
Available values: "emoji", "image" |
|
No |
| icon_url |
string |
|
No |
IconType
| Name |
Type |
Description |
Required |
| IconType |
string |
|
|
IdentityMode
How Dify forwards the end-user's identity to an MCP server.
| Name |
Type |
Description |
Required |
| IdentityMode |
string |
How Dify forwards the end-user's identity to an MCP server. |
|
Import
| Name |
Type |
Description |
Required |
| app_id |
string |
|
No |
| app_mode |
AppMode |
|
No |
| current_dsl_version |
string,
Default: 0.7.0 |
|
No |
| error |
string |
|
No |
| id |
string |
|
Yes |
| imported_dsl_version |
string |
|
No |
| permission_keys |
[ string ] |
|
No |
| status |
ImportStatus |
|
Yes |
| warnings |
[ DslImportWarning ] |
|
No |
ImportStatus
| Name |
Type |
Description |
Required |
| ImportStatus |
string |
|
|
IncludeSecretQuery
| Name |
Type |
Description |
Required |
| include_secret |
string,
Default: false |
Whether to include secret values in the exported DSL |
No |
IndexingEstimate
IndexingEstimateError
Knowledge indexing estimate failed: {message}
| Name |
Type |
Description |
Required |
| IndexingEstimateError |
|
Knowledge indexing estimate failed: {message} |
|
IndexingEstimatePayload
| Name |
Type |
Description |
Required |
| dataset_id |
string |
|
No |
| doc_form |
string,
Default: text_model |
|
No |
| doc_language |
string,
Default: English |
|
No |
| indexing_technique |
string |
|
Yes |
| info_list |
object |
|
Yes |
| process_rule |
object |
|
Yes |
IndexingEstimateResponse
| Name |
Type |
Description |
Required |
| currency |
string |
|
Yes |
| preview |
[ PreviewDetail ] |
|
Yes |
| qa_preview |
[ QAPreviewDetail ] |
|
No |
| tokens |
integer |
|
Yes |
| total_price |
number
integer |
|
Yes |
| total_segments |
integer |
|
Yes |
InfoList
| Name |
Type |
Description |
Required |
| data_source_type |
string,
Available values: "notion_import", "upload_file", "website_crawl" |
Enum: "notion_import", "upload_file", "website_crawl" |
Yes |
| file_info_list |
KnowledgeFileInfo |
|
No |
| notion_info_list |
[ NotionInfo ] |
|
No |
| website_info_list |
WebsiteInfo |
|
No |
Inner
| Name |
Type |
Description |
Required |
| model |
string |
|
No |
| model_type |
ModelType |
|
Yes |
| provider |
string |
|
No |
InputFieldDefinition
Input field definition for snippet parameters.
| Name |
Type |
Description |
Required |
| default |
string |
|
No |
| hint |
boolean |
|
No |
| label |
string |
|
No |
| max_length |
integer |
|
No |
| options |
[ string ] |
|
No |
| placeholder |
string |
|
No |
| required |
boolean |
|
No |
| type |
string |
|
No |
InspectorUnavailableError
Sandbox inspector is unavailable.
| Name |
Type |
Description |
Required |
| InspectorUnavailableError |
|
Sandbox inspector is unavailable. |
|
InstalledAppInfoResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| icon |
string |
|
Yes |
| icon_background |
string |
|
Yes |
| icon_type |
IconType |
|
Yes |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| mode |
AppMode |
|
Yes |
| name |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
InstalledAppListResponse
| Name |
Type |
Description |
Required |
| has_more |
boolean |
|
Yes |
| installed_apps |
[ InstalledAppResponse ] |
|
Yes |
| next_cursor |
string |
|
Yes |
InstalledAppNotFoundError
The app was not found in this workspace.
| Name |
Type |
Description |
Required |
| InstalledAppNotFoundError |
|
The app was not found in this workspace. |
|
InstalledAppResponse
| Name |
Type |
Description |
Required |
| app |
InstalledAppInfoResponse |
|
Yes |
| app_owner_tenant_id |
string |
|
Yes |
| editable |
boolean |
|
Yes |
| id |
string |
|
Yes |
| is_pinned |
boolean |
|
Yes |
| last_used_at |
integer |
|
Yes |
InstalledAppUnavailableError
The app is not available in this app library.
| Name |
Type |
Description |
Required |
| InstalledAppUnavailableError |
|
The app is not available in this app library. |
|
InstalledAppUpdatePayload
| Name |
Type |
Description |
Required |
| is_pinned |
boolean |
|
No |
InstalledAppsListQuery
| Name |
Type |
Description |
Required |
| app_id |
string |
App ID to filter by |
No |
| cursor |
string |
Opaque cursor returned by the previous page |
No |
| limit |
integer,
Default: 20 |
Number of installed apps to return |
No |
| name |
string |
App name to search for |
No |
InstructionGeneratePayload
| Name |
Type |
Description |
Required |
| current |
string |
Current instruction text |
No |
| flow_id |
string |
Workflow/Flow ID |
Yes |
| ideal_output |
string |
Expected ideal output |
No |
| instruction |
string |
Instruction for generation |
Yes |
| language |
string,
Default: javascript |
Programming language (javascript/python) |
No |
| model_config |
ModelConfig |
Model configuration |
Yes |
| node_id |
string |
Node ID for workflow context |
No |
InstructionTemplatePayload
| Name |
Type |
Description |
Required |
| type |
string |
Instruction template type |
Yes |
InvalidAccountDeletionCodeError
Invalid account deletion code.
| Name |
Type |
Description |
Required |
| InvalidAccountDeletionCodeError |
|
Invalid account deletion code. |
|
InvalidAccountPasswordError
The password does not satisfy the account password policy.
| Name |
Type |
Description |
Required |
| InvalidAccountPasswordError |
|
The password does not satisfy the account password policy. |
|
InvalidActionError
Invalid action.
| Name |
Type |
Description |
Required |
| InvalidActionError |
|
Invalid action. |
|
InvalidComposerConfigError
Invalid agent composer config.
| Name |
Type |
Description |
Required |
| InvalidComposerConfigError |
|
Invalid agent composer config. |
|
InvalidCursorError
The app list cursor is invalid. Refresh the list and try again.
| Name |
Type |
Description |
Required |
| InvalidCursorError |
|
The app list cursor is invalid. Refresh the list and try again. |
|
InvalidEmailError
The email address is not valid.
| Name |
Type |
Description |
Required |
| InvalidEmailError |
|
The email address is not valid. |
|
InvalidFormDataError
| Name |
Type |
Description |
Required |
| InvalidFormDataError |
|
|
|
InvalidInvitationCodeError
Invalid invitation code.
| Name |
Type |
Description |
Required |
| InvalidInvitationCodeError |
|
Invalid invitation code. |
|
InvalidMetadataError
The metadata content is incorrect. Please check and verify.
| Name |
Type |
Description |
Required |
| InvalidMetadataError |
|
The metadata content is incorrect. Please check and verify. |
|
InvalidOrExpiredTokenError
The token is invalid or has expired.
| Name |
Type |
Description |
Required |
| InvalidOrExpiredTokenError |
|
The token is invalid or has expired. |
|
InvalidRequestError
Invalid skill request.
| Name |
Type |
Description |
Required |
| InvalidRequestError |
|
Invalid skill request. |
|
InvalidRoleError
Invalid role.
| Name |
Type |
Description |
Required |
| InvalidRoleError |
|
Invalid role. |
|
InvalidRosterAgentPackageError
The Roster Agent package is invalid.
| Name |
Type |
Description |
Required |
| InvalidRosterAgentPackageError |
|
The Roster Agent package is invalid. |
|
InvalidTracingConfigError
The tracing configuration is invalid.
| Name |
Type |
Description |
Required |
| InvalidTracingConfigError |
|
The tracing configuration is invalid. |
|
InvitationAccountMismatchError
This invitation was sent to another account. Please sign in with the invited account.
| Name |
Type |
Description |
Required |
| InvitationAccountMismatchError |
|
This invitation was sent to another account. Please sign in with the invited account. |
|
IterationNodeRunPayload
| Name |
Type |
Description |
Required |
| inputs |
object |
|
No |
JSONValueType
| Name |
Type |
Description |
Required |
| JSONValueType |
|
|
|
JsonObject
| Name |
Type |
Description |
Required |
| JsonObject |
object |
|
|
JsonValue
| Name |
Type |
Description |
Required |
| JsonValue |
|
|
|
KnowledgeConfig
| Name |
Type |
Description |
Required |
| data_source |
DataSource |
Document data source configuration. |
No |
| doc_form |
string,
Available values: "hierarchical_model", "qa_model", "text_model",
Default: text_model |
text_model for standard text chunking, hierarchical_model for parent-child chunk structure, qa_model for question-answer pair extraction.
Enum: "hierarchical_model", "qa_model", "text_model" |
No |
| doc_language |
string,
Default: English |
Language of the document for processing optimization. |
No |
| duplicate |
boolean,
Default: true |
Whether duplicate document content is allowed. |
No |
| embedding_model |
string |
Embedding model name. Use the model field from Get Available Models with model_type=text-embedding. |
No |
| embedding_model_provider |
string |
Embedding model provider. Use the provider field from Get Available Models with model_type=text-embedding. |
No |
| indexing_technique |
string,
Available values: "economy", "high_quality" |
high_quality uses embedding models for precise search; economy uses keyword-based indexing. Required when adding the first document to a knowledge base; subsequent documents inherit the knowledge base's indexing technique if omitted.
Enum: "economy", "high_quality" |
Yes |
| is_multimodal |
boolean |
Whether the document uses multimodal indexing. |
No |
| name |
string |
Document name. |
No |
| original_document_id |
string |
Original document ID for replacement updates. |
No |
| process_rule |
ProcessRule |
Processing rules for chunking. |
No |
| retrieval_model |
RetrievalModel |
Retrieval model configuration. Controls how chunks are searched and ranked in this knowledge base. |
No |
| summary_index_setting |
object |
Summary index configuration. |
No |
KnowledgeFileInfo
| Name |
Type |
Description |
Required |
| file_ids |
[ string ] |
|
Yes |
KnowledgePipeline
| Name |
Type |
Description |
Required |
| publish_enabled |
boolean |
|
Yes |
LLMMode
Enum class for large language model mode.
| Name |
Type |
Description |
Required |
| LLMMode |
string |
Enum class for large language model mode. |
|
LatestPluginCache
| Name |
Type |
Description |
Required |
| alternative_plugin_id |
string |
|
Yes |
| deprecated_reason |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| status |
string,
Available values: "active", "deleted" |
Enum: "active", "deleted" |
Yes |
| unique_identifier |
string |
|
Yes |
| version |
string |
|
Yes |
LearnDifyAppListResponse
LegacyEndpointUpdatePayload
| Name |
Type |
Description |
Required |
| endpoint_id |
string |
|
Yes |
| name |
string |
|
Yes |
| settings |
object |
|
Yes |
LicenseLimitationModel
- enabled: whether this limit is enforced
- size: current usage count
- limit: maximum allowed count; 0 means unlimited
| Name |
Type |
Description |
Required |
| enabled |
boolean |
Whether this limit is currently active |
Yes |
| limit |
integer |
Maximum number of resources allowed; 0 means no limit |
Yes |
| size |
integer |
Number of resources already consumed |
Yes |
LicenseModel
LicenseStatus
| Name |
Type |
Description |
Required |
| LicenseStatus |
string |
|
|
LicenseStatusModel
LimitExceededError
Unable to create account because the licensed seats limit was exceeded
| Name |
Type |
Description |
Required |
| LimitExceededError |
|
Unable to create account because the licensed seats limit was exceeded |
|
LimitationModel
| Name |
Type |
Description |
Required |
| limit |
integer |
|
Yes |
| size |
integer |
|
Yes |
LoadBalancingCredentialPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
LoadBalancingCredentialValidateResponse
| Name |
Type |
Description |
Required |
| error |
string |
|
No |
| result |
string |
|
Yes |
LoadBalancingPayload
| Name |
Type |
Description |
Required |
| configs |
[ object ] |
|
No |
| enabled |
boolean |
|
No |
LoginPayload
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| invite_token |
string |
Invitation token |
No |
| password |
string |
|
Yes |
| remember_me |
boolean |
Remember me flag |
No |
LoopNodeRunPayload
| Name |
Type |
Description |
Required |
| inputs |
object |
|
No |
MCPAuthPayload
| Name |
Type |
Description |
Required |
| authorization_code |
string |
|
No |
| provider_id |
string |
|
Yes |
MCPAuthResponse
| Name |
Type |
Description |
Required |
| authorization_url |
string |
|
No |
| result |
string |
|
No |
MCPAuthentication
| Name |
Type |
Description |
Required |
| client_id |
string |
|
Yes |
| client_secret |
string |
|
No |
MCPCallbackQuery
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| state |
string |
|
Yes |
MCPConfiguration
| Name |
Type |
Description |
Required |
| sse_read_timeout |
number,
Default: 300 |
|
No |
| timeout |
number,
Default: 30 |
|
No |
MCPProviderCreatePayload
| Name |
Type |
Description |
Required |
| authentication |
MCPAuthentication |
|
No |
| configuration |
MCPConfiguration |
|
No |
| headers |
object |
|
No |
| icon |
string |
|
Yes |
| icon_background |
string |
|
No |
| icon_type |
string |
|
Yes |
| identity_mode |
IdentityMode |
|
No |
| name |
string |
|
Yes |
| server_identifier |
string |
|
Yes |
| server_url |
string |
|
Yes |
MCPProviderDeletePayload
| Name |
Type |
Description |
Required |
| provider_id |
string |
|
Yes |
MCPProviderUpdatePayload
| Name |
Type |
Description |
Required |
| authentication |
MCPAuthentication |
|
No |
| configuration |
MCPConfiguration |
|
No |
| headers |
object |
|
No |
| icon |
string |
|
Yes |
| icon_background |
string |
|
No |
| icon_type |
string |
|
Yes |
| identity_mode |
IdentityMode |
|
No |
| name |
string |
|
Yes |
| provider_id |
string |
|
Yes |
| server_identifier |
string |
|
Yes |
| server_url |
string |
|
Yes |
MCPServerCreatePayload
| Name |
Type |
Description |
Required |
| description |
string |
Server description |
No |
| parameters |
object |
Server parameters configuration |
Yes |
MCPServerUpdatePayload
| Name |
Type |
Description |
Required |
| description |
string |
Server description |
No |
| id |
string (uuid) |
Server ID |
Yes |
| parameters |
object |
Server parameters configuration |
Yes |
| status |
AppMCPServerStatus |
Server status |
No |
MaxKeysExceededError
The API key limit has been reached.
| Name |
Type |
Description |
Required |
| MaxKeysExceededError |
|
The API key limit has been reached. |
|
MemberActionResponse
| Name |
Type |
Description |
Required |
| result |
string |
|
Yes |
| tenant_id |
string |
|
Yes |
MemberBindingsResponse
MemberInviteAlreadyMemberResponse
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| message |
string |
|
Yes |
| status |
string |
|
Yes |
MemberInviteErrorResponse
| Name |
Type |
Description |
Required |
| code |
string,
Available values: "invalid_param", "invalid_role", "limit_exceeded" |
Enum: "invalid_param", "invalid_role", "limit_exceeded" |
Yes |
| message |
string |
|
Yes |
| status |
integer |
|
Yes |
MemberInviteFailedResponse
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| message |
string |
|
Yes |
| status |
string |
|
Yes |
MemberInvitePayload
| Name |
Type |
Description |
Required |
| emails |
[ string ] |
|
Yes |
| language |
string |
|
No |
| role |
string |
|
Yes |
MemberInviteResponse
MemberInviteSuccessResponse
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| status |
string |
|
Yes |
| url |
string |
|
Yes |
MemberNotFoundError
Member not found.
| Name |
Type |
Description |
Required |
| MemberNotFoundError |
|
Member not found. |
|
MemberNotInTenantError
The member is not in the workspace.
| Name |
Type |
Description |
Required |
| MemberNotInTenantError |
|
The member is not in the workspace. |
|
MemberRoleSummaryResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
MemberRoleUpdatePayload
| Name |
Type |
Description |
Required |
| role |
string |
|
Yes |
MemberRolesResponse
| Name |
Type |
Description |
Required |
| account_id |
string |
|
Yes |
| roles |
[ RBACRole ] |
|
No |
MembersInRole
| Name |
Type |
Description |
Required |
| account_id |
string |
|
No |
| account_name |
string |
|
No |
MessageCursorNotFoundError
The message cursor is not in this conversation. Refresh the list and try again.
| Name |
Type |
Description |
Required |
| MessageCursorNotFoundError |
|
The message cursor is not in this conversation. Refresh the list and try again. |
|
MessageDetail
| Name |
Type |
Description |
Required |
| agent_thoughts |
[ AgentThought ] |
|
Yes |
| annotation |
ConversationAnnotation |
|
No |
| annotation_hit_history |
ConversationAnnotationHitHistory |
|
No |
| answer |
string |
|
Yes |
| answer_tokens |
integer |
|
Yes |
| conversation_id |
string |
|
Yes |
| created_at |
integer |
|
No |
| error |
string |
|
No |
| feedbacks |
[ Feedback ] |
|
Yes |
| from_account_id |
string |
|
No |
| from_end_user_id |
string |
|
No |
| from_source |
string |
|
Yes |
| id |
string |
|
Yes |
| inputs |
object |
|
Yes |
| message |
AnyJSONValue |
|
Yes |
| message_files |
[ MessageFile ] |
|
Yes |
| message_tokens |
integer |
|
Yes |
| metadata |
AnyJSONValue |
|
Yes |
| parent_message_id |
string |
|
No |
| provider_response_latency |
number |
|
Yes |
| query |
string |
|
Yes |
| status |
string |
|
Yes |
| workflow_run_id |
string |
|
No |
MessageDetailResponse
| Name |
Type |
Description |
Required |
| agent_thoughts |
[ AgentThought ] |
|
Yes |
| annotation |
ConversationAnnotation |
|
No |
| annotation_hit_history |
ConversationAnnotationHitHistory |
|
No |
| answer |
string |
|
Yes |
| answer_tokens |
integer |
|
Yes |
| conversation_id |
string |
|
Yes |
| created_at |
integer |
|
No |
| error |
string |
|
No |
| extra_contents |
[ HumanInputContent ] |
|
No |
| feedbacks |
[ Feedback ] |
|
Yes |
| from_account_id |
string |
|
No |
| from_end_user_id |
string |
|
No |
| from_source |
string |
|
Yes |
| id |
string |
|
Yes |
| inputs |
object |
|
Yes |
| message |
AnyJSONValue |
|
Yes |
| message_files |
[ MessageFile ] |
|
Yes |
| message_tokens |
integer |
|
Yes |
| metadata |
AnyJSONValue |
|
Yes |
| parent_message_id |
string |
|
No |
| provider_response_latency |
number |
|
Yes |
| query |
string |
|
Yes |
| status |
string |
|
Yes |
| workflow_run_id |
string |
|
No |
MessageFeedbackPayload
| Name |
Type |
Description |
Required |
| content |
string |
Optional text feedback providing additional detail. |
No |
| rating |
string,
Available values: "dislike", "like" |
Feedback rating. Set to null to revoke previously submitted feedback. |
No |
MessageFeedbackRatingRequiredError
A rating is required when there is no existing feedback to remove.
| Name |
Type |
Description |
Required |
| MessageFeedbackRatingRequiredError |
|
A rating is required when there is no existing feedback to remove. |
|
MessageFile
| Name |
Type |
Description |
Required |
| belongs_to |
string |
|
No |
| filename |
string |
|
Yes |
| id |
string (uuid) |
|
Yes |
| mime_type |
string |
|
No |
| size |
integer |
|
No |
| transfer_method |
string |
|
Yes |
| type |
string |
|
Yes |
| upload_file_id |
string |
|
No |
| url |
string |
|
No |
MessageListQuery
| Name |
Type |
Description |
Required |
| conversation_id |
string |
Conversation ID. |
Yes |
| first_id |
string |
The ID of the first chat record on the current page. Omit this value to fetch the latest messages; for subsequent pages, use the first message ID from the current list to fetch older messages. |
No |
| limit |
integer,
Default: 20 |
Number of chat history messages to return per request. |
No |
MessageNotFoundError
The message was not found for this account and app.
| Name |
Type |
Description |
Required |
| MessageNotFoundError |
|
The message was not found for this account and app. |
|
Meta
| Name |
Type |
Description |
Required |
| minimum_dify_version |
string |
|
No |
| version |
string |
|
No |
MetadataArgs
| Name |
Type |
Description |
Required |
| name |
string |
Metadata field name. |
Yes |
| type |
string,
Available values: "number", "string", "time" |
string for text values, number for numeric values, time for date/time values.
Enum: "number", "string", "time" |
Yes |
MetadataDetail
| Name |
Type |
Description |
Required |
| id |
string (uuid) |
Metadata field ID. |
Yes |
| name |
string |
Metadata field name. |
Yes |
| value |
string
integer
number |
Metadata value. Can be a string, number, or null. |
No |
MetadataFilteringCondition
Metadata Filtering Condition.
| Name |
Type |
Description |
Required |
| conditions |
[ Condition ] |
List of metadata conditions to evaluate. |
No |
| logical_operator |
string,
Available values: "and", "or" |
How to combine multiple conditions. |
No |
MetadataOperationData
Metadata operation data
| Name |
Type |
Description |
Required |
| operation_data |
[ DocumentMetadataOperation ] |
Array of document metadata update operations. Each entry maps a document ID to its metadata values. |
Yes |
MetadataUpdatePayload
| Name |
Type |
Description |
Required |
| name |
string |
New metadata field name. |
Yes |
MissingInvitationCodeError
Invitation code is required.
| Name |
Type |
Description |
Required |
| MissingInvitationCodeError |
|
Invitation code is required. |
|
Model
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| llm |
boolean |
|
No |
| moderation |
boolean |
|
No |
| rerank |
boolean |
|
No |
| speech2text |
boolean |
|
No |
| text_embedding |
boolean |
|
No |
| tts |
boolean |
|
No |
ModelConfig
| Name |
Type |
Description |
Required |
| completion_params |
object |
|
No |
| mode |
LLMMode |
|
Yes |
| name |
string |
|
Yes |
| provider |
string |
|
Yes |
ModelConfigPartial
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| model |
AppModelSelectionResponse |
|
No |
| pre_prompt |
string |
|
No |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
ModelCredentialResponse
ModelCredentialSchema
Model class for model credential schema.
ModelCurrentlyNotSupportError
Dify Hosted OpenAI trial currently not support the GPT-4 model.
| Name |
Type |
Description |
Required |
| ModelCurrentlyNotSupportError |
|
Dify Hosted OpenAI trial currently not support the GPT-4 model. |
|
ModelFeature
Enum class for llm feature.
| Name |
Type |
Description |
Required |
| ModelFeature |
string |
Enum class for llm feature. |
|
ModelLoadBalancingConfigResponse
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
| credentials |
object |
|
Yes |
| enabled |
boolean |
|
Yes |
| id |
string |
|
Yes |
| in_cooldown |
boolean |
|
Yes |
| name |
string |
|
Yes |
| ttl |
integer |
|
Yes |
ModelLoadBalancingResponse
ModelParameterRuleListResponse
ModelPropertyKey
Enum class for model property key.
| Name |
Type |
Description |
Required |
| ModelPropertyKey |
string |
Enum class for model property key. |
|
ModelProviderCreditsResponse
| Name |
Type |
Description |
Required |
| exhausted_at |
integer |
|
Yes |
| is_exhausted |
boolean |
|
Yes |
| is_unlimited |
boolean |
|
Yes |
| next_credit_reset_date |
integer |
|
Yes |
| pool_type |
string,
Available values: "paid", "trial" |
|
Yes |
| quota_limit |
integer |
Credit limit for the effective pool; -1 means unlimited. |
Yes |
| quota_used |
integer |
|
Yes |
| remaining_credits |
integer |
Remaining credits; -1 means unlimited. |
Yes |
ModelProviderCustomConfigurationSummaryResponse
| Name |
Type |
Description |
Required |
| available_credentials |
[ CredentialConfiguration ] |
|
Yes |
| current_credential_id |
string |
|
No |
| current_credential_name |
string |
|
No |
| current_credential_usable |
boolean |
|
Yes |
| has_custom_models |
boolean |
Whether custom model configuration exists, including saved model credentials. |
Yes |
| status |
CustomConfigurationStatus |
|
Yes |
ModelProviderListResponse
ModelProviderPaymentCheckoutUrlResponse
| Name |
Type |
Description |
Required |
| payment_link |
string |
|
Yes |
ModelProviderPluginSummaryResponse
| Name |
Type |
Description |
Required |
| installation_id |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| runtime_type |
string |
|
Yes |
| source |
PluginInstallationSource |
|
Yes |
| version |
string |
|
Yes |
ModelProviderSummaryListResponse
ModelProviderSummaryResponse
Fields required to render the collapsed model-provider list.
ModelProviderSystemConfigurationSummaryResponse
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
Yes |
ModelRuntimeI18nObject
Model class for i18n object.
| Name |
Type |
Description |
Required |
| en_US |
string |
|
Yes |
| zh_Hans |
string |
|
No |
ModelSelectorScope
| Name |
Type |
Description |
Required |
| ModelSelectorScope |
string |
|
|
ModelStatus
Enum class for model status.
| Name |
Type |
Description |
Required |
| ModelStatus |
string |
Enum class for model status. |
|
ModelType
Enum class for model type.
| Name |
Type |
Description |
Required |
| ModelType |
string |
Enum class for model type. |
|
ModelWithProviderEntityResponse
Model with provider entity.
| Name |
Type |
Description |
Required |
| deprecated |
boolean |
|
No |
| features |
[ ModelFeature ] |
|
No |
| fetch_from |
FetchFrom |
Where the model definition comes from. predefined-model for built-in models, customizable-model for user-configured models. |
Yes |
| has_invalid_load_balancing_configs |
boolean |
|
No |
| label |
ModelRuntimeI18nObject |
Localized display name of the model. |
Yes |
| load_balancing_enabled |
boolean |
|
No |
| model |
string |
|
Yes |
| model_properties |
object |
|
Yes |
| model_type |
ModelType |
Type of the model, matching the model_type path parameter. |
Yes |
| provider |
SimpleProviderEntityResponse |
|
Yes |
| status |
ModelStatus |
Model availability status. active when ready to use. |
Yes |
MoreLikeThisQuery
| Name |
Type |
Description |
Required |
| response_mode |
string,
Available values: "blocking", "streaming" |
Enum: "blocking", "streaming" |
Yes |
MyPermissionsResponse
NeedAddIdsError
Need to add ids.
| Name |
Type |
Description |
Required |
| NeedAddIdsError |
|
Need to add ids. |
|
NewAppResponse
| Name |
Type |
Description |
Required |
| new_app_id |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
NoActiveBindingError
No active sandbox binding.
| Name |
Type |
Description |
Required |
| NoActiveBindingError |
|
No active sandbox binding. |
|
NoAudioUploadedError
Please upload your audio.
| Name |
Type |
Description |
Required |
| NoAudioUploadedError |
|
Please upload your audio. |
|
NoFileUploadedError
Please upload your file.
| Name |
Type |
Description |
Required |
| NoFileUploadedError |
|
Please upload your file. |
|
Node
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
NodeIdQuery
| Name |
Type |
Description |
Required |
| node_id |
string |
|
Yes |
NodeNotInWorkflowRunError
The node is not part of this workflow run.
| Name |
Type |
Description |
Required |
| NodeNotInWorkflowRunError |
|
The node is not part of this workflow run. |
|
NodeOutputNotDeclaredError
The node does not declare this output.
| Name |
Type |
Description |
Required |
| NodeOutputNotDeclaredError |
|
The node does not declare this output. |
|
NodeOutputStatus
Lifecycle status of a single declared output within a run.
| Name |
Type |
Description |
Required |
| NodeOutputStatus |
string |
Lifecycle status of a single declared output within a run. |
|
NodeOutputView
NodeOutputsView
| Name |
Type |
Description |
Required |
| node_completed_at |
string |
|
No |
| node_display_name |
string |
|
Yes |
| node_id |
string |
|
Yes |
| node_kind |
string |
|
Yes |
| node_started_at |
string |
|
No |
| node_status |
NodeStatus |
|
Yes |
| outputs |
[ NodeOutputView ] |
|
No |
NodeRunPayload
| Name |
Type |
Description |
Required |
| inputs |
object |
|
No |
NodeRunRequiredPayload
| Name |
Type |
Description |
Required |
| inputs |
object |
|
Yes |
NodeStatus
Coarse node-level status used by Inspector to pick a banner.
| Name |
Type |
Description |
Required |
| NodeStatus |
string |
Coarse node-level status used by Inspector to pick a banner. |
|
NormalizedEmailAlreadyInUseError
An account with an equivalent email address already exists.
| Name |
Type |
Description |
Required |
| NormalizedEmailAlreadyInUseError |
|
An account with an equivalent email address already exists. |
|
NotAllowedCreateWorkspaceError
Workspace not found, please contact system admin to invite you to join in a workspace.
| Name |
Type |
Description |
Required |
| NotAllowedCreateWorkspaceError |
|
Workspace not found, please contact system admin to invite you to join in a workspace. |
|
NotChatAppError
App mode is invalid.
| Name |
Type |
Description |
Required |
| NotChatAppError |
|
App mode is invalid. |
|
NotCompletionAppError
Not Completion App
| Name |
Type |
Description |
Required |
| NotCompletionAppError |
|
Not Completion App |
|
NotOwnerError
You are not the owner of the workspace.
| Name |
Type |
Description |
Required |
| NotOwnerError |
|
You are not the owner of the workspace. |
|
NotWorkflowAppError
Only support workflow app.
| Name |
Type |
Description |
Required |
| NotWorkflowAppError |
|
Only support workflow app. |
|
NotificationItemResponse
| Name |
Type |
Description |
Required |
| body |
string |
|
Yes |
| frequency |
string |
|
No |
| lang |
string |
|
Yes |
| notification_id |
string |
|
No |
| subtitle |
string |
|
Yes |
| title |
string |
|
Yes |
| title_pic_url |
string |
|
Yes |
NotificationQuery
| Name |
Type |
Description |
Required |
| language |
string,
Default: en-US |
Notification language |
No |
NotificationResponse
NotionEstimatePagePayload
| Name |
Type |
Description |
Required |
| page_id |
string |
|
Yes |
| type |
NotionPageType |
|
Yes |
NotionEstimatePayload
| Name |
Type |
Description |
Required |
| doc_form |
string,
Default: text_model |
|
No |
| doc_language |
string,
Default: English |
|
No |
| notion_info_list |
[ NotionEstimateWorkspacePayload ] |
|
Yes |
| process_rule |
object |
|
Yes |
NotionEstimateWorkspacePayload
NotionIcon
| Name |
Type |
Description |
Required |
| emoji |
string |
|
No |
| type |
string |
|
Yes |
| url |
string |
|
No |
NotionInfo
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| pages |
[ NotionPage ] |
|
Yes |
| workspace_id |
string |
|
Yes |
NotionIntegrateInfoListResponse
NotionIntegrateWorkspaceResponse
| Name |
Type |
Description |
Required |
| pages |
[ NotionIntegratePageResponse ] |
|
Yes |
| workspace_icon |
string |
|
Yes |
| workspace_id |
string |
|
Yes |
| workspace_name |
string |
|
Yes |
NotionPage
| Name |
Type |
Description |
Required |
| page_icon |
NotionIcon |
|
No |
| page_id |
string |
|
Yes |
| page_name |
string |
|
Yes |
| type |
string |
|
Yes |
NotionPageType
| Name |
Type |
Description |
Required |
| NotionPageType |
string |
|
|
OAuthCallbackQuery
| Name |
Type |
Description |
Required |
| code |
string |
Authorization code from OAuth provider |
Yes |
| state |
string |
OAuth state parameter |
No |
OAuthClientPayload
| Name |
Type |
Description |
Required |
| client_id |
string |
|
Yes |
OAuthDataSourceBindingQuery
| Name |
Type |
Description |
Required |
| code |
string |
Authorization code from OAuth provider |
Yes |
OAuthDataSourceBindingResponse
| Name |
Type |
Description |
Required |
| result |
string |
Operation result |
Yes |
OAuthDataSourceCallbackQuery
| Name |
Type |
Description |
Required |
| code |
string |
Authorization code from OAuth provider |
No |
| error |
string |
Error message from OAuth provider |
No |
OAuthDataSourceResponse
| Name |
Type |
Description |
Required |
| data |
string |
Authorization URL or 'internal' for internal setup |
Yes |
OAuthDataSourceSyncResponse
| Name |
Type |
Description |
Required |
| result |
string |
Operation result |
Yes |
OAuthErrorResponse
| Name |
Type |
Description |
Required |
| error |
string |
OAuth error message |
Yes |
OAuthLoginQuery
| Name |
Type |
Description |
Required |
| invite_token |
string |
Optional invitation token |
No |
| language |
string |
Preferred interface language |
No |
| redirect_url |
string |
Relative page to resume after login |
No |
| timezone |
string |
Preferred timezone |
No |
OAuthProviderAccountResponse
| Name |
Type |
Description |
Required |
| avatar |
string |
|
No |
| created_at |
integer |
|
Yes |
| email |
string |
|
Yes |
| id |
string |
|
Yes |
| interface_language |
string |
|
Yes |
| name |
string |
|
Yes |
| timezone |
string |
|
Yes |
OAuthProviderAppResponse
| Name |
Type |
Description |
Required |
| app_icon |
string |
|
Yes |
| app_label |
object |
|
Yes |
| auto_authorize |
boolean |
|
Yes |
| scope |
string |
|
Yes |
OAuthProviderAuthorizeResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
OAuthProviderRequest
| Name |
Type |
Description |
Required |
| client_id |
string |
|
Yes |
| redirect_uri |
string |
|
Yes |
OAuthProviderTokenResponse
| Name |
Type |
Description |
Required |
| access_token |
string |
|
Yes |
| expires_in |
integer |
|
Yes |
| refresh_token |
string |
|
Yes |
| token_type |
string |
|
Yes |
OAuthSchema
OAuth schema
| Name |
Type |
Description |
Required |
| client_schema |
[ ProviderConfig ] |
client schema like client_id, client_secret, etc. |
No |
| credentials_schema |
[ ProviderConfig ] |
credentials schema like access_token, refresh_token, etc. |
No |
OAuthTokenRequest
| Name |
Type |
Description |
Required |
| client_id |
string |
|
Yes |
| client_secret |
string |
|
No |
| code |
string |
|
No |
| grant_type |
string |
|
Yes |
| redirect_uri |
string |
|
No |
| refresh_token |
string |
|
No |
Option
| Name |
Type |
Description |
Required |
| label |
I18nObject |
The label of the option |
Yes |
| value |
string |
The value of the option |
Yes |
OutputErrorStrategy
Per-output failure handling strategy.
Mirrors graphon.ErrorStrategy but scoped to a single declared output of
a Workflow Agent Node. The runtime applies the strategy after type check or
output check fails and any configured retry attempts have been exhausted.
| Name |
Type |
Description |
Required |
| OutputErrorStrategy |
string |
Per-output failure handling strategy. Mirrors graphon.ErrorStrategy but scoped to a single declared output of a Workflow Agent Node. The runtime applies the strategy after type check or output check fails and any configured retry attempts have been exhausted. |
|
OutputPreviewView
OwnerTransferCheckPayload
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| token |
string |
|
Yes |
OwnerTransferEmailPayload
| Name |
Type |
Description |
Required |
| language |
string |
|
No |
OwnerTransferLimitError
Too many failed owner transfer attempts. Please try again in 24 hours.
| Name |
Type |
Description |
Required |
| OwnerTransferLimitError |
|
Too many failed owner transfer attempts. Please try again in 24 hours. |
|
OwnerTransferPayload
| Name |
Type |
Description |
Required |
| token |
string |
|
Yes |
OwnerTransferRateLimitExceededError
Too many owner transfer emails have been sent. Please try again in {minutes} minutes.
| Name |
Type |
Description |
Required |
| OwnerTransferRateLimitExceededError |
|
Too many owner transfer emails have been sent. Please try again in {minutes} minutes. |
|
PaginatedConversationVariableResponse
| Name |
Type |
Description |
Required |
| data |
[ ConversationVariableResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
| Name |
Type |
Description |
Required |
| current_page |
integer |
|
No |
| per_page |
integer |
|
No |
| total_count |
integer |
|
No |
| total_pages |
integer |
|
No |
| Name |
Type |
Description |
Required |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
ParagraphInputConfig
Form input definition.
| Name |
Type |
Description |
Required |
| default |
StringSource |
Raw default-value configuration for the paragraph input. Runtime-resolved values are exposed in the surrounding resolved_default_values mapping. |
No |
| output_variable_name |
string |
|
Yes |
| type |
string |
|
No |
ParameterRule
Model class for parameter rule.
ParameterType
Enum class for parameter type.
| Name |
Type |
Description |
Required |
| ParameterType |
string |
Enum class for parameter type. |
|
Parameters
| Name |
Type |
Description |
Required |
| annotation_reply |
{ "enabled": boolean } |
|
Yes |
| file_upload |
{ "allowed_file_extensions": [ string ], "allowed_file_types": [ string,
Available values: "audio", "custom", "document", "image", "video" ], "allowed_file_upload_methods": [ string,
Available values: "local_file", "remote_url" ], "enabled": boolean, "image": { "detail": string, "enabled": boolean, "number_limits": integer, "transfer_methods": [ string ] }, "number_limits": integer } |
|
Yes |
| more_like_this |
{ "enabled": boolean } |
|
Yes |
| opening_statement |
|
|
No |
| retriever_resource |
{ "enabled": boolean } |
|
Yes |
| sensitive_word_avoidance |
{ "enabled": boolean } |
|
Yes |
| speech_to_text |
{ "enabled": boolean } |
|
Yes |
| suggested_questions |
[ string ] |
|
Yes |
| suggested_questions_after_answer |
{ "enabled": boolean } |
|
Yes |
| system_parameters |
SystemParameters |
System-level parameter limits. |
Yes |
| text_to_speech |
{ "autoPlay": string, "enabled": boolean, "language": string, "voice": string } |
|
Yes |
| user_input_form |
[ object ] |
|
Yes |
ParserAsset
| Name |
Type |
Description |
Required |
| file_name |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
ParserAutoUpgradeChange
ParserAutoUpgradeFetch
ParserCreateCredential
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
| name |
string |
|
No |
ParserCredentialCreate
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| name |
string |
|
No |
ParserCredentialDelete
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
ParserCredentialId
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
No |
ParserCredentialSwitch
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
ParserCredentialUpdate
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| credentials |
object |
|
Yes |
| name |
string |
|
No |
ParserCredentialValidate
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
ParserDeleteCredential
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
ParserDeleteModels
| Name |
Type |
Description |
Required |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
ParserDynamicOptions
| Name |
Type |
Description |
Required |
| action |
string |
|
Yes |
| credential_id |
string |
|
No |
| parameter |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| provider |
string |
|
Yes |
| provider_type |
string,
Available values: "tool", "trigger" |
Enum: "tool", "trigger" |
Yes |
ParserDynamicOptionsWithCredentials
| Name |
Type |
Description |
Required |
| action |
string |
|
Yes |
| credential_id |
string |
|
Yes |
| credentials |
object |
|
Yes |
| parameter |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| provider |
string |
|
Yes |
ParserEnable
| Name |
Type |
Description |
Required |
| enable_trigger |
boolean |
|
Yes |
| trigger_id |
string |
|
Yes |
ParserExcludePlugin
ParserGetCredentials
| Name |
Type |
Description |
Required |
| config_from |
string |
|
No |
| credential_id |
string |
|
No |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
ParserGetDefault
| Name |
Type |
Description |
Required |
| model_type |
ModelType |
|
Yes |
ParserGithubInstall
| Name |
Type |
Description |
Required |
| package |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| repo |
string |
|
Yes |
| version |
string |
|
Yes |
ParserGithubUpgrade
| Name |
Type |
Description |
Required |
| new_plugin_unique_identifier |
string |
|
Yes |
| original_plugin_unique_identifier |
string |
|
Yes |
| package |
string |
|
Yes |
| repo |
string |
|
Yes |
| version |
string |
|
Yes |
ParserGithubUpload
| Name |
Type |
Description |
Required |
| package |
string |
|
Yes |
| repo |
string |
|
Yes |
| version |
string |
|
Yes |
ParserIcon
| Name |
Type |
Description |
Required |
| filename |
string |
|
Yes |
| tenant_id |
string |
|
Yes |
ParserLatest
| Name |
Type |
Description |
Required |
| plugin_ids |
[ string ] |
|
Yes |
ParserList
| Name |
Type |
Description |
Required |
| page |
integer,
Default: 1 |
Page number |
No |
| page_size |
integer,
Default: 256 |
Page size (1-256) |
No |
ParserMarketplaceUpgrade
| Name |
Type |
Description |
Required |
| new_plugin_unique_identifier |
string |
|
Yes |
| original_plugin_unique_identifier |
string |
|
Yes |
ParserModelList
| Name |
Type |
Description |
Required |
| model_type |
ModelType |
|
No |
ParserParameter
| Name |
Type |
Description |
Required |
| model |
string |
|
Yes |
ParserPermissionChange
ParserPluginIdentifierQuery
| Name |
Type |
Description |
Required |
| plugin_unique_identifier |
string |
|
Yes |
ParserPluginIdentifiers
| Name |
Type |
Description |
Required |
| plugin_unique_identifiers |
[ string ] |
|
Yes |
ParserPostDefault
| Name |
Type |
Description |
Required |
| model_settings |
[ Inner ] |
|
Yes |
ParserPostModels
| Name |
Type |
Description |
Required |
| config_from |
string |
|
No |
| credential_id |
string |
|
No |
| load_balancing |
LoadBalancingPayload |
|
No |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
ParserPreferredProviderType
| Name |
Type |
Description |
Required |
| preferred_provider_type |
string,
Available values: "custom", "system" |
Enum: "custom", "system" |
Yes |
ParserReadme
| Name |
Type |
Description |
Required |
| language |
string,
Default: en-US |
|
No |
| plugin_unique_identifier |
string |
|
Yes |
ParserSwitch
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
ParserTasks
| Name |
Type |
Description |
Required |
| page |
integer,
Default: 1 |
Page number |
No |
| page_size |
integer,
Default: 256 |
Page size (1-256) |
No |
ParserUninstall
| Name |
Type |
Description |
Required |
| plugin_installation_id |
string |
|
Yes |
| preserve_credentials |
boolean |
|
No |
ParserUpdateCredential
| Name |
Type |
Description |
Required |
| credential_id |
string |
|
Yes |
| credentials |
object |
|
Yes |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
| name |
string |
|
No |
ParserValidate
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
PartialMemberListResponse
| Name |
Type |
Description |
Required |
| data |
[ string ] |
|
Yes |
PasswordMismatchError
The passwords do not match.
| Name |
Type |
Description |
Required |
| PasswordMismatchError |
|
The passwords do not match. |
|
PasswordResetRateLimitExceededError
Too many password reset emails have been sent. Please try again in {minutes} minutes.
| Name |
Type |
Description |
Required |
| PasswordResetRateLimitExceededError |
|
Too many password reset emails have been sent. Please try again in {minutes} minutes. |
|
PausedNodeResponse
Permission
PermissionCatalogGroup
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| group_key |
string |
|
Yes |
| group_name |
string |
|
Yes |
| permissions |
[ PermissionCatalogItem ] |
|
No |
PermissionCatalogItem
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| key |
string |
|
Yes |
| name |
string |
|
Yes |
PermissionCatalogResponse
PermissionEnum
Shared permission levels for resources (datasets, credentials, etc.)
| Name |
Type |
Description |
Required |
| PermissionEnum |
string |
Shared permission levels for resources (datasets, credentials, etc.) |
|
PipelineNotFoundError
Pipeline not found.
| Name |
Type |
Description |
Required |
| PipelineNotFoundError |
|
Pipeline not found. |
|
PipelineTemplateDetailQuery
| Name |
Type |
Description |
Required |
| type |
string,
Default: built-in |
Template source: built-in or customized |
No |
PipelineTemplateDetailResponse
| Name |
Type |
Description |
Required |
| chunk_structure |
string |
|
Yes |
| created_by |
string |
|
No |
| description |
string |
|
Yes |
| export_data |
string |
|
Yes |
| graph |
object |
|
Yes |
| icon_info |
object |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
PipelineTemplateItemResponse
| Name |
Type |
Description |
Required |
| chunk_structure |
string |
|
Yes |
| copyright |
string |
|
No |
| description |
string |
|
Yes |
| icon |
object |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| position |
integer |
|
Yes |
| privacy_policy |
string |
|
No |
PipelineTemplateListQuery
| Name |
Type |
Description |
Required |
| language |
string,
Default: en-US |
Template language |
No |
| type |
string,
Default: built-in |
Template source: built-in or customized |
No |
PipelineTemplateListResponse
PipelineVariableResponse
| Name |
Type |
Description |
Required |
| allowed_file_extensions |
[ string ] |
|
No |
| allowed_file_types |
[ string ] |
|
No |
| allowed_file_upload_methods |
[ string ] |
|
No |
| belong_to_node_id |
string |
|
Yes |
| default_value |
|
|
No |
| label |
string |
|
Yes |
| max_length |
integer |
|
No |
| options |
[ string ] |
|
No |
| placeholder |
string |
|
No |
| required |
boolean |
|
Yes |
| tooltips |
string |
|
No |
| type |
string |
|
Yes |
| unit |
string |
|
No |
| variable |
string |
|
Yes |
PlaintextSecretNotAllowedError
Plaintext secret values are not allowed in Agent config.
| Name |
Type |
Description |
Required |
| PlaintextSecretNotAllowedError |
|
Plaintext secret values are not allowed in Agent config. |
|
PlanningStrategy
| Name |
Type |
Description |
Required |
| PlanningStrategy |
string |
|
|
PluginAutoUpgradeChangeResponse
| Name |
Type |
Description |
Required |
| message |
string |
|
No |
| success |
boolean |
|
Yes |
PluginAutoUpgradeFetchResponse
PluginAutoUpgradeSettingsPayload
PluginAutoUpgradeSettingsResponseModel
PluginBundleDependency
PluginBundleDependencyGithub
| Name |
Type |
Description |
Required |
| packages |
string |
|
Yes |
| release |
string |
|
Yes |
| repo |
string |
|
Yes |
| repo_address |
string |
|
Yes |
PluginBundleDependencyMarketplace
| Name |
Type |
Description |
Required |
| organization |
string |
|
Yes |
| plugin |
string |
|
Yes |
| version |
string |
|
Yes |
PluginBundleDependencyPackage
| Name |
Type |
Description |
Required |
| manifest |
PluginDeclaration |
|
Yes |
| unique_identifier |
string |
|
Yes |
PluginBundleDependencyType
| Name |
Type |
Description |
Required |
| PluginBundleDependencyType |
string |
|
|
PluginBundleUploadResponse
| Name |
Type |
Description |
Required |
| PluginBundleUploadResponse |
array |
|
|
PluginCategory
| Name |
Type |
Description |
Required |
| PluginCategory |
string |
|
|
PluginCategoryBuiltinToolProviderResponse
| Name |
Type |
Description |
Required |
| allow_delete |
boolean |
|
Yes |
| author |
string |
|
Yes |
| description |
I18nObject |
|
Yes |
| icon |
string
object |
|
Yes |
| icon_dark |
string
object |
|
Yes |
| id |
string |
|
Yes |
| is_team_authorization |
boolean |
|
Yes |
| label |
I18nObject |
|
Yes |
| labels |
[ string ] |
|
Yes |
| name |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| team_credentials |
object |
|
Yes |
| tools |
[ PluginCategoryBuiltinToolResponse ] |
|
Yes |
| type |
ToolProviderType |
|
Yes |
PluginCategoryBuiltinToolResponse
| Name |
Type |
Description |
Required |
| author |
string |
|
Yes |
| description |
I18nObject |
|
Yes |
| label |
I18nObject |
|
Yes |
| labels |
[ string ] |
|
Yes |
| name |
string |
|
Yes |
| output_schema |
object |
|
Yes |
| parameters |
[ object ] |
|
No |
PluginCategoryInstalledPluginResponse
| Name |
Type |
Description |
Required |
| checksum |
string |
|
Yes |
| created_at |
dateTime |
|
Yes |
| declaration |
PluginDeclarationResponse |
|
Yes |
| endpoints_active |
integer |
|
Yes |
| endpoints_setups |
integer |
|
Yes |
| id |
string |
|
Yes |
| installation_id |
string |
|
Yes |
| meta |
object |
|
Yes |
| name |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| runtime_type |
string |
|
Yes |
| source |
PluginInstallationSource |
|
Yes |
| tenant_id |
string |
|
Yes |
| updated_at |
dateTime |
|
Yes |
| version |
string |
|
Yes |
PluginCategoryListQuery
| Name |
Type |
Description |
Required |
| language |
string,
Available values: "en_US", "ja_JP", "pt_BR", "zh_Hans",
Default: en_US |
Language used for localized label and description search
Enum: "en_US", "ja_JP", "pt_BR", "zh_Hans" |
No |
| page |
integer,
Default: 1 |
Page number |
No |
| page_size |
integer,
Default: 256 |
Page size (1-256) |
No |
| query |
string |
Case-insensitive search query |
No |
| tags |
[ string ] |
Match any plugin tag |
No |
PluginCategoryListResponse
PluginDebuggingKeyResponse
| Name |
Type |
Description |
Required |
| host |
string |
|
Yes |
| key |
string |
|
Yes |
| port |
integer |
|
Yes |
PluginDeclaration
PluginDeclarationResponse
| Name |
Type |
Description |
Required |
| agent_strategy |
object |
|
No |
| author |
string |
|
Yes |
| category |
PluginCategory |
|
Yes |
| created_at |
dateTime |
|
Yes |
| datasource |
object |
|
No |
| description |
I18nObject |
|
Yes |
| endpoint |
object |
|
No |
| icon |
string |
|
Yes |
| icon_dark |
string |
|
No |
| label |
I18nObject |
|
Yes |
| meta |
object |
|
Yes |
| model |
ProviderEntityResponse |
|
No |
| name |
string |
|
Yes |
| plugins |
object |
|
Yes |
| repo |
string |
|
No |
| resource |
object |
|
Yes |
| tags |
[ string ] |
|
No |
| tool |
object |
|
No |
| trigger |
object |
|
No |
| verified |
boolean |
|
No |
| version |
string |
|
Yes |
PluginDecodeResponse
| Name |
Type |
Description |
Required |
| manifest |
PluginDeclaration |
|
Yes |
| unique_identifier |
string |
The unique identifier of the plugin. |
Yes |
| verification |
PluginVerification |
Basic verification information |
No |
PluginDependency
PluginDependencyGithub
| Name |
Type |
Description |
Required |
| github_plugin_unique_identifier |
string |
|
Yes |
| package |
string |
|
Yes |
| repo |
string |
|
Yes |
| version |
string |
|
Yes |
PluginDependencyMarketplace
| Name |
Type |
Description |
Required |
| marketplace_plugin_unique_identifier |
string |
|
Yes |
| version |
string |
|
No |
PluginDependencyPackage
| Name |
Type |
Description |
Required |
| plugin_unique_identifier |
string |
|
Yes |
| version |
string |
|
No |
PluginDependencyType
| Name |
Type |
Description |
Required |
| PluginDependencyType |
string |
|
|
PluginDynamicOptionsResponse
PluginEntity
| Name |
Type |
Description |
Required |
| checksum |
string |
|
Yes |
| created_at |
dateTime |
|
Yes |
| declaration |
PluginDeclaration |
|
Yes |
| endpoints_active |
integer |
|
Yes |
| endpoints_setups |
integer |
|
Yes |
| id |
string |
|
Yes |
| installation_id |
string |
|
Yes |
| meta |
object |
|
Yes |
| name |
string |
|
Yes |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| runtime_type |
string |
|
Yes |
| source |
PluginInstallationSource |
|
Yes |
| tenant_id |
string |
|
Yes |
| updated_at |
dateTime |
|
Yes |
| version |
string |
|
Yes |
PluginError
Plugin operation failed.
| Name |
Type |
Description |
Required |
| PluginError |
|
Plugin operation failed. |
|
PluginInstallTask
| Name |
Type |
Description |
Required |
| completed_plugins |
integer |
The number of plugins that have been installed. |
Yes |
| created_at |
dateTime |
|
Yes |
| id |
string |
|
Yes |
| plugins |
[ PluginInstallTaskPluginStatus ] |
The status of the plugins. |
Yes |
| status |
PluginInstallTaskStatus |
The status of the install task. |
Yes |
| total_plugins |
integer |
The total number of plugins to be installed. |
Yes |
| updated_at |
dateTime |
|
Yes |
PluginInstallTaskPluginStatus
| Name |
Type |
Description |
Required |
| icon |
string |
The icon of the plugin. |
Yes |
| labels |
I18nObject |
The labels of the plugin. |
Yes |
| message |
string |
The message of the install task. |
Yes |
| plugin_id |
string |
The plugin ID of the install task. |
Yes |
| plugin_unique_identifier |
string |
The plugin unique identifier of the install task. |
Yes |
| source |
string |
The installation source of the plugin |
No |
| status |
PluginInstallTaskStatus |
The status of the install task. |
Yes |
PluginInstallTaskStartResponse
| Name |
Type |
Description |
Required |
| all_installed |
boolean |
Whether all plugins are installed. |
Yes |
| task |
PluginInstallTask |
The install task. |
No |
| task_id |
string |
The ID of the install task. |
Yes |
PluginInstallTaskStatus
| Name |
Type |
Description |
Required |
| PluginInstallTaskStatus |
string |
|
|
PluginInstallationItemResponse
| Name |
Type |
Description |
Required |
| checksum |
string |
|
Yes |
| created_at |
dateTime |
|
Yes |
| declaration |
PluginDeclarationResponse |
|
Yes |
| endpoints_active |
integer |
|
Yes |
| endpoints_setups |
integer |
|
Yes |
| id |
string |
|
Yes |
| meta |
object |
|
Yes |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| runtime_type |
string |
|
Yes |
| source |
PluginInstallationSource |
|
Yes |
| tenant_id |
string |
|
Yes |
| updated_at |
dateTime |
|
Yes |
| version |
string |
|
Yes |
PluginInstallationPermissionModel
| Name |
Type |
Description |
Required |
| plugin_installation_scope |
PluginInstallationScope |
|
Yes |
| restrict_to_marketplace_only |
boolean |
|
Yes |
PluginInstallationScope
| Name |
Type |
Description |
Required |
| PluginInstallationScope |
string |
|
|
PluginInstallationSource
| Name |
Type |
Description |
Required |
| PluginInstallationSource |
string |
|
|
PluginInstallationsResponse
PluginInstalledIdsQuery
| Name |
Type |
Description |
Required |
| category |
PluginCategory |
Plugin category to include |
Yes |
PluginInstalledIdsResponse
| Name |
Type |
Description |
Required |
| plugin_ids |
[ string ] |
|
Yes |
PluginListResponse
| Name |
Type |
Description |
Required |
| plugins |
[ PluginEntity ] |
|
Yes |
| total |
integer |
|
Yes |
PluginManifestResponse
PluginOAuthAuthorizationUrlResponse
| Name |
Type |
Description |
Required |
| authorization_url |
string |
The URL of the authorization. |
Yes |
PluginOperationSuccessResponse
| Name |
Type |
Description |
Required |
| message |
string |
|
No |
| success |
boolean |
|
Yes |
PluginParameterAutoGenerate
PluginParameterAutoGenerateType
| Name |
Type |
Description |
Required |
| PluginParameterAutoGenerateType |
string |
|
|
PluginParameterOption
| Name |
Type |
Description |
Required |
| icon |
string |
The icon of the option, can be a url or a base64 encoded image |
No |
| label |
I18nObject |
The label of the option |
Yes |
| value |
string |
The value of the option |
Yes |
PluginParameterTemplate
| Name |
Type |
Description |
Required |
| enabled |
boolean |
Whether the parameter is jinja enabled |
No |
PluginPermissionResponse
PluginPermissionSettingsPayload
PluginReadmeResponse
| Name |
Type |
Description |
Required |
| readme |
string |
|
Yes |
PluginResourceRequirements
| Name |
Type |
Description |
Required |
| memory |
integer |
|
Yes |
| permission |
Permission |
|
No |
PluginTaskResponse
PluginTasksResponse
PluginVerification
Verification of the plugin.
| Name |
Type |
Description |
Required |
| authorized_category |
AuthorizedCategory |
The authorized category of the plugin. |
Yes |
PluginVersionsResponse
| Name |
Type |
Description |
Required |
| versions |
object |
|
Yes |
Plugins
| Name |
Type |
Description |
Required |
| datasources |
[ string ] |
|
No |
| endpoints |
[ string ] |
|
No |
| models |
[ string ] |
|
No |
| tools |
[ string ] |
|
No |
| triggers |
[ string ] |
|
No |
PreProcessingRule
| Name |
Type |
Description |
Required |
| enabled |
boolean |
Whether this preprocessing rule is enabled. |
Yes |
| id |
PreProcessingRuleKey |
Rule identifier. |
Yes |
PreProcessingRuleKey
| Name |
Type |
Description |
Required |
| PreProcessingRuleKey |
string |
|
|
PreviewDetail
| Name |
Type |
Description |
Required |
| child_chunks |
[ string ] |
|
No |
| content |
string |
|
Yes |
| summary |
string |
|
No |
PriceConfig
Model class for pricing info.
| Name |
Type |
Description |
Required |
| currency |
string |
|
Yes |
| input |
string |
|
Yes |
| output |
string |
|
No |
| unit |
string |
|
Yes |
PriceConfigResponse
Serialized pricing info with codegen-safe decimal string patterns.
| Name |
Type |
Description |
Required |
| currency |
string |
|
Yes |
| input |
string |
|
Yes |
| output |
string |
|
No |
| unit |
string |
|
Yes |
ProcessRule
| Name |
Type |
Description |
Required |
| mode |
ProcessRuleMode |
automatic uses built-in rules, custom allows manual configuration, hierarchical enables parent-child chunk structure (use with doc_form: hierarchical_model). |
Yes |
| rules |
Rule |
Custom processing rules. |
No |
ProcessRuleMode
Dataset Process Rule Mode
| Name |
Type |
Description |
Required |
| ProcessRuleMode |
string |
Dataset Process Rule Mode |
|
ProcessRuleResponse
PromptType
Prompt configuration type
| Name |
Type |
Description |
Required |
| PromptType |
string |
Prompt configuration type |
|
ProviderConfig
Model class for common provider settings like credentials
ProviderConfigListResponse
| Name |
Type |
Description |
Required |
| ProviderConfigListResponse |
array |
|
|
ProviderConfigType
| Name |
Type |
Description |
Required |
| ProviderConfigType |
string |
|
|
ProviderCredentialSchema
Model class for provider credential schema.
ProviderCredentialsResponse
| Name |
Type |
Description |
Required |
| credentials |
object |
|
No |
ProviderEntity
Runtime-native provider schema.
provider is the canonical runtime identifier. provider_name is a
compatibility alias for callers that still resolve providers by short name and
is empty when no alias exists.
ProviderEntityResponse
Runtime provider response with codegen-safe model pricing schemas.
ProviderHelpEntity
Model class for provider help.
ProviderModelListResponse
ProviderModelWithStatusEntity
Model class for model response.
| Name |
Type |
Description |
Required |
| deprecated |
boolean |
|
No |
| features |
[ ModelFeature ] |
|
No |
| fetch_from |
FetchFrom |
Where the model definition comes from. predefined-model for built-in models, customizable-model for user-configured models. |
Yes |
| has_invalid_load_balancing_configs |
boolean |
|
No |
| label |
ModelRuntimeI18nObject |
Localized display name of the model. |
Yes |
| load_balancing_enabled |
boolean |
|
No |
| model |
string |
|
Yes |
| model_properties |
object |
|
Yes |
| model_type |
ModelType |
Type of the model, matching the model_type path parameter. |
Yes |
| status |
ModelStatus |
Model availability status. active when ready to use. |
Yes |
ProviderNotInitializeError
No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials.
| Name |
Type |
Description |
Required |
| ProviderNotInitializeError |
|
No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. |
|
ProviderNotSupportSpeechToTextError
Provider not support speech to text.
| Name |
Type |
Description |
Required |
| ProviderNotSupportSpeechToTextError |
|
Provider not support speech to text. |
|
ProviderNotSupportTextToSpeechError
Provider does not support text to speech.
| Name |
Type |
Description |
Required |
| ProviderNotSupportTextToSpeechError |
|
Provider does not support text to speech. |
|
ProviderQuery
| Name |
Type |
Description |
Required |
| provider |
string |
|
Yes |
ProviderQuotaExceededError
Your quota for Dify Hosted Model Provider has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials.
| Name |
Type |
Description |
Required |
| ProviderQuotaExceededError |
|
Your quota for Dify Hosted Model Provider has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials. |
|
ProviderQuotaType
| Name |
Type |
Description |
Required |
| ProviderQuotaType |
string |
|
|
ProviderResponse
Model class for provider response.
ProviderType
| Name |
Type |
Description |
Required |
| ProviderType |
string |
|
|
ProviderWithModelsResponse
Model class for provider with models response.
PublishWorkflowPayload
| Name |
Type |
Description |
Required |
| marked_comment |
string |
|
No |
| marked_name |
string |
|
No |
PublishedWorkflowRunPayload
| Name |
Type |
Description |
Required |
| datasource_info_list |
[ object ] |
|
Yes |
| datasource_type |
string |
|
Yes |
| inputs |
object |
|
Yes |
| is_preview |
boolean |
|
No |
| original_document_id |
string |
|
No |
| response_mode |
string,
Available values: "blocking", "streaming",
Default: streaming |
Enum: "blocking", "streaming" |
No |
| start_node_id |
string |
|
Yes |
QAPreviewDetail
| Name |
Type |
Description |
Required |
| answer |
string |
|
Yes |
| question |
string |
|
Yes |
Quota
| Name |
Type |
Description |
Required |
| limit |
integer |
Quota limit; -1 means unlimited and 0 means no quota |
Yes |
| reset_date |
integer,
Default: -1 |
Next quota reset as a Unix timestamp in seconds; -1 means no reset |
Yes |
| usage |
integer |
|
Yes |
QuotaConfiguration
Model class for provider quota configuration.
| Name |
Type |
Description |
Required |
| is_valid |
boolean |
|
Yes |
| quota_limit |
integer |
|
Yes |
| quota_type |
ProviderQuotaType |
|
Yes |
| quota_unit |
QuotaUnit |
|
Yes |
| quota_used |
integer |
|
Yes |
| restrict_models |
[ RestrictModel ],
Default: |
|
No |
QuotaUnit
| Name |
Type |
Description |
Required |
| QuotaUnit |
string |
|
|
RBACResourceType
Resource types understood by access policies.
| Name |
Type |
Description |
Required |
| RBACResourceType |
string |
Resource types understood by access policies. |
|
RBACRole
| Name |
Type |
Description |
Required |
| category |
string |
|
No |
| description |
string |
|
No |
| id |
string |
|
Yes |
| is_builtin |
boolean |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| role_tag |
string |
|
No |
| tenant_id |
string |
|
No |
| type |
string |
|
Yes |
RBACRoleAccount
| Name |
Type |
Description |
Required |
| account_id |
string |
|
Yes |
| account_name |
string |
|
No |
| avatar |
string |
|
No |
| email |
string |
|
No |
RagPipelineDatasetImportPayload
| Name |
Type |
Description |
Required |
| yaml_content |
string |
|
Yes |
RagPipelineDatasourceListResponse
| Name |
Type |
Description |
Required |
| RagPipelineDatasourceListResponse |
array |
|
|
RagPipelineDatasourceProviderResponse
| Name |
Type |
Description |
Required |
| declaration |
DatasourceProviderEntityWithPlugin |
|
Yes |
| is_authorized |
boolean |
|
No |
| plugin_id |
string |
|
Yes |
| plugin_unique_identifier |
string |
|
Yes |
| provider |
string |
|
Yes |
RagPipelineDraftWorkflowRunPayload
| Name |
Type |
Description |
Required |
| datasource_info_list |
[ object ] |
|
Yes |
| datasource_type |
string |
|
Yes |
| inputs |
object |
|
Yes |
| start_node_id |
string |
|
Yes |
RagPipelineImportCheckDependenciesResponse
RagPipelineImportPayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| mode |
string |
|
Yes |
| name |
string |
|
No |
| pipeline_id |
string |
|
No |
| yaml_content |
string |
|
No |
| yaml_url |
string |
|
No |
RagPipelineImportResponse
| Name |
Type |
Description |
Required |
| current_dsl_version |
string |
|
Yes |
| dataset_id |
string |
|
No |
| error |
string |
|
No |
| id |
string |
|
Yes |
| imported_dsl_version |
string |
|
Yes |
| pipeline_id |
string |
|
No |
| status |
ImportStatus |
|
Yes |
RagPipelineOpaqueResponse
| Name |
Type |
Description |
Required |
| RagPipelineOpaqueResponse |
|
|
|
RagPipelineRecommendedPluginQuery
| Name |
Type |
Description |
Required |
| type |
string,
Default: all |
|
No |
RagPipelineStepParametersResponse
| Name |
Type |
Description |
Required |
| variables |
|
|
Yes |
RagPipelineWorkflowPublishResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| result |
string |
|
Yes |
RagPipelineWorkflowRunQuery
| Name |
Type |
Description |
Required |
| last_id |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
RagPipelineWorkflowSyncResponse
| Name |
Type |
Description |
Required |
| hash |
string |
|
Yes |
| result |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
RateLimitError
Rate Limit Error
| Name |
Type |
Description |
Required |
| RateLimitError |
|
Rate Limit Error |
|
RecentAppListResponse
RecentAppResponse
| Name |
Type |
Description |
Required |
| author_name |
string |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
IconType |
|
No |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| maintainer |
string |
|
No |
| mode |
string,
Available values: "advanced-chat", "agent-chat", "chat", "completion", "workflow" |
Enum: "advanced-chat", "agent-chat", "chat", "completion", "workflow" |
Yes |
| name |
string |
|
Yes |
| permission_keys |
[ string ] |
|
No |
| updated_at |
integer |
|
Yes |
RecommendedAgentExportQuery
| Name |
Type |
Description |
Required |
| format |
string,
Available values: "ifpkg", "yaml",
Default: ifpkg |
Export format; defaults to ifpkg
Enum: "ifpkg", "yaml" |
No |
| version_id |
string (uuid) |
Current published template snapshot ID |
Yes |
RecommendedAppDetailResponse
| Name |
Type |
Description |
Required |
| can_trial |
boolean |
|
Yes |
| export_data |
string |
|
Yes |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| id |
string |
|
Yes |
| mode |
string |
|
Yes |
| name |
string |
|
Yes |
| package_url |
string |
Download URL for a New Agent .ifpkg template |
No |
| version_id |
string |
Published version for direct local template creation |
No |
RecommendedAppInfoResponse
| Name |
Type |
Description |
Required |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
string |
|
No |
| icon_url |
string |
|
Yes |
| id |
string |
|
Yes |
| mode |
string |
|
No |
| name |
string |
|
No |
RecommendedAppListResponse
RecommendedAppNotFoundError
Recommended app not found.
| Name |
Type |
Description |
Required |
| RecommendedAppNotFoundError |
|
Recommended app not found. |
|
RecommendedAppResponse
| Name |
Type |
Description |
Required |
| app |
RecommendedAppInfoResponse |
|
No |
| app_id |
string |
|
Yes |
| can_trial |
boolean |
|
Yes |
| categories |
[ string ] |
|
No |
| copyright |
string |
|
No |
| custom_disclaimer |
string |
|
No |
| description |
string |
|
No |
| is_listed |
boolean |
|
No |
| position |
integer |
|
No |
| privacy_policy |
string |
|
No |
RecommendedAppsQuery
| Name |
Type |
Description |
Required |
| language |
string,
Default: en-US |
Language code for recommended app localization |
No |
RecursiveJSONValue
| Name |
Type |
Description |
Required |
| RecursiveJSONValue |
string
integer
number
boolean
object
[ RecursiveJSONValue ] |
|
|
RedirectResponse
| Name |
Type |
Description |
Required |
| RedirectResponse |
string |
|
|
RedirectUrlResponse
| Name |
Type |
Description |
Required |
| redirect_url |
string |
|
Yes |
RelatedAppListResponse
RelatedAppResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| icon |
string |
|
Yes |
| icon_background |
string |
|
Yes |
| icon_type |
string |
|
Yes |
| icon_url |
string |
|
No |
| id |
string |
|
Yes |
| mode |
string |
|
Yes |
| name |
string |
|
Yes |
RemoteFileAccessDeniedError
The remote file cannot be accessed without authorization.
| Name |
Type |
Description |
Required |
| RemoteFileAccessDeniedError |
|
The remote file cannot be accessed without authorization. |
|
RemoteFileInfo
| Name |
Type |
Description |
Required |
| file_length |
integer |
|
Yes |
| file_type |
string |
|
Yes |
RemoteFileInvalidResponseError
The remote file server returned an invalid response.
| Name |
Type |
Description |
Required |
| RemoteFileInvalidResponseError |
|
The remote file server returned an invalid response. |
|
RemoteFileInvalidUrlError
The remote file URL is invalid.
| Name |
Type |
Description |
Required |
| RemoteFileInvalidUrlError |
|
The remote file URL is invalid. |
|
RemoteFileNotFoundError
The remote file could not be found.
| Name |
Type |
Description |
Required |
| RemoteFileNotFoundError |
|
The remote file could not be found. |
|
RemoteFileUnavailableError
The remote file is temporarily unavailable.
| Name |
Type |
Description |
Required |
| RemoteFileUnavailableError |
|
The remote file is temporarily unavailable. |
|
RemoteFileUploadPayload
| Name |
Type |
Description |
Required |
| url |
string (uri) |
URL to fetch |
Yes |
RemoteFileUrlBlockedError
The remote file URL is not allowed.
| Name |
Type |
Description |
Required |
| RemoteFileUrlBlockedError |
|
The remote file URL is not allowed. |
|
ReplaceUserAccessPolicies
| Name |
Type |
Description |
Required |
| access_policy_ids |
[ string ] |
|
No |
| account_ids |
[ string ] |
|
No |
ReplaceUserAccessPoliciesResponse
| Name |
Type |
Description |
Required |
| access_policies |
[ AccessPolicy ] |
|
No |
RequestLog
| Name |
Type |
Description |
Required |
| created_at |
dateTime |
The created at of the request log |
Yes |
| endpoint |
string |
The endpoint of the request log |
Yes |
| id |
string |
The id of the request log |
Yes |
| request |
object |
The request of the request log |
Yes |
| response |
object |
The response of the request log |
Yes |
RerankMode
| Name |
Type |
Description |
Required |
| RerankMode |
string |
|
|
RerankingModel
| Name |
Type |
Description |
Required |
| reranking_model_name |
string |
Name of the reranking model. |
No |
| reranking_provider_name |
string |
Provider name of the reranking model. |
No |
ResourceAccessTokenCreatePayload
ResourceAccessTokenCreateResponse
ResourceAccessTokenListQuery
| Name |
Type |
Description |
Required |
| keyword |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
ResourceAccessTokenListResponse
ResourceAccessTokenResourcePayload
ResourceAccessTokenResourceType
| Name |
Type |
Description |
Required |
| ResourceAccessTokenResourceType |
string |
|
|
ResourceAccessTokenRowResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| last_used_at |
integer |
|
No |
| masked_token |
string |
|
Yes |
| name |
string |
|
Yes |
| relation_id |
string |
|
Yes |
| resource_id |
string |
|
Yes |
| resource_name |
string |
|
Yes |
| resource_type |
ResourceAccessTokenResourceType |
|
Yes |
| token |
string |
|
No |
| token_id |
string |
|
Yes |
| track_id |
string |
|
Yes |
ResourceAccessTokenUpdatePayload
ResourcePermissionKeys
| Name |
Type |
Description |
Required |
| permission_keys |
[ string ] |
|
No |
| resource_id |
string |
|
Yes |
ResourcePermissionSnapshot
ResourceUserAccessPolicies
ResourceUserAccessPoliciesResponse
ResourceWhitelist
| Name |
Type |
Description |
Required |
| account_ids |
[ string ] |
|
No |
ResourceWhitelistConfig
| Name |
Type |
Description |
Required |
| automatic_include_workspace_members |
boolean |
|
Yes |
RestrictModel
| Name |
Type |
Description |
Required |
| base_model_name |
string |
|
No |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
ResultResponse
| Name |
Type |
Description |
Required |
| result |
string |
|
Yes |
RetrievalMethod
| Name |
Type |
Description |
Required |
| RetrievalMethod |
string |
|
|
RetrievalModel
| Name |
Type |
Description |
Required |
| metadata_filtering_conditions |
MetadataFilteringCondition |
Restrict retrieval to chunks whose document metadata matches the given conditions. Conditions are evaluated server-side against document metadata fields. |
No |
| reranking_enable |
boolean |
Whether reranking is enabled. |
Yes |
| reranking_mode |
string,
Available values: "reranking_model", "weighted_score" |
Reranking mode. Required when reranking_enable is true. |
No |
| reranking_model |
RerankingModel |
Reranking model configuration. |
No |
| score_threshold |
number |
Minimum similarity score for results. Only effective when score threshold filtering is enabled. |
No |
| score_threshold_enabled |
boolean |
Whether score threshold filtering is enabled. |
Yes |
| search_method |
RetrievalMethod |
Search method used for retrieval. |
Yes |
| top_k |
integer |
Maximum number of results to return. |
Yes |
| weights |
WeightModel |
Weight configuration for hybrid search. |
No |
RetrievalSettingResponse
| Name |
Type |
Description |
Required |
| retrieval_method |
[ string ] |
|
Yes |
RetrieverResource
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| created_at |
integer |
|
No |
| data_source_type |
string |
|
No |
| dataset_id |
string |
|
No |
| dataset_name |
string |
|
No |
| doc_metadata |
object |
|
No |
| document_id |
string |
|
No |
| document_name |
string |
|
No |
| files |
[ object ] |
|
No |
| hit_count |
integer |
|
No |
| id |
string (uuid) |
|
No |
| index_node_hash |
string |
|
No |
| message_id |
string (uuid) |
|
No |
| page |
integer |
|
No |
| position |
integer |
|
Yes |
| retriever_from |
string |
|
No |
| score |
number |
|
No |
| segment_id |
string |
|
No |
| segment_position |
integer |
|
No |
| summary |
string |
|
No |
| title |
string |
|
No |
| word_count |
integer |
|
No |
RoleAlreadyAssignedError
Role already assigned.
| Name |
Type |
Description |
Required |
| RoleAlreadyAssignedError |
|
Role already assigned. |
|
RoleBindingsResponse
RosterAgentPackageExportFailedError
The Roster Agent package could not be exported.
| Name |
Type |
Description |
Required |
| RosterAgentPackageExportFailedError |
|
The Roster Agent package could not be exported. |
|
RosterAgentPackageImportFailedError
The Roster Agent package could not be imported.
| Name |
Type |
Description |
Required |
| RosterAgentPackageImportFailedError |
|
The Roster Agent package could not be imported. |
|
RosterAgentPackageResourceUnavailableError
The Roster Agent package resources could not be stored.
| Name |
Type |
Description |
Required |
| RosterAgentPackageResourceUnavailableError |
|
The Roster Agent package resources could not be stored. |
|
RosterAgentPackageTooLargeError
The Roster Agent package exceeds the size limit.
| Name |
Type |
Description |
Required |
| RosterAgentPackageTooLargeError |
|
The Roster Agent package exceeds the size limit. |
|
RosterListQuery
| Name |
Type |
Description |
Required |
| keyword |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
Rule
| Name |
Type |
Description |
Required |
| parent_mode |
string,
Available values: "full-doc", "paragraph" |
Parent-child segmentation mode. |
No |
| pre_processing_rules |
[ PreProcessingRule ] |
Pre-processing rules to apply before segmentation. |
No |
| segmentation |
Segmentation |
Parent chunk segmentation settings. |
No |
| subchunk_segmentation |
Segmentation |
Child chunk segmentation settings. |
No |
RuleCodeGeneratePayload
| Name |
Type |
Description |
Required |
| code_language |
string,
Default: javascript |
Programming language for code generation |
No |
| instruction |
string |
Rule generation instruction |
Yes |
| model_config |
ModelConfig |
Model configuration |
Yes |
| no_variable |
boolean |
Whether to exclude variables |
No |
RuleGeneratePayload
| Name |
Type |
Description |
Required |
| instruction |
string |
Rule generation instruction |
Yes |
| model_config |
ModelConfig |
Model configuration |
Yes |
| no_variable |
boolean |
Whether to exclude variables |
No |
RuleStructuredOutputPayload
| Name |
Type |
Description |
Required |
| instruction |
string |
Structured output generation instruction |
Yes |
| model_config |
ModelConfig |
Model configuration |
Yes |
SSOProtocol
| Name |
Type |
Description |
Required |
| SSOProtocol |
string |
|
|
SandboxDownloadResponse
| Name |
Type |
Description |
Required |
| url |
string |
|
Yes |
SandboxFileEntryResponse
| Name |
Type |
Description |
Required |
| mtime |
integer |
|
No |
| name |
string |
|
Yes |
| size |
integer |
|
No |
| type |
string,
Available values: "dir", "file", "other", "symlink" |
Enum: "dir", "file", "other", "symlink" |
Yes |
SandboxInfoResponse
| Name |
Type |
Description |
Required |
| workspace_cwd |
string |
|
Yes |
SandboxListResponse
SandboxReadResponse
| Name |
Type |
Description |
Required |
| binary |
boolean |
|
Yes |
| path |
string |
|
Yes |
| size |
integer |
|
No |
| text |
string |
|
No |
| truncated |
boolean |
|
Yes |
SavedMessageCreatePayload
| Name |
Type |
Description |
Required |
| message_id |
string |
|
Yes |
| Name |
Type |
Description |
Required |
| data |
[ SavedMessageItem ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
SavedMessageItem
| Name |
Type |
Description |
Required |
| answer |
string |
|
Yes |
| created_at |
integer |
|
No |
| feedback |
SimpleFeedback |
|
No |
| id |
string |
|
Yes |
| inputs |
object |
|
Yes |
| message_files |
[ MessageFile ] |
|
Yes |
| query |
string |
|
Yes |
SavedMessageListQuery
| Name |
Type |
Description |
Required |
| last_id |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
SchemaDefinitionItemResponse
| Name |
Type |
Description |
Required |
| label |
string |
|
Yes |
| name |
string |
|
Yes |
| schema |
object |
|
Yes |
SchemaDefinitionsResponse
| Name |
Type |
Description |
Required |
| SchemaDefinitionsResponse |
array |
|
|
SegmentAttachmentResponse
| Name |
Type |
Description |
Required |
| extension |
string |
|
Yes |
| id |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| name |
string |
|
Yes |
| size |
integer |
|
Yes |
| source_url |
string |
|
Yes |
SegmentBatchImportStatusResponse
| Name |
Type |
Description |
Required |
| job_id |
string |
|
Yes |
| job_status |
string |
|
Yes |
SegmentCreatePayload
| Name |
Type |
Description |
Required |
| answer |
string |
|
No |
| attachment_ids |
[ string ] |
|
No |
| content |
string |
|
Yes |
| keywords |
[ string ] |
|
No |
SegmentDetailResponse
| Name |
Type |
Description |
Required |
| data |
SegmentResponse |
|
Yes |
| doc_form |
string |
|
Yes |
SegmentIdListQuery
| Name |
Type |
Description |
Required |
| segment_id |
[ string ] |
Segment IDs |
No |
SegmentListQuery
| Name |
Type |
Description |
Required |
| enabled |
string,
Default: all |
|
No |
| hit_count_gte |
integer |
|
No |
| keyword |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
| status |
[ string ] |
|
No |
SegmentResponse
| Name |
Type |
Description |
Required |
| answer |
string |
|
Yes |
| attachments |
[ SegmentAttachmentResponse ] |
|
Yes |
| child_chunks |
[ ChildChunkResponse ] |
|
Yes |
| completed_at |
integer |
|
Yes |
| content |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| disabled_at |
integer |
|
Yes |
| disabled_by |
string |
|
Yes |
| document_id |
string |
|
Yes |
| enabled |
boolean |
|
Yes |
| error |
string |
|
Yes |
| hit_count |
integer |
|
Yes |
| id |
string |
|
Yes |
| index_node_hash |
string |
|
Yes |
| index_node_id |
string |
|
Yes |
| indexing_at |
integer |
|
Yes |
| keywords |
[ string ] |
|
Yes |
| position |
integer |
|
Yes |
| sign_content |
string |
|
Yes |
| status |
string |
|
Yes |
| stopped_at |
integer |
|
Yes |
| summary |
string |
|
Yes |
| tokens |
integer |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| word_count |
integer |
|
Yes |
SegmentUpdatePayload
| Name |
Type |
Description |
Required |
| answer |
string |
|
No |
| attachment_ids |
[ string ] |
|
No |
| content |
string |
|
Yes |
| keywords |
[ string ] |
|
No |
| regenerate_child_chunks |
boolean |
|
No |
| summary |
string |
|
No |
Segmentation
| Name |
Type |
Description |
Required |
| chunk_overlap |
integer |
Token overlap between chunks. |
No |
| max_tokens |
integer |
Maximum token count per chunk. |
Yes |
| separator |
string,
Default: |
|
|
| Custom separator for splitting text. |
No |
|
|
SelectInputConfig
| Name |
Type |
Description |
Required |
| option_source |
StringListSource |
Source of options for select inputs. Present only when type is select. |
Yes |
| output_variable_name |
string |
|
Yes |
| type |
string |
|
No |
ShallowJSONValue
| Name |
Type |
Description |
Required |
| ShallowJSONValue |
string
integer
number
boolean
object
[ object ] |
|
|
SimpleAccount
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
SimpleAccountResponse
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
SimpleConversation
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| id |
string (uuid) |
|
Yes |
| inputs |
object |
|
Yes |
| introduction |
string |
|
No |
| name |
string |
|
Yes |
| status |
string |
|
Yes |
| updated_at |
integer |
|
No |
SimpleDataResponse
| Name |
Type |
Description |
Required |
| data |
string |
|
Yes |
SimpleEndUser
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| is_anonymous |
boolean |
|
Yes |
| session_id |
string |
|
No |
| type |
string |
|
Yes |
SimpleFeedback
| Name |
Type |
Description |
Required |
| rating |
string |
|
No |
SimpleMessageDetail
| Name |
Type |
Description |
Required |
| answer |
string |
|
Yes |
| inputs |
object |
|
Yes |
| message |
string |
|
Yes |
| query |
string |
|
Yes |
SimpleModelConfig
| Name |
Type |
Description |
Required |
| model |
AnyJSONValue |
|
No |
| pre_prompt |
string |
|
No |
SimpleProviderEntityResponse
Simple provider entity response.
SimpleResultDataResponse
| Name |
Type |
Description |
Required |
| data |
string |
|
Yes |
| result |
string |
|
Yes |
SimpleResultMessageResponse
| Name |
Type |
Description |
Required |
| message |
string |
|
Yes |
| result |
string |
|
Yes |
SimpleResultOptionalDataResponse
| Name |
Type |
Description |
Required |
| data |
string |
|
No |
| result |
string |
|
Yes |
SimpleResultResponse
| Name |
Type |
Description |
Required |
| result |
string |
Operation result. |
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 |
| input_placeholder |
string |
|
No |
| privacy_policy |
string |
|
No |
| show_workflow_steps |
boolean |
|
Yes |
| title |
string |
|
Yes |
| use_icon_as_answer_icon |
boolean |
|
Yes |
SkillAssistAttachmentPayload
| Name |
Type |
Description |
Required |
| mime_type |
string |
|
No |
| name |
string |
|
Yes |
| size |
integer |
|
No |
| tool_file_id |
string |
|
Yes |
SkillAssistHistoryMessagePayload
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
| role |
string,
Available values: "assistant", "user" |
Enum: "assistant", "user" |
Yes |
| suggested_display_name |
string |
|
No |
| suggested_name |
string |
|
No |
SkillAssistMessagePayload
One user message and optional uploaded context for the Skill Authoring assistant.
SkillAssistModelPayload
| Name |
Type |
Description |
Required |
| model |
string |
|
Yes |
| model_settings |
object |
|
No |
| plugin_id |
string |
|
No |
| provider |
string |
|
Yes |
SkillCreatePayload
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| display_name |
string |
|
No |
| icon |
string,
Default: 📄 |
|
No |
| name |
string |
|
No |
| tags |
[ string ] |
|
No |
SkillDeletePayload
| Name |
Type |
Description |
Required |
| confirmation_name |
string |
Required when deleting a referenced Skill. Must match the Skill display name. |
No |
SkillDeleteResponse
| Name |
Type |
Description |
Required |
| deleted |
boolean |
|
Yes |
| id |
string |
|
Yes |
SkillDetailResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
No |
| created_by_name |
string |
|
No |
| description |
string |
|
Yes |
| display_name |
string |
|
Yes |
| files |
[ SkillFileResponse ] |
|
No |
| icon |
string |
|
Yes |
| id |
string |
|
Yes |
| latest_published_at |
integer |
|
No |
| latest_published_version_id |
string |
|
No |
| latest_published_version_number |
integer |
|
No |
| name |
string |
|
Yes |
| name_manually_edited |
boolean |
|
No |
| reference_count |
integer |
|
No |
| tags |
[ string ] |
|
No |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
No |
| updated_by_name |
string |
|
No |
| visibility |
string |
|
Yes |
SkillDraftFileCheckItemPayload
| Name |
Type |
Description |
Required |
| filename |
string |
|
Yes |
| mime_type |
string |
|
No |
| path |
string |
Target draft path. Defaults to filename. |
No |
| size |
integer |
|
Yes |
SkillDraftFileCheckPayload
SkillDraftFileOperation
| Name |
Type |
Description |
Required |
| SkillDraftFileOperation |
string |
|
|
SkillDraftFileOperationPayload
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| expected_updated_at |
integer |
|
No |
| hash |
string |
|
No |
| mime_type |
string |
|
No |
| operation |
SkillDraftFileOperation |
|
Yes |
| path |
string |
|
Yes |
| size |
integer |
|
No |
| target_path |
string |
|
No |
| tool_file_id |
string |
|
No |
SkillDraftTreeItemPayload
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| hash |
string |
|
No |
| kind |
SkillFileKind |
|
No |
| mime_type |
string |
|
No |
| path |
string |
|
Yes |
| size |
integer |
|
No |
| storage |
SkillFileStorage |
|
No |
| tool_file_id |
string |
|
No |
SkillDraftTreePayload
SkillFileCheckErrorResponse
| Name |
Type |
Description |
Required |
| code |
string |
|
Yes |
| message |
string |
|
Yes |
SkillFileCheckItemResponse
| Name |
Type |
Description |
Required |
| errors |
[ SkillFileCheckErrorResponse ] |
|
No |
| extension |
string |
|
Yes |
| filename |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| path |
string |
|
Yes |
| size |
integer |
|
Yes |
SkillFileCheckResponse
| Name |
Type |
Description |
Required |
| data |
object |
|
No |
SkillFileKind
Draft file entry kind.
| Name |
Type |
Description |
Required |
| SkillFileKind |
string |
Draft file entry kind. |
|
SkillFilePreviewResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
| hash |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| path |
string |
|
Yes |
| size |
integer |
|
Yes |
SkillFileQuery
| Name |
Type |
Description |
Required |
| path |
string |
Skill file path relative to the Skill root. |
Yes |
| version_id |
string |
Optional published version ID. Omit for current draft. |
No |
SkillFileResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
No |
| hash |
string |
|
No |
| id |
string |
|
No |
| kind |
string |
|
Yes |
| mime_type |
string |
|
No |
| path |
string |
|
Yes |
| size |
integer |
|
No |
| storage |
string |
|
No |
| tool_file_id |
string |
|
No |
SkillFileStorage
How a draft file's content is stored.
| Name |
Type |
Description |
Required |
| SkillFileStorage |
string |
How a draft file's content is stored. |
|
SkillFileUploadResponse
| Name |
Type |
Description |
Required |
| hash |
string |
|
Yes |
| id |
string |
|
Yes |
| mime_type |
string |
|
Yes |
| name |
string |
|
Yes |
| size |
integer |
|
Yes |
SkillListResponse
| Name |
Type |
Description |
Required |
| data |
[ SkillResponse ] |
|
No |
| has_more |
boolean |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
| total |
integer |
|
No |
SkillMetadataPayload
| Name |
Type |
Description |
Required |
| display_name |
string |
|
No |
| expected_updated_at |
integer |
|
No |
| icon |
string |
|
No |
| tags |
[ string ] |
|
No |
SkillPublishPayload
| Name |
Type |
Description |
Required |
| publish_note |
string |
|
No |
| version_name |
string |
|
No |
SkillReferenceListResponse
SkillReferenceResponse
| Name |
Type |
Description |
Required |
| agent_icon |
string |
|
No |
| agent_icon_background |
string |
|
No |
| agent_icon_type |
string |
|
No |
| agent_id |
string |
|
Yes |
| app_id |
string |
|
No |
| display_name |
string |
|
Yes |
| name |
string |
|
Yes |
| node_id |
string |
|
No |
| node_name |
string |
|
No |
| type |
string |
|
Yes |
| workflow_icon |
string |
|
No |
| workflow_icon_background |
string |
|
No |
| workflow_icon_type |
string |
|
No |
| workflow_id |
string |
|
No |
| workflow_name |
string |
|
No |
| workflow_version |
string |
|
No |
SkillResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
No |
| created_by_name |
string |
|
No |
| description |
string |
|
Yes |
| display_name |
string |
|
Yes |
| icon |
string |
|
Yes |
| id |
string |
|
Yes |
| latest_published_at |
integer |
|
No |
| latest_published_version_id |
string |
|
No |
| latest_published_version_number |
integer |
|
No |
| name |
string |
|
Yes |
| name_manually_edited |
boolean |
|
No |
| reference_count |
integer |
|
No |
| tags |
[ string ] |
|
No |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
No |
| updated_by_name |
string |
|
No |
| visibility |
string |
|
Yes |
SkillRestorePayload
| Name |
Type |
Description |
Required |
| publish_note |
string |
|
No |
| version_id |
string |
|
Yes |
| version_name |
string |
|
No |
SkillTagListResponse
SkillTagResponse
| Name |
Type |
Description |
Required |
| count |
integer |
|
Yes |
| tag |
string |
|
Yes |
SkillVersionDeleteResponse
| Name |
Type |
Description |
Required |
| deleted |
boolean |
|
Yes |
| id |
string |
|
Yes |
| latest_published_version_id |
string |
|
No |
SkillVersionDetailResponse
| Name |
Type |
Description |
Required |
| archive_size |
integer |
|
Yes |
| created_at |
integer |
|
Yes |
| files |
[ SkillFileResponse ] |
|
No |
| hash_code |
string |
|
Yes |
| id |
string |
|
Yes |
| is_latest |
boolean |
|
No |
| publish_note |
string |
|
Yes |
| published_by |
string |
|
No |
| published_by_name |
string |
|
No |
| skill_id |
string |
|
Yes |
| version_name |
string |
|
Yes |
| version_number |
integer |
|
Yes |
SkillVersionListResponse
SkillVersionResponse
| Name |
Type |
Description |
Required |
| archive_size |
integer |
|
Yes |
| created_at |
integer |
|
Yes |
| hash_code |
string |
|
Yes |
| id |
string |
|
Yes |
| is_latest |
boolean |
|
No |
| publish_note |
string |
|
Yes |
| published_by |
string |
|
No |
| published_by_name |
string |
|
No |
| skill_id |
string |
|
Yes |
| version_name |
string |
|
Yes |
| version_number |
integer |
|
Yes |
SkillVersionUpdatePayload
| Name |
Type |
Description |
Required |
| publish_note |
string |
|
No |
| version_name |
string |
|
No |
SnippetDependencyCheckResponse
SnippetDraftConfigResponse
| Name |
Type |
Description |
Required |
| parallel_depth_limit |
integer |
|
Yes |
SnippetDraftNodeRunPayload
Payload for running a single node in snippet draft workflow.
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
| query |
string |
|
No |
SnippetDraftRunPayload
Payload for running snippet draft workflow.
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
SnippetDraftSyncPayload
Payload for syncing snippet draft workflow.
| Name |
Type |
Description |
Required |
| conversation_variables |
[ object ] |
Ignored. Snippet workflows do not persist conversation variables. |
No |
| graph |
object |
|
Yes |
| hash |
string |
|
No |
| input_fields |
[ object ] |
|
No |
SnippetExportQuery
Query parameters for exporting a snippet workflow as DSL.
| Name |
Type |
Description |
Required |
| include_secret |
string,
Default: false |
Whether to include secret variables |
No |
| workflow_id |
string |
Specific published workflow version to export |
No |
SnippetImportPayload
Payload for importing snippet from DSL.
| Name |
Type |
Description |
Required |
| description |
string |
Override snippet description |
No |
| mode |
string |
Import mode: yaml-content or yaml-url |
Yes |
| name |
string |
Override snippet name |
No |
| snippet_id |
string |
Snippet ID to update (optional) |
No |
| yaml_content |
string |
YAML content (required for yaml-content mode) |
No |
| yaml_url |
string |
YAML URL (required for yaml-url mode) |
No |
SnippetImportResponse
| Name |
Type |
Description |
Required |
| current_dsl_version |
string |
|
Yes |
| error |
string |
|
Yes |
| id |
string |
|
Yes |
| imported_dsl_version |
string |
|
Yes |
| snippet_id |
string |
|
Yes |
| status |
ImportStatus |
|
Yes |
| warnings |
[ DslImportWarning ] |
|
Yes |
SnippetIterationNodeRunPayload
Payload for running an iteration node in snippet draft workflow.
| Name |
Type |
Description |
Required |
| inputs |
object |
|
No |
SnippetListItemResponse
| Name |
Type |
Description |
Required |
| author_name |
string |
|
Yes |
| created_at |
integer |
|
Yes |
| created_by |
string |
|
Yes |
| description |
string |
|
Yes |
| icon_info |
object |
|
Yes |
| id |
string |
|
Yes |
| is_published |
boolean |
|
Yes |
| name |
string |
|
Yes |
| tags |
[ SnippetTagResponse ] |
|
Yes |
| type |
SnippetType |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
string |
|
Yes |
| use_count |
integer |
|
Yes |
| version |
integer |
|
Yes |
SnippetListQuery
Query parameters for listing snippets.
| Name |
Type |
Description |
Required |
| creators |
[ string ] |
Filter by creator account IDs |
No |
| is_published |
boolean |
Filter by published status |
No |
| keyword |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
| tag_ids |
[ string ] |
Filter by tag IDs |
No |
SnippetLoopNodeRunPayload
Payload for running a loop node in snippet draft workflow.
| Name |
Type |
Description |
Required |
| inputs |
object |
|
No |
| Name |
Type |
Description |
Required |
| data |
[ SnippetListItemResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
SnippetPublishWorkflowPayload
Payload for publishing snippet workflow.
| Name |
Type |
Description |
Required |
| knowledge_base_setting |
object |
|
No |
| marked_comment |
string |
|
No |
| marked_name |
string |
|
No |
SnippetResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| created_by |
SimpleAccountResponse |
|
Yes |
| description |
string |
|
Yes |
| graph |
object |
|
Yes |
| icon_info |
object |
|
Yes |
| id |
string |
|
Yes |
| input_fields |
[ object ] |
|
Yes |
| is_published |
boolean |
|
Yes |
| name |
string |
|
Yes |
| tags |
[ SnippetTagResponse ] |
|
Yes |
| type |
SnippetType |
|
Yes |
| updated_at |
integer |
|
Yes |
| updated_by |
SimpleAccountResponse |
|
Yes |
| use_count |
integer |
|
Yes |
| version |
integer |
|
Yes |
SnippetTagResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
SnippetType
Snippet Type Enum
| Name |
Type |
Description |
Required |
| SnippetType |
string |
Snippet Type Enum |
|
SnippetUseCountResponse
| Name |
Type |
Description |
Required |
| result |
string |
|
Yes |
| use_count |
integer |
|
Yes |
SnippetWorkflowListQuery
Query parameters for listing snippet published workflows.
| Name |
Type |
Description |
Required |
| limit |
integer,
Default: 10 |
|
No |
| page |
integer,
Default: 1 |
|
No |
| Name |
Type |
Description |
Required |
| has_more |
boolean |
|
Yes |
| items |
[ SnippetWorkflowResponse ] |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
SnippetWorkflowResponse
SnippetWorkflowRunQuery
Query parameters for workflow runs.
| Name |
Type |
Description |
Required |
| last_id |
string |
|
No |
| limit |
integer,
Default: 20 |
|
No |
SpeechToTextDisabledError
Speech to text is disabled.
| Name |
Type |
Description |
Required |
| SpeechToTextDisabledError |
|
Speech to text is disabled. |
|
StarredAppListQuery
| Name |
Type |
Description |
Required |
| creator_ids |
[ string ] |
Filter by creator account IDs |
No |
| is_created_by_me |
boolean |
Filter by creator |
No |
| limit |
integer,
Default: 20 |
Page size (1-100) |
No |
| mode |
string,
Available values: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow",
Default: all |
App mode filter
Enum: "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow" |
No |
| name |
string |
Filter by app name |
No |
| openapi_visible |
boolean |
Only return apps with API access enabled |
No |
| page |
integer,
Default: 1 |
Page number (1-99999) |
No |
| sort_by |
string,
Available values: "earliest_created", "last_modified", "recently_created",
Default: last_modified |
Sort apps by last modified, recently created, or earliest created
Enum: "earliest_created", "last_modified", "recently_created" |
No |
| tag_ids |
[ string ] |
Filter by tag IDs |
No |
StatisticTimeRangeQuery
| Name |
Type |
Description |
Required |
| end |
string |
End date (YYYY-MM-DD HH:MM) |
No |
| start |
string |
Start date (YYYY-MM-DD HH:MM) |
No |
StatusCount
| Name |
Type |
Description |
Required |
| failed |
integer |
|
Yes |
| partial_success |
integer |
|
Yes |
| paused |
integer |
|
Yes |
| success |
integer |
|
Yes |
StepByStepTourStatePatchPayload
| Name |
Type |
Description |
Required |
| action |
string,
Available values: "complete_task", "disable_current_workspace", "enable_current_workspace", "skip", "uncomplete_task" |
State update action
Enum: "complete_task", "disable_current_workspace", "enable_current_workspace", "skip", "uncomplete_task" |
Yes |
| task_id |
string,
Available values: "home", "integration", "knowledge", "studio" |
Task ID for task actions |
No |
StepByStepTourStateResponse
| Name |
Type |
Description |
Required |
| completed_task_ids |
[ string,
Available values: "home", "integration", "knowledge", "studio" ] |
|
No |
| first_workspace_id |
string |
|
No |
| manually_disabled_workspace_ids |
[ string ] |
|
No |
| manually_enabled_workspace_ids |
[ string ] |
|
No |
| skipped |
boolean |
|
No |
| updated_at |
string |
|
No |
Storage
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| size |
integer,
Default: 1048576 |
|
No |
StringListSource
| Name |
Type |
Description |
Required |
| selector |
[ string ] |
Variable reference path when type is variable. |
No |
| type |
ValueSourceType |
Origin of the options. constant means value lists the options literally; variable means selector points to an array[string] workflow variable that provides them. |
Yes |
| value |
[ string ] |
Literal option list when type is constant. |
No |
StringSource
Default configuration for form inputs.
| Name |
Type |
Description |
Required |
| selector |
[ string ] |
|
No |
| type |
ValueSourceType |
|
Yes |
| value |
string |
|
No |
StructuredOutputGenerateResponse
| Name |
Type |
Description |
Required |
| error |
string |
Failure reason, empty on success |
Yes |
| output |
string |
Generated JSON Schema, empty when generation failed |
Yes |
SubscriptionBuilderApiEntity
| Name |
Type |
Description |
Required |
| credential_type |
CredentialType |
The credential type of the subscription builder |
Yes |
| credentials |
object |
The credentials of the subscription builder |
Yes |
| endpoint |
string |
The endpoint id of the subscription builder |
Yes |
| id |
string |
The id of the subscription builder |
Yes |
| name |
string |
The name of the subscription builder |
Yes |
| parameters |
object |
The parameters of the subscription builder |
Yes |
| properties |
object |
The properties of the subscription builder |
Yes |
| provider |
string |
The provider id of the subscription builder |
Yes |
SubscriptionConstructor
The subscription constructor of the trigger provider
| Name |
Type |
Description |
Required |
| credentials_schema |
[ ProviderConfig ] |
The credentials schema of the subscription constructor |
No |
| oauth_schema |
OAuthSchema |
The OAuth schema of the subscription constructor if OAuth is supported |
No |
| parameters |
[ EventParameter ] |
The parameters schema of the subscription constructor |
No |
SubscriptionModel
| Name |
Type |
Description |
Required |
| interval |
string |
|
Yes |
| plan |
CloudPlan |
|
Yes |
SubscriptionQuery
| Name |
Type |
Description |
Required |
| interval |
string,
Available values: "month", "year" |
Billing interval
Enum: "month", "year" |
Yes |
| plan |
string,
Available values: "professional", "team" |
Subscription plan
Enum: "professional", "team" |
Yes |
SuccessResponse
| Name |
Type |
Description |
Required |
| success |
boolean |
|
Yes |
SuggestedQuestionsResponse
| Name |
Type |
Description |
Required |
| data |
[ string ] |
|
Yes |
SummaryEntryResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| error |
string |
|
No |
| segment_id |
string |
|
Yes |
| segment_position |
integer |
|
Yes |
| status |
string |
|
Yes |
| summary_preview |
string |
|
No |
| updated_at |
integer |
|
No |
SummaryStatusResponse
| Name |
Type |
Description |
Required |
| completed |
integer |
|
No |
| error |
integer |
|
No |
| generating |
integer |
|
No |
| not_started |
integer |
|
No |
| timeout |
integer |
|
No |
SwitchWorkspacePayload
| Name |
Type |
Description |
Required |
| tenant_id |
string |
|
Yes |
SwitchWorkspaceResponse
SyncDraftWorkflowPayload
| Name |
Type |
Description |
Required |
| _is_collaborative |
boolean |
|
No |
| conversation_variables |
[ object ] |
|
No |
| environment_variable_patch |
SyncEnvironmentVariablePatchPayload |
|
No |
| features |
object |
|
Yes |
| force |
boolean |
Explicitly confirm saving an empty workflow graph. |
No |
| graph |
object |
|
Yes |
| hash |
string |
|
No |
SyncDraftWorkflowResponse
| Name |
Type |
Description |
Required |
| hash |
string |
|
Yes |
| result |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
SyncEnvironmentVariablePatchPayload
| Name |
Type |
Description |
Required |
| deleted_environment_variable_ids |
[ string ] |
|
No |
| environment_variables |
[ object ] |
|
No |
SystemConfigurationResponse
Model class for provider system configuration response.
SystemFeatureModel
Non-sensitive bootstrap snapshot exposed before Console or Web authentication.
| Name |
Type |
Description |
Required |
| branding |
BrandingModel |
|
Yes |
| deployment_edition |
DeploymentEdition |
|
Yes |
| enable_app_deploy |
boolean |
|
Yes |
| enable_change_email |
boolean,
Default: true |
|
Yes |
| enable_collaboration_mode |
boolean,
Default: true |
|
Yes |
| enable_creators_platform |
boolean |
|
Yes |
| enable_email_code_login |
boolean |
|
Yes |
| enable_email_password_login |
boolean,
Default: true |
|
Yes |
| enable_explore_banner |
boolean |
|
Yes |
| enable_learn_app |
boolean,
Default: true |
|
Yes |
| enable_marketplace |
boolean |
|
Yes |
| enable_social_oauth_login |
boolean |
|
Yes |
| enable_step_by_step_tour |
boolean |
|
Yes |
| is_allow_register |
boolean |
|
Yes |
| is_email_setup |
boolean |
|
Yes |
| license |
LicenseStatusModel |
|
Yes |
| plugin_installation_permission |
PluginInstallationPermissionModel |
|
Yes |
| rbac_enabled |
boolean |
|
Yes |
| sso_enforced_for_signin |
boolean |
|
Yes |
| sso_enforced_for_signin_protocol |
SSOProtocol |
|
Yes |
| webapp_auth |
WebAppAuthModel |
|
Yes |
SystemParameters
| Name |
Type |
Description |
Required |
| audio_file_size_limit |
integer |
|
Yes |
| file_size_limit |
integer |
|
Yes |
| image_file_size_limit |
integer |
|
Yes |
| video_file_size_limit |
integer |
|
Yes |
| workflow_file_upload_limit |
integer |
|
Yes |
Tag
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
TagBasePayload
| Name |
Type |
Description |
Required |
| name |
string |
Tag name |
Yes |
| type |
TagType |
|
Yes |
TagBindingPayload
| Name |
Type |
Description |
Required |
| tag_ids |
[ string ] |
Tag IDs to bind |
Yes |
| target_id |
string |
Target ID to bind tags to |
Yes |
| type |
TagType |
|
Yes |
TagBindingRemovePayload
| Name |
Type |
Description |
Required |
| tag_ids |
[ string ] |
Tag IDs to remove |
Yes |
| target_id |
string |
Target ID to unbind tag from |
Yes |
| type |
TagType |
|
Yes |
TagListQueryParam
| Name |
Type |
Description |
Required |
| keyword |
string |
Search keyword |
No |
| type |
string,
Available values: "app", "knowledge", "skill", "snippet" |
Tag type filter
Enum: "app", "knowledge", "skill", "snippet" |
Yes |
TagListResponse
| Name |
Type |
Description |
Required |
| TagListResponse |
array |
|
|
TagResponse
| Name |
Type |
Description |
Required |
| binding_count |
string |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
No |
TagType
Tag type
| Name |
Type |
Description |
Required |
| TagType |
string |
Tag type |
|
TagUpdateRequestPayload
| Name |
Type |
Description |
Required |
| name |
string |
Tag name |
Yes |
TenantAccountRole
| Name |
Type |
Description |
Required |
| TenantAccountRole |
string |
|
|
TenantInfoResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| custom_config |
WorkspaceCustomConfigResponse |
|
No |
| id |
string |
|
Yes |
| in_trial |
boolean |
|
No |
| name |
string |
|
No |
| next_credit_reset_date |
integer |
|
No |
| plan |
CloudPlan |
|
No |
| role |
string |
|
No |
| status |
string |
|
No |
| trial_credits |
integer |
|
No |
| trial_credits_exhausted_at |
integer |
|
No |
| trial_credits_used |
integer |
|
No |
| trial_end_reason |
string |
|
No |
TenantListItemResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| current |
boolean |
|
Yes |
| id |
string |
|
Yes |
| last_opened_at |
integer |
|
No |
| name |
string |
|
No |
| plan |
CloudPlan |
|
No |
| status |
string |
|
No |
TenantListResponse
TenantPluginAutoUpgradeCategory
| Name |
Type |
Description |
Required |
| TenantPluginAutoUpgradeCategory |
string |
|
|
TenantPluginAutoUpgradeMode
| Name |
Type |
Description |
Required |
| TenantPluginAutoUpgradeMode |
string |
|
|
TenantPluginAutoUpgradeStrategySetting
| Name |
Type |
Description |
Required |
| TenantPluginAutoUpgradeStrategySetting |
string |
|
|
TenantPluginDebugPermission
| Name |
Type |
Description |
Required |
| TenantPluginDebugPermission |
string |
|
|
TenantPluginInstallPermission
| Name |
Type |
Description |
Required |
| TenantPluginInstallPermission |
string |
|
|
TextContentResponse
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
TextFileResponse
| Name |
Type |
Description |
Required |
| TextFileResponse |
string |
|
|
TextToAudioPayload
| Name |
Type |
Description |
Required |
| message_id |
string |
Message ID. Takes priority over text when both are provided. |
No |
| streaming |
boolean |
Reserved for compatibility; TTS response streaming is determined by the provider output. |
No |
| text |
string |
Speech content to convert. |
No |
| voice |
string |
Voice to use for text-to-speech. Available voices depend on the TTS provider configured for this app. Omit to use the app's configured voice when available; that value is exposed by Get App Parameters as text_to_speech.voice. |
No |
TextToSpeechPayload
| Name |
Type |
Description |
Required |
| message_id |
string |
Message ID |
No |
| streaming |
boolean |
Whether to stream audio |
No |
| text |
string |
Text to convert |
Yes |
| voice |
string |
Voice name |
No |
TextToSpeechRequest
| Name |
Type |
Description |
Required |
| message_id |
string |
|
No |
| streaming |
boolean |
|
No |
| text |
string |
|
No |
| voice |
string |
|
No |
TextToSpeechVoiceListResponse
Available voices
| Name |
Type |
Description |
Required |
| TextToSpeechVoiceListResponse |
array |
Available voices |
|
TextToSpeechVoiceQuery
| Name |
Type |
Description |
Required |
| language |
string |
Language code |
Yes |
TextToSpeechVoiceResponse
| Name |
Type |
Description |
Required |
| name |
string |
Voice display name |
Yes |
| value |
string |
Voice identifier |
Yes |
TokensPerSecondStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| tps |
number |
|
Yes |
TokensPerSecondStatisticResponse
TooManyFilesError
Only one file is allowed.
| Name |
Type |
Description |
Required |
| TooManyFilesError |
|
Only one file is allowed. |
|
Tool
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
ToolApiEntity
| Name |
Type |
Description |
Required |
| author |
string |
|
Yes |
| description |
I18nObject |
|
Yes |
| label |
I18nObject |
|
Yes |
| labels |
[ string ] |
|
No |
| name |
string |
|
Yes |
| output_schema |
object |
|
No |
| parameters |
[ ToolParameter ] |
|
No |
ToolApiListResponse
| Name |
Type |
Description |
Required |
| ToolApiListResponse |
array |
|
|
ToolEmojiIcon
| Name |
Type |
Description |
Required |
| background |
string |
|
Yes |
| content |
string |
|
Yes |
ToolLabel
Tool label
| Name |
Type |
Description |
Required |
| icon |
string |
The icon of the tool |
Yes |
| label |
I18nObject |
The label of the tool |
Yes |
| name |
string |
The name of the tool |
Yes |
ToolLabelEnum
| Name |
Type |
Description |
Required |
| ToolLabelEnum |
string |
|
|
ToolLabelListResponse
| Name |
Type |
Description |
Required |
| ToolLabelListResponse |
array |
|
|
ToolOAuthAuthorizationQuery
| Name |
Type |
Description |
Required |
| visibility |
string,
Available values: "all_team_members", "only_me" |
Visibility for the OAuth credential. Defaults to 'only_me'. |
No |
ToolOAuthCustomClientPayload
| Name |
Type |
Description |
Required |
| client_params |
object |
|
No |
| enable_oauth_custom_client |
boolean |
|
No |
ToolParameter
Tool-specific parameter declaration and invocation-value normalization.
| Name |
Type |
Description |
Required |
| auto_generate |
PluginParameterAutoGenerate |
|
No |
| default |
number
integer
string
boolean
[ object ]
object |
|
No |
| form |
ToolParameterForm |
The form of the parameter, schema/form/llm |
Yes |
| human_description |
I18nObject |
The description presented to the user |
No |
| input_schema |
object |
|
No |
| label |
I18nObject |
The label presented to the user |
Yes |
| llm_description |
string |
|
No |
| max |
number
integer |
|
No |
| min |
number
integer |
|
No |
| multiple |
boolean |
Whether the parameter is multiple select, only valid for select or dynamic-select type |
No |
| name |
string |
The name of the parameter |
Yes |
| options |
[ PluginParameterOption ] |
|
No |
| placeholder |
I18nObject |
The placeholder presented to the user |
No |
| precision |
integer |
|
No |
| required |
boolean |
|
No |
| scope |
string |
|
No |
| template |
PluginParameterTemplate |
|
No |
| type |
ToolParameterType |
The type of the parameter |
Yes |
ToolParameterForm
| Name |
Type |
Description |
Required |
| ToolParameterForm |
string |
|
|
ToolParameterType
removes TOOLS_SELECTOR from PluginParameterType
| Name |
Type |
Description |
Required |
| ToolParameterType |
string |
removes TOOLS_SELECTOR from PluginParameterType |
|
ToolProviderApiEntityResponse
| Name |
Type |
Description |
Required |
| allow_delete |
boolean,
Default: true |
|
No |
| authentication |
MCPAuthentication |
The OAuth config of the MCP tool |
No |
| author |
string |
|
Yes |
| configuration |
MCPConfiguration |
The timeout and sse_read_timeout of the MCP tool |
No |
| description |
I18nObject |
|
Yes |
| icon |
string
object |
|
Yes |
| icon_dark |
string
object |
|
No |
| id |
string |
|
Yes |
| identity_mode |
string,
Default: off |
Identity-forwarding mechanism: 'off' or 'idp_token' |
No |
| is_dynamic_registration |
boolean,
Default: true |
Whether the MCP tool is dynamically registered |
No |
| is_team_authorization |
boolean |
|
No |
| label |
I18nObject |
|
Yes |
| labels |
[ string ] |
|
No |
| masked_headers |
object |
The masked headers of the MCP tool |
No |
| name |
string |
|
Yes |
| original_headers |
object |
The original headers of the MCP tool |
No |
| plugin_id |
string |
The plugin id of the tool |
No |
| plugin_unique_identifier |
string |
The unique identifier of the tool |
No |
| server_identifier |
string |
The server identifier of the MCP tool |
No |
| server_url |
string |
The server url of the tool |
No |
| team_credentials |
object |
|
No |
| tools |
[ ToolApiEntity ] |
|
No |
| type |
ToolProviderType |
|
Yes |
| updated_at |
integer |
|
No |
| workflow_app_id |
string |
The app id of the workflow tool |
No |
ToolProviderCredentialApiEntity
| Name |
Type |
Description |
Required |
| created_by |
string |
User ID of the credential creator |
No |
| credential_type |
CredentialType |
The type of the credential |
Yes |
| credentials |
object |
The credentials of the provider |
No |
| from_other_member |
boolean |
True when this credential is being returned only because a workflow/agent node still references it but it would normally be hidden from this user by the visibility filter (another member's only_me credential). The frontend renders it as 'borrowed' — selectable until the node switches away, but not editable/deletable. |
No |
| id |
string |
The unique id of the credential |
Yes |
| is_default |
boolean |
Whether the credential is the default credential for the provider in the workspace |
No |
| name |
string |
The name of the credential |
Yes |
| partial_member_list |
[ string ] |
List of user IDs allowed when visibility is partial_members |
No |
| provider |
string |
The provider of the credential |
Yes |
| visibility |
string,
Default: all_team_members |
Credential visibility: only_me, all_team_members, or partial_members |
No |
ToolProviderCredentialInfoApiEntity
| Name |
Type |
Description |
Required |
| credentials |
[ ToolProviderCredentialApiEntity ] |
The credentials of the provider |
Yes |
| is_oauth_custom_client_enabled |
boolean |
Whether the OAuth custom client is enabled for the provider |
No |
| supported_credential_types |
[ CredentialType ] |
The supported credential types of the provider |
Yes |
ToolProviderCredentialListResponse
| Name |
Type |
Description |
Required |
| ToolProviderCredentialListResponse |
array |
|
|
ToolProviderEntity
ToolProviderIdentity
| Name |
Type |
Description |
Required |
| author |
string |
The author of the tool |
Yes |
| description |
I18nObject |
The description of the tool |
Yes |
| icon |
string |
The icon of the tool |
Yes |
| icon_dark |
string |
The dark icon of the tool |
No |
| label |
I18nObject |
The label of the tool |
Yes |
| name |
string |
The name of the tool |
Yes |
| tags |
[ ToolLabelEnum ] |
The tags of the tool |
No |
ToolProviderListQuery
| Name |
Type |
Description |
Required |
| type |
string,
Available values: "api", "builtin", "mcp", "model", "workflow" |
|
No |
ToolProviderListResponse
| Name |
Type |
Description |
Required |
| ToolProviderListResponse |
array |
|
|
ToolProviderType
Enum class for tool provider
| Name |
Type |
Description |
Required |
| ToolProviderType |
string |
Enum class for tool provider |
|
ToolSelectorScope
| Name |
Type |
Description |
Required |
| ToolSelectorScope |
string |
|
|
TraceAppConfigResponse
| Name |
Type |
Description |
Required |
| app_id |
string |
|
No |
| created_at |
string |
|
No |
| error |
string |
|
No |
| has_not_configured |
boolean |
|
No |
| id |
string |
|
No |
| is_active |
boolean |
|
No |
| result |
string |
|
No |
| tracing_config |
object |
|
No |
| tracing_provider |
string |
|
No |
| updated_at |
string |
|
No |
TraceConfigAlreadyExistsError
A tracing configuration already exists for this provider.
| Name |
Type |
Description |
Required |
| TraceConfigAlreadyExistsError |
|
A tracing configuration already exists for this provider. |
|
TraceConfigNotFoundError
Tracing configuration not found.
| Name |
Type |
Description |
Required |
| TraceConfigNotFoundError |
|
Tracing configuration not found. |
|
TraceConfigPayload
| Name |
Type |
Description |
Required |
| tracing_config |
object |
Tracing configuration data |
Yes |
| tracing_provider |
string |
Tracing provider name |
Yes |
TraceProviderQuery
| Name |
Type |
Description |
Required |
| tracing_provider |
string |
Tracing provider name |
Yes |
TracingConfigProcessingFailedError
The tracing configuration could not be processed.
| Name |
Type |
Description |
Required |
| TracingConfigProcessingFailedError |
|
The tracing configuration could not be processed. |
|
TracingConfigVerificationFailedError
The tracing configuration could not be verified.
| Name |
Type |
Description |
Required |
| TracingConfigVerificationFailedError |
|
The tracing configuration could not be verified. |
|
TracingProviderUnavailableError
The tracing provider is not available in this deployment.
| Name |
Type |
Description |
Required |
| TracingProviderUnavailableError |
|
The tracing provider is not available in this deployment. |
|
TrialAgentConfigQuery
| Name |
Type |
Description |
Required |
| version_id |
string |
Must match the current published template snapshot |
No |
TrialAgentSkillFileQuery
| Name |
Type |
Description |
Required |
| path |
string |
Normalized member path inside the published Skill package |
Yes |
| version_id |
string |
Must match the current published template snapshot |
No |
TrialAppAgentMode
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| strategy |
string |
|
No |
| tools |
[ JsonObject ] |
|
No |
TrialAppDetailResponse
TrialAppFeatureDisabledError
Trial app feature is not enabled.
| Name |
Type |
Description |
Required |
| TrialAppFeatureDisabledError |
|
Trial app feature is not enabled. |
|
TrialAppLimitExceededError
The user has exceeded the trial app limit.
| Name |
Type |
Description |
Required |
| TrialAppLimitExceededError |
|
The user has exceeded the trial app limit. |
|
TrialAppMode
| Name |
Type |
Description |
Required |
| TrialAppMode |
string |
|
|
TrialAppModel
| Name |
Type |
Description |
Required |
| completion_params |
JsonObject |
|
No |
| mode |
string |
|
No |
| name |
string |
|
Yes |
| provider |
string |
|
Yes |
TrialAppModelConfigResponse
TrialAppNotAllowedError
the app is not allowed to be trial.
| Name |
Type |
Description |
Required |
| TrialAppNotAllowedError |
|
the app is not allowed to be trial. |
|
TrialDatasetListQuery
| Name |
Type |
Description |
Required |
| ids |
[ string ] |
Dataset IDs |
No |
| limit |
integer,
Default: 20 |
Number of items per page |
No |
| page |
integer,
Default: 1 |
Page number |
No |
TrialDatasetListResponse
| Name |
Type |
Description |
Required |
| data |
[ TrialDatasetResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
TrialDatasetResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| data_source_type |
string |
|
No |
| description |
string |
|
No |
| id |
string |
|
Yes |
| indexing_technique |
string |
|
No |
| name |
string |
|
Yes |
| permission |
string |
|
No |
| permission_keys |
[ string ] |
|
No |
TrialDeletedToolResponse
| Name |
Type |
Description |
Required |
| provider_id |
string |
|
Yes |
| tool_name |
string |
|
Yes |
| type |
string |
|
Yes |
TrialIconType
| Name |
Type |
Description |
Required |
| TrialIconType |
string |
|
|
TrialModelsResponse
| Name |
Type |
Description |
Required |
| trial_models |
[ string ] |
|
Yes |
TrialSimpleAccount
| Name |
Type |
Description |
Required |
| email |
string |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
No |
TrialSiteResponse
| Name |
Type |
Description |
Required |
| access_token |
string |
|
No |
| app_base_url |
string |
|
No |
| chat_color_theme |
string |
|
No |
| chat_color_theme_inverted |
boolean |
|
No |
| code |
string |
|
No |
| copyright |
string |
|
No |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| custom_disclaimer |
string |
|
No |
| customize_domain |
string |
|
No |
| customize_token_strategy |
string |
|
No |
| default_language |
string |
|
Yes |
| description |
string |
|
No |
| icon |
string |
|
No |
| icon_background |
string |
|
No |
| icon_type |
TrialIconType |
|
No |
| icon_url |
string |
|
No |
| input_placeholder |
string |
|
No |
| privacy_policy |
string |
|
No |
| prompt_public |
boolean |
|
No |
| show_workflow_steps |
boolean |
|
No |
| title |
string |
|
Yes |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
| use_icon_as_answer_icon |
boolean |
|
No |
TrialTagResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| type |
string |
|
Yes |
TrialWorkflowPartialResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| id |
string |
|
Yes |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
TrialWorkflowResponse
TriggerCreationMethod
| Name |
Type |
Description |
Required |
| TriggerCreationMethod |
string |
|
|
TriggerOAuthAuthorizeResponse
| Name |
Type |
Description |
Required |
| authorization_url |
string |
|
Yes |
| subscription_builder |
SubscriptionBuilderApiEntity |
|
Yes |
| subscription_builder_id |
string |
|
Yes |
TriggerOAuthClientPayload
| Name |
Type |
Description |
Required |
| client_params |
object |
|
No |
| enabled |
boolean |
|
No |
TriggerOAuthClientResponse
| Name |
Type |
Description |
Required |
| configured |
boolean |
|
Yes |
| custom_configured |
boolean |
|
Yes |
| custom_enabled |
boolean |
|
Yes |
| oauth_client_schema |
[ ProviderConfig ] |
|
Yes |
| params |
object |
|
Yes |
| redirect_uri |
string |
|
Yes |
| system_configured |
boolean |
|
Yes |
TriggerProviderApiEntity
| Name |
Type |
Description |
Required |
| author |
string |
The author of the trigger provider |
Yes |
| description |
I18nObject |
The description of the trigger provider |
Yes |
| events |
[ EventApiEntity ] |
The events of the trigger provider |
Yes |
| icon |
string |
The icon of the trigger provider |
No |
| icon_dark |
string |
The dark icon of the trigger provider |
No |
| label |
I18nObject |
The label of the trigger provider |
Yes |
| name |
string |
The name of the trigger provider |
Yes |
| plugin_id |
string |
The plugin id of the tool |
No |
| plugin_unique_identifier |
string |
The unique identifier of the tool |
No |
| subscription_constructor |
SubscriptionConstructor |
The subscription constructor of the trigger provider |
No |
| subscription_schema |
[ ProviderConfig ] |
The subscription schema of the trigger provider |
No |
| supported_creation_methods |
[ TriggerCreationMethod ] |
Supported creation methods for the trigger provider. like 'OAUTH', 'APIKEY', 'MANUAL'. |
No |
| tags |
[ string ] |
The tags of the trigger provider |
No |
TriggerProviderEntity
The configuration of a trigger provider
TriggerProviderErrorResponse
| Name |
Type |
Description |
Required |
| error |
string |
|
Yes |
TriggerProviderIdentity
The identity of the trigger provider
| Name |
Type |
Description |
Required |
| author |
string |
The author of the trigger provider |
Yes |
| description |
I18nObject |
The description of the trigger provider |
Yes |
| icon |
string |
The icon of the trigger provider |
No |
| icon_dark |
string |
The dark icon of the trigger provider |
No |
| label |
I18nObject |
The label of the trigger provider |
Yes |
| name |
string |
The name of the trigger provider |
Yes |
| tags |
[ string ] |
The tags of the trigger provider |
No |
TriggerProviderListResponse
| Name |
Type |
Description |
Required |
| TriggerProviderListResponse |
array |
|
|
TriggerProviderSubscriptionApiEntity
| Name |
Type |
Description |
Required |
| credential_type |
CredentialType |
The type of the credential |
Yes |
| credentials |
object |
The credentials of the subscription |
Yes |
| endpoint |
string |
The endpoint of the subscription |
Yes |
| id |
string |
The unique id of the subscription |
Yes |
| name |
string |
The name of the subscription |
Yes |
| parameters |
object |
The parameters of the subscription |
Yes |
| properties |
object |
The properties of the subscription |
Yes |
| provider |
string |
The provider id of the subscription |
Yes |
| workflows_in_use |
integer |
The number of workflows using this subscription |
Yes |
TriggerProviderSubscriptionListResponse
| Name |
Type |
Description |
Required |
| TriggerProviderSubscriptionListResponse |
array |
|
|
TriggerSubscriptionBuilderCreatePayload
| Name |
Type |
Description |
Required |
| credential_type |
string,
Default: unauthorized |
|
No |
TriggerSubscriptionBuilderCreateResponse
TriggerSubscriptionBuilderLogsResponse
| Name |
Type |
Description |
Required |
| logs |
[ RequestLog ] |
|
Yes |
TriggerSubscriptionBuilderUpdatePayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
No |
| name |
string |
|
No |
| parameters |
object |
|
No |
| properties |
object |
|
No |
TriggerSubscriptionBuilderVerifyPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
No |
TriggerSubscriptionVerifyPayload
| Name |
Type |
Description |
Required |
| credentials |
object |
|
Yes |
TriggerVerificationResponse
| Name |
Type |
Description |
Required |
| verified |
boolean |
|
Yes |
TurnstileServiceUnavailableError
Turnstile verification is temporarily unavailable. Please try again later.
| Name |
Type |
Description |
Required |
| TurnstileServiceUnavailableError |
|
Turnstile verification is temporarily unavailable. Please try again later. |
|
TurnstileVerificationFailedError
Turnstile verification failed. Please try again.
| Name |
Type |
Description |
Required |
| TurnstileVerificationFailedError |
|
Turnstile verification failed. Please try again. |
|
UnaddedModelConfiguration
Model class for provider unadded model configuration.
| Name |
Type |
Description |
Required |
| model |
string |
|
Yes |
| model_type |
ModelType |
|
Yes |
UnsupportedAudioTypeError
Audio type not allowed.
| Name |
Type |
Description |
Required |
| UnsupportedAudioTypeError |
|
Audio type not allowed. |
|
UnsupportedDataSourceApiKeyAuthProviderError
The data-source API-key authentication provider is not supported.
| Name |
Type |
Description |
Required |
| UnsupportedDataSourceApiKeyAuthProviderError |
|
The data-source API-key authentication provider is not supported. |
|
UnsupportedFileTypeError
File type not allowed.
| Name |
Type |
Description |
Required |
| UnsupportedFileTypeError |
|
File type not allowed. |
|
UnsupportedTracingProviderError
The tracing provider is not supported.
| Name |
Type |
Description |
Required |
| UnsupportedTracingProviderError |
|
The tracing provider is not supported. |
|
UpdateAnnotationPayload
| Name |
Type |
Description |
Required |
| annotation_reply |
object |
|
No |
| answer |
string |
|
No |
| content |
string |
|
No |
| question |
string |
|
No |
UpdateAppPayload
| Name |
Type |
Description |
Required |
| description |
string |
App description (max 400 chars) |
No |
| icon |
string |
Icon |
No |
| icon_background |
string |
Icon background color |
No |
| icon_type |
IconType |
Icon type |
No |
| max_active_requests |
integer |
Maximum active requests |
No |
| name |
string |
App name |
Yes |
| use_icon_as_answer_icon |
boolean |
Use icon as answer icon |
No |
UpdateSnippetPayload
Payload for updating a snippet.
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| icon_info |
IconInfo |
|
No |
| name |
string |
|
No |
UploadConfig
| Name |
Type |
Description |
Required |
| attachment_image_file_size_limit |
integer |
|
Yes |
| audio_file_size_limit |
integer |
|
Yes |
| batch_count_limit |
integer |
|
Yes |
| file_size_limit |
integer |
|
Yes |
| file_upload_limit |
integer |
|
Yes |
| image_file_batch_limit |
integer |
|
Yes |
| image_file_size_limit |
integer |
|
Yes |
| knowledge_file_size_limit |
integer |
|
Yes |
| single_chunk_attachment_limit |
integer |
|
Yes |
| skill_file_size_limit |
integer |
|
Yes |
| video_file_size_limit |
integer |
|
Yes |
| workflow_file_upload_limit |
integer |
|
Yes |
UrlQuery
| Name |
Type |
Description |
Required |
| url |
string (uri) |
|
Yes |
UrlResponse
| Name |
Type |
Description |
Required |
| url |
string |
|
Yes |
UsageCheckResponse
| Name |
Type |
Description |
Required |
| is_using |
boolean |
|
Yes |
UsageCountResponse
| Name |
Type |
Description |
Required |
| count |
integer |
|
Yes |
| is_using |
boolean |
|
Yes |
UserActionConfig
User action configuration.
| Name |
Type |
Description |
Required |
| button_style |
ButtonStyle |
|
No |
| id |
string |
|
Yes |
| title |
string |
|
Yes |
UserSatisfactionRateStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| rate |
number |
|
Yes |
UserSatisfactionRateStatisticResponse
ValidationResultResponse
| Name |
Type |
Description |
Required |
| error |
string |
|
No |
| result |
string,
Available values: "error", "success" |
Enum: "error", "success" |
Yes |
ValueSourceType
ValueSourceType records whether the value comes from a static setting
in form definition, or a variable while the workflow is running.
| Name |
Type |
Description |
Required |
| ValueSourceType |
string |
ValueSourceType records whether the value comes from a static setting in form definition, or a variable while the workflow is running. |
|
VectorSpaceLimitationModel
| Name |
Type |
Description |
Required |
| limit |
integer |
|
Yes |
| size |
integer |
|
Yes |
| usage_unknown |
boolean |
|
No |
VerificationTokenResponse
| Name |
Type |
Description |
Required |
| email |
string |
|
Yes |
| is_valid |
boolean |
|
Yes |
| token |
string |
|
Yes |
WebAppAccessMode
| Name |
Type |
Description |
Required |
| WebAppAccessMode |
string |
|
|
WebAppAccessUnavailableError
The app access service is unavailable. Try again later.
| Name |
Type |
Description |
Required |
| WebAppAccessUnavailableError |
|
The app access service is unavailable. Try again later. |
|
WebAppAuthModel
| Name |
Type |
Description |
Required |
| allow_email_code_login |
boolean |
|
Yes |
| allow_email_password_login |
boolean |
|
Yes |
| allow_public_access |
boolean,
Default: true |
|
Yes |
| allow_sso |
boolean |
|
Yes |
| enabled |
boolean |
|
Yes |
| sso_config |
WebAppAuthSSOModel |
|
Yes |
WebAppAuthSSOModel
| Name |
Type |
Description |
Required |
| protocol |
SSOProtocol |
|
Yes |
WebhookTriggerQuery
| Name |
Type |
Description |
Required |
| node_id |
string |
|
Yes |
WebhookTriggerResponse
| Name |
Type |
Description |
Required |
| created_at |
string |
|
No |
| id |
string |
|
Yes |
| node_id |
string |
|
Yes |
| webhook_debug_url |
string |
|
Yes |
| webhook_id |
string |
|
Yes |
| webhook_url |
string |
|
Yes |
WebsiteCrawlPayload
| Name |
Type |
Description |
Required |
| options |
object |
|
Yes |
| provider |
string,
Available values: "firecrawl", "jinareader", "watercrawl" |
Enum: "firecrawl", "jinareader", "watercrawl" |
Yes |
| url |
string |
|
Yes |
WebsiteCrawlResponse
| Name |
Type |
Description |
Required |
| WebsiteCrawlResponse |
object |
|
|
WebsiteCrawlStatusQuery
| Name |
Type |
Description |
Required |
| provider |
string,
Available values: "firecrawl", "jinareader", "watercrawl" |
Enum: "firecrawl", "jinareader", "watercrawl" |
Yes |
WebsiteInfo
| Name |
Type |
Description |
Required |
| job_id |
string |
|
Yes |
| only_main_content |
boolean,
Default: true |
|
No |
| provider |
string |
|
Yes |
| urls |
[ string ] |
|
Yes |
WeightKeywordSetting
| Name |
Type |
Description |
Required |
| keyword_weight |
number |
Weight assigned to keyword search results. |
Yes |
WeightModel
| Name |
Type |
Description |
Required |
| keyword_setting |
WeightKeywordSetting |
Keyword search weight settings. |
No |
| vector_setting |
WeightVectorSetting |
Semantic search weight settings. |
No |
| weight_type |
string,
Available values: "customized", "keyword_first", "semantic_first" |
Strategy for balancing semantic and keyword search weights. |
No |
WeightVectorSetting
| Name |
Type |
Description |
Required |
| embedding_model_name |
string |
Name of the embedding model used for vector search. |
Yes |
| embedding_provider_name |
string |
Provider of the embedding model used for vector search. |
Yes |
| vector_weight |
number |
Weight assigned to semantic vector search results. |
Yes |
WorkflowAgentBindingType
How a workflow node is bound to an Agent.
| Name |
Type |
Description |
Required |
| WorkflowAgentBindingType |
string |
How a workflow node is bound to an Agent. |
|
WorkflowAgentComposerQuery
| Name |
Type |
Description |
Required |
| snapshot_id |
string |
|
No |
WorkflowAgentComposerResponse
WorkflowAgentSandboxDownloadPayload
| Name |
Type |
Description |
Required |
| node_execution_id |
string |
Workflow node execution ID |
Yes |
| path |
string |
Binding path: relative paths start in Workspace; exact ~ and paths beginning with ~/ start in Home; ~user is an ordinary relative path from Workspace; absolute paths remain absolute; .. and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction |
Yes |
| Name |
Type |
Description |
Required |
| data |
[ WorkflowAppLogPartialResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
WorkflowAppLogPartialResponse
WorkflowAppLogQuery
| Name |
Type |
Description |
Required |
| created_at__after |
string |
Filter logs created after this timestamp |
No |
| created_at__before |
string |
Filter logs created before this timestamp |
No |
| created_by_account |
string |
Filter by account |
No |
| created_by_end_user_session_id |
string |
Filter by end user session ID |
No |
| detail |
boolean |
Whether to return detailed logs |
No |
| keyword |
string |
Search keyword for filtering logs |
No |
| limit |
integer,
Default: 20 |
Number of items per page (1-100) |
No |
| page |
integer,
Default: 1 |
Page number (1-99999) |
No |
| status |
WorkflowExecutionStatus |
Execution status filter |
No |
WorkflowAverageAppInteractionStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| interactions |
number |
|
Yes |
WorkflowAverageAppInteractionStatisticResponse
| Name |
Type |
Description |
Required |
| avatar_url |
string |
|
Yes |
| email |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
| created_at |
integer |
|
No |
| created_by |
string |
|
Yes |
| created_by_account |
WorkflowCommentAccount |
|
No |
| id |
string |
|
Yes |
| mention_count |
integer |
|
Yes |
| participants |
[ WorkflowCommentAccount ] |
|
Yes |
| position_x |
number |
|
Yes |
| position_y |
number |
|
Yes |
| reply_count |
integer |
|
Yes |
| resolved |
boolean |
|
Yes |
| resolved_at |
integer |
|
No |
| resolved_by |
string |
|
No |
| resolved_by_account |
WorkflowCommentAccount |
|
No |
| updated_at |
integer |
|
No |
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| Name |
Type |
Description |
Required |
| content |
string |
Comment content |
Yes |
| mentioned_user_ids |
[ string ] |
Mentioned user IDs |
No |
| position_x |
number |
Comment X position |
Yes |
| position_y |
number |
Comment Y position |
Yes |
| Name |
Type |
Description |
Required |
| mentioned_user_account |
WorkflowCommentAccount |
|
No |
| mentioned_user_id |
string |
|
Yes |
| reply_id |
string |
|
No |
| Name |
Type |
Description |
Required |
| content |
string |
|
Yes |
| created_at |
integer |
|
No |
| created_by |
string |
|
Yes |
| created_by_account |
WorkflowCommentAccount |
|
No |
| id |
string |
|
Yes |
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| Name |
Type |
Description |
Required |
| content |
string |
Reply content |
Yes |
| mentioned_user_ids |
[ string ] |
Mentioned user IDs |
No |
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| updated_at |
integer |
|
No |
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| resolved |
boolean |
|
Yes |
| resolved_at |
integer |
|
No |
| resolved_by |
string |
|
No |
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| updated_at |
integer |
|
No |
| Name |
Type |
Description |
Required |
| content |
string |
Comment content |
Yes |
| mentioned_user_ids |
[ string ] |
Mentioned user IDs. Omit to keep existing mentions. |
No |
| position_x |
number |
Comment X position |
No |
| position_y |
number |
Comment Y position |
No |
WorkflowComposerCopyFromRosterPayload
| Name |
Type |
Description |
Required |
| idempotency_key |
string |
|
No |
| source_agent_id |
string |
|
Yes |
| source_snapshot_id |
string |
|
No |
WorkflowConversationVariableResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| value |
|
|
Yes |
| value_type |
string |
|
Yes |
WorkflowDailyRunsStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| runs |
integer |
|
Yes |
WorkflowDailyRunsStatisticResponse
WorkflowDailyTerminalsStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| terminal_count |
integer |
|
Yes |
WorkflowDailyTerminalsStatisticResponse
WorkflowDailyTokenCostStatisticItem
| Name |
Type |
Description |
Required |
| date |
string |
|
Yes |
| token_count |
integer |
|
Yes |
WorkflowDailyTokenCostStatisticResponse
WorkflowDraftVariableFullContentResponse
| Name |
Type |
Description |
Required |
| download_url |
string |
|
Yes |
| length |
integer |
|
Yes |
| size_bytes |
integer |
|
Yes |
| value_type |
string |
|
Yes |
WorkflowDraftVariableListQuery
| Name |
Type |
Description |
Required |
| limit |
integer,
Default: 20 |
Items per page |
No |
| page |
integer,
Default: 1 |
Page number |
No |
WorkflowDraftVariableListResponse
WorkflowDraftVariableListWithoutValueResponse
WorkflowDraftVariablePatchPayload
| Name |
Type |
Description |
Required |
| name |
string |
|
No |
| value |
|
|
No |
WorkflowDraftVariableResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| edited |
boolean |
|
Yes |
| full_content |
WorkflowDraftVariableFullContentResponse |
|
Yes |
| id |
string |
|
Yes |
| is_truncated |
boolean |
|
Yes |
| name |
string |
|
Yes |
| selector |
[ string ] |
|
Yes |
| type |
string |
|
Yes |
| value |
RecursiveJSONValue |
|
Yes |
| value_type |
string |
|
Yes |
| visible |
boolean |
|
Yes |
WorkflowDraftVariableUpdatePayload
| Name |
Type |
Description |
Required |
| name |
string |
Variable name |
No |
| value |
|
Variable value |
No |
WorkflowDraftVariableWithoutValueResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| edited |
boolean |
|
Yes |
| id |
string |
|
Yes |
| is_truncated |
boolean |
|
Yes |
| name |
string |
|
Yes |
| selector |
[ string ] |
|
Yes |
| type |
string |
|
Yes |
| value_type |
string |
|
Yes |
| visible |
boolean |
|
Yes |
WorkflowEnvironmentVariableResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| id |
string |
|
Yes |
| name |
string |
|
Yes |
| value |
|
|
Yes |
| value_type |
string |
|
Yes |
WorkflowExecutionStatus
| Name |
Type |
Description |
Required |
| WorkflowExecutionStatus |
string |
|
|
WorkflowFeatureTogglePayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
WorkflowFeaturesConfigPayload
WorkflowFeaturesPayload
WorkflowFileUploadImagePayload
| Name |
Type |
Description |
Required |
| detail |
string |
|
No |
| enabled |
boolean |
|
No |
| number_limits |
integer |
|
No |
| transfer_methods |
[ string ] |
|
No |
WorkflowFileUploadPayload
WorkflowFileUploadPreviewConfigPayload
| Name |
Type |
Description |
Required |
| file_type_list |
[ string ] |
|
No |
| mode |
string |
|
No |
WorkflowFileUploadTransferPayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| number_limits |
integer |
|
No |
| transfer_methods |
[ string ] |
|
No |
WorkflowGenerateErrorCode
| Name |
Type |
Description |
Required |
| WorkflowGenerateErrorCode |
string |
|
|
WorkflowGenerateErrorResponse
WorkflowGeneratePayload
Payload for the cmd+k /create and /refine workflow generator endpoint.
See services/workflow_generator_service.py for behaviour. Errors are
surfaced through the same envelope as /rule-generate so the frontend
can reuse its existing handler.
| Name |
Type |
Description |
Required |
| current_graph |
WorkflowGraph |
Existing draft graph to refine (cmd+k /refine); omit for create-from-scratch |
No |
| ideal_output |
string |
Optional sample output for grounding |
No |
| instruction |
string |
Natural-language workflow description |
Yes |
| mode |
string,
Available values: "advanced-chat", "auto", "workflow" |
Target app mode for the generated graph; 'auto' lets the backend classify the instruction
Enum: "advanced-chat", "auto", "workflow" |
Yes |
| model_config |
ModelConfig |
Model configuration |
Yes |
WorkflowGeneratePlanEventResponse
| Name |
Type |
Description |
Required |
| app_name |
string |
|
No |
| description |
string |
|
No |
| event |
string |
|
No |
| icon |
string |
|
No |
| mode |
string,
Available values: "advanced-chat", "workflow" |
Enum: "advanced-chat", "workflow" |
Yes |
| nodes |
[ WorkflowPlanNodeResponse ] |
|
Yes |
| start_inputs |
[ WorkflowPlanStartInputResponse ] |
|
No |
| title |
string |
|
No |
WorkflowGenerateRejectedResponse
400 body when the boundary guard rejects the instruction before generating.
WorkflowGenerateResponse
| Name |
Type |
Description |
Required |
| app_name |
string |
|
No |
| error |
string |
|
No |
| errors |
[ WorkflowGenerateErrorResponse ] |
|
No |
| graph |
WorkflowGraph |
|
Yes |
| icon |
string |
|
No |
| message |
string |
|
No |
| mode |
string,
Available values: "advanced-chat", "workflow" |
|
No |
WorkflowGenerateResultEventResponse
| Name |
Type |
Description |
Required |
| app_name |
string |
|
No |
| error |
string |
|
No |
| errors |
[ WorkflowGenerateErrorResponse ] |
|
No |
| event |
string |
|
No |
| graph |
WorkflowGraph |
|
Yes |
| icon |
string |
|
No |
| message |
string |
|
No |
| mode |
string,
Available values: "advanced-chat", "workflow" |
|
No |
WorkflowGenerateStreamEventResponse
Schema for each JSON object carried by an SSE data: frame.
WorkflowGraph
WorkflowGraphEdge
React Flow edge shape with extensible renderer metadata.
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| source |
string |
|
Yes |
| target |
string |
|
Yes |
| type |
string |
|
Yes |
WorkflowGraphNode
React Flow node shape accepted and returned by the generator.
Node-specific configuration lives under data and wrapper metadata
differs for container children, so unknown wrapper fields must survive
request validation and response serialization.
| Name |
Type |
Description |
Required |
| data |
object |
|
Yes |
| id |
string |
|
Yes |
| position |
WorkflowGraphPosition |
|
Yes |
| type |
string |
|
Yes |
WorkflowGraphPosition
| Name |
Type |
Description |
Required |
| x |
number |
|
Yes |
| y |
number |
|
Yes |
WorkflowGraphViewport
| Name |
Type |
Description |
Required |
| x |
number |
|
Yes |
| y |
number |
|
Yes |
| zoom |
number |
|
Yes |
WorkflowInstructionSuggestionsPayload
Payload for the workflow-generator instruction-suggestions endpoint.
Runs before the user picks a model, so the suggestions come from the
tenant's default model. The underlying generator never raises — an empty
suggestions list is a valid 200 (soft-fail).
| Name |
Type |
Description |
Required |
| count |
integer,
Default: 4 |
Number of suggestions to return (1-6) |
No |
| language |
string |
Optional language to write the suggestions in |
No |
| mode |
string,
Available values: "advanced-chat", "workflow" |
Target app mode for the suggestions
Enum: "advanced-chat", "workflow" |
Yes |
WorkflowInstructionSuggestionsResponse
| Name |
Type |
Description |
Required |
| suggestions |
[ string ] |
|
Yes |
WorkflowListQuery
| Name |
Type |
Description |
Required |
| limit |
integer,
Default: 10 |
|
No |
| named_only |
boolean |
|
No |
| page |
integer,
Default: 1 |
|
No |
| user_id |
string |
|
No |
WorkflowNodeJobConfig
WorkflowNodeJobMetadata
WorkflowNodeJobMode
| Name |
Type |
Description |
Required |
| WorkflowNodeJobMode |
string |
|
|
WorkflowOnlineUser
| Name |
Type |
Description |
Required |
| avatar |
string |
|
No |
| user_id |
string |
|
Yes |
| username |
string |
|
Yes |
WorkflowOnlineUsersByApp
WorkflowOnlineUsersPayload
| Name |
Type |
Description |
Required |
| app_ids |
[ string ] |
App IDs |
No |
WorkflowOnlineUsersResponse
WorkflowOutputRoute
Stable workflow exit identity and its model-visible selection condition.
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| label |
string |
|
No |
| name |
string |
|
No |
WorkflowOutputRoutes
Enabled routes require at least two exits; drafts may omit conditions.
| Name |
Type |
Description |
Required |
| has_more |
boolean |
|
Yes |
| items |
[ WorkflowResponse ] |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
WorkflowPartial
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by |
string |
|
No |
| id |
string |
|
Yes |
| updated_at |
integer |
|
No |
| updated_by |
string |
|
No |
WorkflowPauseDetailsResponse
| Name |
Type |
Description |
Required |
| paused_at |
string |
|
No |
| paused_nodes |
[ PausedNodeResponse ] |
|
Yes |
WorkflowPlanNodeResponse
| Name |
Type |
Description |
Required |
| label |
string |
|
Yes |
| node_type |
string |
|
Yes |
| purpose |
string |
|
No |
WorkflowPlanStartInputResponse
| Name |
Type |
Description |
Required |
| label |
string |
|
No |
| type |
string |
|
No |
| variable |
string |
|
Yes |
WorkflowPreviousNodeOutputRef
| Name |
Type |
Description |
Required |
| key |
string |
|
No |
| name |
string |
|
No |
| node_id |
string |
|
No |
| output |
string |
|
No |
| selector |
[ string
integer
number
boolean ] |
|
No |
| value_selector |
[ string
integer
number
boolean ] |
|
No |
| variable |
string |
|
No |
| variable_selector |
[ string
integer
number
boolean ] |
|
No |
WorkflowPublishResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
Yes |
| result |
string |
|
Yes |
| warning |
string |
Advisory warning for variable references that can read a skipped branch. Publish still succeeds. |
No |
WorkflowResponse
WorkflowRestoreResponse
| Name |
Type |
Description |
Required |
| hash |
string |
|
Yes |
| result |
string |
|
Yes |
| updated_at |
integer |
|
Yes |
WorkflowRunArchiveDeletionStatus
| Name |
Type |
Description |
Required |
| WorkflowRunArchiveDeletionStatus |
string |
|
|
WorkflowRunArchiveDeletionTaskResponse
WorkflowRunArchiveDownloadPayload
Request body for preparing one monthly workflow-run archive download.
| Name |
Type |
Description |
Required |
| month |
integer |
|
Yes |
| year |
integer |
|
Yes |
WorkflowRunArchiveDownloadStatus
Lifecycle state for an asynchronous archive download request.
| Name |
Type |
Description |
Required |
| WorkflowRunArchiveDownloadStatus |
string |
Lifecycle state for an asynchronous archive download request. |
|
WorkflowRunArchiveDownloadTaskResponse
| Name |
Type |
Description |
Required |
| archive_bytes |
integer |
|
Yes |
| bundle_count |
integer |
|
Yes |
| created_at |
dateTime |
|
Yes |
| download_id |
string |
|
Yes |
| error |
string |
|
No |
| expires_at |
dateTime |
|
Yes |
| file_name |
string |
|
No |
| file_size_bytes |
integer |
|
No |
| finished_at |
string |
|
No |
| month |
integer |
|
Yes |
| started_at |
string |
|
No |
| status |
WorkflowRunArchiveDownloadStatus |
|
Yes |
| updated_at |
dateTime |
|
Yes |
| year |
integer |
|
Yes |
WorkflowRunArchiveListResponse
WorkflowRunArchiveMonthResponse
| Name |
Type |
Description |
Required |
| archive_bytes |
integer |
|
Yes |
| bundle_count |
integer |
|
Yes |
| deletion_status |
string,
Available values: "failed", "pending", "processing" |
|
No |
| download_task |
WorkflowRunArchiveDownloadTaskResponse |
|
No |
| latest_archived_at |
dateTime |
|
Yes |
| month |
integer |
|
Yes |
| row_count |
integer |
|
Yes |
| workflow_run_count |
integer |
|
Yes |
| year |
integer |
|
Yes |
WorkflowRunArchiveSummaryResponse
| Name |
Type |
Description |
Required |
| archive_bytes |
integer |
|
Yes |
| archived_month_count |
integer |
|
Yes |
| latest_archived_at |
string |
|
No |
| workflow_run_count |
integer |
|
Yes |
WorkflowRunCountQuery
| Name |
Type |
Description |
Required |
| status |
string,
Available values: "failed", "partial-succeeded", "running", "stopped", "succeeded" |
Workflow run status filter |
No |
| time_range |
string |
Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. |
No |
| triggered_from |
string,
Available values: "app-run", "debugging" |
Filter by trigger source: debugging or app-run. Default: debugging |
No |
WorkflowRunCountResponse
| Name |
Type |
Description |
Required |
| failed |
integer |
|
Yes |
| partial_succeeded |
integer |
|
Yes |
| running |
integer |
|
Yes |
| stopped |
integer |
|
Yes |
| succeeded |
integer |
|
Yes |
| total |
integer |
|
Yes |
WorkflowRunDetailResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by_account |
SimpleAccountResponse |
|
No |
| created_by_end_user |
SimpleEndUser |
|
No |
| created_by_role |
string |
|
No |
| elapsed_time |
number |
|
No |
| error |
string |
|
No |
| exceptions_count |
integer |
|
No |
| finished_at |
integer |
|
No |
| graph |
|
|
Yes |
| id |
string |
|
Yes |
| inputs |
|
|
Yes |
| outputs |
|
|
Yes |
| status |
string |
|
No |
| total_steps |
integer |
|
No |
| total_tokens |
integer |
|
No |
| version |
string |
|
No |
WorkflowRunForListResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by_account |
SimpleAccountResponse |
|
No |
| elapsed_time |
number |
|
No |
| exceptions_count |
integer |
|
No |
| finished_at |
integer |
|
No |
| id |
string |
|
Yes |
| retry_index |
integer |
|
No |
| status |
string |
|
No |
| total_steps |
integer |
|
No |
| total_tokens |
integer |
|
No |
| version |
string |
|
No |
WorkflowRunForLogResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| elapsed_time |
number |
|
No |
| error |
string |
|
No |
| exceptions_count |
integer |
|
No |
| finished_at |
integer |
|
No |
| id |
string |
|
Yes |
| status |
string |
|
No |
| total_steps |
integer |
|
No |
| total_tokens |
integer |
|
No |
| triggered_from |
string |
|
No |
| version |
string |
|
No |
WorkflowRunListQuery
| Name |
Type |
Description |
Required |
| last_id |
string |
Last run ID for pagination |
No |
| limit |
integer,
Default: 20 |
Number of items per page (1-100) |
No |
| status |
string,
Available values: "failed", "partial-succeeded", "running", "stopped", "succeeded" |
Workflow run status filter |
No |
| triggered_from |
string,
Available values: "app-run", "debugging" |
Filter by trigger source: debugging or app-run. Default: debugging |
No |
WorkflowRunNodeExecutionListResponse
WorkflowRunNodeExecutionResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| created_by_account |
SimpleAccountResponse |
|
No |
| created_by_end_user |
SimpleEndUser |
|
No |
| created_by_role |
string |
|
No |
| elapsed_time |
number |
|
No |
| error |
string |
|
No |
| execution_metadata |
|
|
No |
| extras |
|
|
No |
| finished_at |
integer |
|
No |
| id |
string |
|
Yes |
| index |
integer |
|
No |
| inputs |
|
|
No |
| inputs_truncated |
boolean |
|
No |
| node_id |
string |
|
No |
| node_type |
string |
|
No |
| outputs |
|
|
No |
| outputs_truncated |
boolean |
|
No |
| predecessor_node_id |
string |
|
No |
| process_data |
|
|
No |
| process_data_truncated |
boolean |
|
No |
| retry_index |
integer |
|
No |
| status |
string |
|
No |
| title |
string |
|
No |
WorkflowRunNotFoundError
Workflow run not found.
| Name |
Type |
Description |
Required |
| WorkflowRunNotFoundError |
|
Workflow run not found. |
|
WorkflowRunPayload
| Name |
Type |
Description |
Required |
| files |
[ object
object
object
object ] |
File list for workflow system file inputs. Available when file upload is enabled for the workflow. To attach a local file, first upload it via Upload File and use the returned id as upload_file_id with transfer_method: local_file. |
No |
| inputs |
object |
Key-value pairs for workflow input variables. Values for file-type variables should be arrays of file objects with type, transfer_method, and either url or upload_file_id. Refer to the user_input_form field in the Get App Parameters response to discover the variable names and types expected by your app. |
Yes |
WorkflowRunRequest
| Name |
Type |
Description |
Required |
| files |
[ object ] |
|
No |
| inputs |
object |
|
Yes |
WorkflowRunSnapshotView
WorkflowSensitiveWordAvoidancePayload
| Name |
Type |
Description |
Required |
| config |
object |
|
No |
| enabled |
boolean |
|
No |
| type |
string |
|
No |
WorkflowStatisticQuery
| Name |
Type |
Description |
Required |
| end |
string |
End date and time (YYYY-MM-DD HH:MM) |
No |
| start |
string |
Start date and time (YYYY-MM-DD HH:MM) |
No |
WorkflowSuggestedQuestionsAfterAnswerPayload
| Name |
Type |
Description |
Required |
| enabled |
boolean |
|
No |
| model |
object |
|
No |
| prompt |
string |
|
No |
WorkflowTextToSpeechPayload
| Name |
Type |
Description |
Required |
| autoPlay |
string,
Available values: "disabled", "enabled" |
|
No |
| enabled |
boolean |
|
No |
| language |
string |
|
No |
| voice |
string |
|
No |
WorkflowToolCreatePayload
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| icon |
ToolEmojiIcon |
|
Yes |
| label |
string |
|
Yes |
| labels |
[ string ] |
|
No |
| name |
string |
|
Yes |
| parameters |
[ WorkflowToolParameterConfiguration ] |
|
No |
| privacy_policy |
string |
|
No |
| workflow_app_id |
string |
|
Yes |
WorkflowToolDeletePayload
| Name |
Type |
Description |
Required |
| workflow_tool_id |
string |
|
Yes |
WorkflowToolDetailResponse
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| icon |
ToolEmojiIcon |
|
Yes |
| label |
string |
|
Yes |
| name |
string |
|
Yes |
| output_schema |
object |
|
No |
| parameters |
[ WorkflowToolParameterConfiguration ] |
|
Yes |
| privacy_policy |
string |
|
No |
| synced |
boolean |
|
Yes |
| tool |
ToolApiEntity |
|
Yes |
| workflow_app_id |
string |
|
Yes |
| workflow_tool_id |
string |
|
Yes |
WorkflowToolGetQuery
| Name |
Type |
Description |
Required |
| workflow_app_id |
string |
|
No |
| workflow_tool_id |
string |
|
No |
WorkflowToolHumanInputNotSupportedError
Workflow with Human Input nodes cannot be published as a workflow tool.
| Name |
Type |
Description |
Required |
| WorkflowToolHumanInputNotSupportedError |
|
Workflow with Human Input nodes cannot be published as a workflow tool. |
|
WorkflowToolListQuery
| Name |
Type |
Description |
Required |
| workflow_tool_id |
string |
|
Yes |
WorkflowToolParameterConfiguration
Workflow tool configuration
| Name |
Type |
Description |
Required |
| description |
string |
The description of the parameter |
Yes |
| form |
ToolParameterForm |
The form of the parameter |
Yes |
| name |
string |
The name of the parameter |
Yes |
WorkflowToolUpdatePayload
| Name |
Type |
Description |
Required |
| description |
string |
|
Yes |
| icon |
ToolEmojiIcon |
|
Yes |
| label |
string |
|
Yes |
| labels |
[ string ] |
|
No |
| name |
string |
|
Yes |
| parameters |
[ WorkflowToolParameterConfiguration ] |
|
No |
| privacy_policy |
string |
|
No |
| workflow_tool_id |
string |
|
Yes |
WorkflowTriggerListResponse
WorkflowTriggerResponse
| Name |
Type |
Description |
Required |
| created_at |
string |
|
No |
| icon |
string |
|
Yes |
| id |
string |
|
Yes |
| node_id |
string |
|
Yes |
| provider_name |
string |
|
Yes |
| status |
string |
|
Yes |
| title |
string |
|
Yes |
| trigger_type |
string |
|
Yes |
| updated_at |
string |
|
No |
WorkflowTriggerRunErrorResponse
400 body when a draft trigger run fails; error is omitted when there is nothing user-facing to say.
| Name |
Type |
Description |
Required |
| error |
string |
|
No |
| status |
string |
|
Yes |
WorkflowUpdatePayload
| Name |
Type |
Description |
Required |
| marked_comment |
string |
|
No |
| marked_name |
string |
|
No |
WorkspaceAccessMatrix
WorkspaceCustomConfigPayload
| Name |
Type |
Description |
Required |
| remove_webapp_brand |
boolean |
|
No |
| replace_webapp_logo |
string |
|
No |
WorkspaceCustomConfigResponse
| Name |
Type |
Description |
Required |
| remove_webapp_brand |
boolean |
|
No |
| replace_webapp_logo |
string |
|
No |
WorkspaceInfoPayload
| Name |
Type |
Description |
Required |
| name |
string |
|
Yes |
WorkspaceListItemResponse
| Name |
Type |
Description |
Required |
| created_at |
integer |
|
No |
| id |
string |
|
Yes |
| name |
string |
|
No |
| status |
string |
|
No |
WorkspaceListQuery
| Name |
Type |
Description |
Required |
| limit |
integer,
Default: 20 |
|
No |
| page |
integer,
Default: 1 |
|
No |
WorkspaceLogoUploadResponse
| Name |
Type |
Description |
Required |
| id |
string |
|
Yes |
| Name |
Type |
Description |
Required |
| data |
[ WorkspaceListItemResponse ] |
|
Yes |
| has_more |
boolean |
|
Yes |
| limit |
integer |
|
Yes |
| page |
integer |
|
Yes |
| total |
integer |
|
Yes |
WorkspacePermissionResponse
| Name |
Type |
Description |
Required |
| allow_member_invite |
boolean |
|
Yes |
| allow_owner_transfer |
boolean |
|
Yes |
| workspace_id |
string |
|
Yes |
WorkspacePermissionSnapshot
| Name |
Type |
Description |
Required |
| permission_keys |
[ string ] |
|
No |
WorkspaceSkillsQuery
| Name |
Type |
Description |
Required |
| keyword |
string |
Search keyword matching skill name or description. |
No |
| limit |
integer,
Default: 20 |
Number of items per page. |
No |
| page |
integer,
Default: 1 |
Page number. |
No |
| tag |
[ string ] |
Skill tag filters. Repeat the parameter for multiple tags. |
No |
WorkspaceTenantResultResponse
_AccessControlLanguageQuery
| Name |
Type |
Description |
Required |
| language |
string,
Available values: "en", "ja", "zh" |
Localized policy label language |
No |
_AccessPolicyCreateRequest
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ],
Default: |
|
No |
| resource_type |
RBACResourceType |
|
Yes |
_AccessPolicyList
_AccessPolicyUpdateRequest
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ],
Default: |
|
No |
_DeleteMemberBindingsRequest
| Name |
Type |
Description |
Required |
| account_ids |
[ string ] |
|
No |
_MembersInRoleList
_RBACRoleList
_ReplaceBindingsRequest
| Name |
Type |
Description |
Required |
| account_ids |
[ string ] |
|
No |
| role_ids |
[ string ] |
|
No |
_ReplaceMemberRolesRequest
| Name |
Type |
Description |
Required |
| role_ids |
[ string ],
Default: |
|
No |
_ResourceAccessScopeRequest
| Name |
Type |
Description |
Required |
| automatic_include_workspace_members |
boolean |
|
Yes |
_ResourceUserAccessPoliciesQuery
| Name |
Type |
Description |
Required |
| language |
string,
Available values: "en", "ja", "zh" |
Localized policy label language |
No |
| limit |
integer |
|
No |
| page |
integer |
|
No |
| reverse |
boolean |
|
No |
_RoleUpsertRequest
Accepts the payload sent by the Create/Edit Role dialog.
| Name |
Type |
Description |
Required |
| description |
string |
|
No |
| name |
string |
|
Yes |
| permission_keys |
[ string ],
Default: |
|
No |
FastOpenAPI Preview (OpenAPI 3.1)
Dify API (FastOpenAPI PoC)
FastOpenAPI proof of concept for Dify API
Version: 1.0
[GET] /console/api/init
Get initialization validation status.
Responses
[POST] /console/api/init
Validate initialization password.
Request Body
Responses
[GET] /console/api/ping
Health check endpoint for connection testing.
Responses
| Code |
Description |
Schema |
| 200 |
OK |
application/json: PingResponse
|
[GET] /console/api/setup
**Get system setup status.
NOTE: This endpoint is unauthenticated by design.
During first-time bootstrap there is no admin account yet, so frontend initialization must be
able to query setup progress before any login flow exists.
Only bootstrap-safe status information should be returned by this endpoint.
**
Responses
[POST] /console/api/setup
**Initialize system setup with admin account.
NOTE: This endpoint is unauthenticated by design for first-time bootstrap.
Access is restricted to self-hosted editions (COMMUNITY and ENTERPRISE), one-time setup guards,
and init-password validation rather than user session authentication.
**
Request Body
Responses
| Code |
Description |
Schema |
| 201 |
Created |
application/json: SetupResponse
|
[GET] /console/api/version
Check for application version updates.
Parameters
| Name |
Located in |
Description |
Required |
Schema |
| current_version |
query |
|
Yes |
string |
Responses
Schemas
ErrorSchema
| Name |
Type |
Description |
Required |
| error |
{ "details": string, "message": string, "status": integer, "type": string } |
|
Yes |
InitStatusResponse
| Name |
Type |
Description |
Required |
| status |
string,
Available values: "finished", "not_started" |
Initialization status
Enum: "finished", "not_started" |
Yes |
InitValidatePayload
| Name |
Type |
Description |
Required |
| password |
string |
Initialization password |
Yes |
InitValidateResponse
| Name |
Type |
Description |
Required |
| result |
string |
Operation result |
Yes |
PingResponse
| Name |
Type |
Description |
Required |
| result |
string |
Health check result |
Yes |
SetupRequestPayload
| Name |
Type |
Description |
Required |
| email |
string |
Admin email address |
Yes |
| language |
string |
Admin language |
No |
| name |
string |
Admin name (max 30 characters) |
Yes |
| password |
string |
Admin password |
Yes |
SetupResponse
| Name |
Type |
Description |
Required |
| result |
string |
Setup result |
Yes |
SetupStatusResponse
| Name |
Type |
Description |
Required |
| setup_at |
string |
Setup completion time (ISO format) |
No |
| step |
string,
Available values: "finished", "not_started" |
Setup step status
Enum: "finished", "not_started" |
Yes |
VersionResponse
| Name |
Type |
Description |
Required |
| release_notes |
string |
Release notes for latest version |
Yes |
| version |
string |
Latest version number |
Yes |
