mirror of https://github.com/langgenius/dify.git synced 2026-06-23 04:11:09 +08:00

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: fatelei <fatelei@gmail.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: 盐粒 Yanli <yanli@dify.ai>
Co-authored-by: Charles Yao <chongbinyao33@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: yunlu.wen <yunlu.wen@dify.ai>
Co-authored-by: yyh <92089059+lyzno1@users.noreply.github.com>
Co-authored-by: Jingyi <jingyi.qi@dify.ai>
Co-authored-by: yyh <yuanyouhuilyz@gmail.com>
Co-authored-by: Joel <iamjoel007@gmail.com>
Co-authored-by: hjlarry <hjlarry@163.com>
Co-authored-by: Asuka Minato <i@asukaminato.eu.org>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Xiyuan Chen <52963600+GareArc@users.noreply.github.com>
Co-authored-by: gigglewang <gigglewang@dify.ai>
Co-authored-by: chariri <w@chariri.moe>
Co-authored-by: Evan <2869018789@qq.com>
Co-authored-by: zyssyz123 <916125788@qq.com>

2026-06-18 16:35:29 +00:00

173 KiB

Raw Blame History

Service API

API for application services

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

service_api

Service operations

[GET] /

Responses

Code	Description	Schema
200	Success	application/json: IndexInfoResponse

[POST] /datasets/{dataset_id}/document/create_by_text

DEPRECATED

Deprecated legacy alias for creating a new document by providing text content. Use /datasets/{dataset_id}/document/create-by-text instead.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DocumentTextCreatePayload

Responses

Code	Description	Schema
200	Document created successfully	application/json: DocumentAndBatchResponse
400	Bad request - invalid parameters
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[DELETE] /datasets/{dataset_id}/documents/{document_id}

Delete Document

Permanently delete a document and all its chunks from the knowledge base.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Responses

Code	Description
204	Success.
400	`document_indexing` : Cannot delete document during indexing.
401	Unauthorized - invalid API token
403	`archived_document_immutable` : The archived document is not editable.
404	`not_found` : Document Not Exists.

[GET] /datasets/{dataset_id}/documents/{document_id}

Get Document

Retrieve detailed information about a specific document, including its indexing status, metadata, and processing statistics.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
metadata	query	`all` returns all fields including metadata. `only` returns only `id`, `doc_type`, and `doc_metadata`. `without` returns all fields except `doc_metadata`.	No	string, Available values: "all", "only", "without", Default: all

Responses

Code	Description	Schema
200	Document details. The response shape varies based on the `metadata` query parameter. When `metadata` is `only`, only `id`, `doc_type`, and `doc_metadata` are returned. When `metadata` is `without`, `doc_type` and `doc_metadata` are omitted.	application/json: DocumentDetailResponse
400	`invalid_metadata` : Invalid metadata value for the specified key.
401	Unauthorized - invalid API token
403	`forbidden` : No permission.
404	`not_found` : Document not found.

[PATCH] /datasets/{dataset_id}/documents/{document_id}

Update an existing document by uploading a file

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
No	multipart/form-data: { "data": string, "file": binary }

Responses

Code	Description	Schema
200	Document updated successfully	application/json: DocumentAndBatchResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Document not found

[POST] /datasets/{dataset_id}/documents/{document_id}/update_by_text

DEPRECATED

Deprecated legacy alias for updating an existing document by providing text content. Use /datasets/{dataset_id}/documents/{document_id}/update-by-text instead.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DocumentTextUpdate

Responses

Code	Description	Schema
200	Document updated successfully	application/json: DocumentAndBatchResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Document not found

default

[GET] /app/feedbacks

List App Feedbacks

Retrieve a paginated list of all feedback submitted for messages in this application, including both end-user and admin feedback.

Parameters

Name	Located in	Description	Required	Schema
limit	query	Number of records per page.	No	integer, Default: 20
page	query	Page number for pagination.	No	integer, Default: 1

Responses

Code	Description	Schema
200	A list of application feedbacks.	application/json: AppFeedbackListResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied

[POST] /messages/{message_id}/feedbacks

Submit Message Feedback

Submit feedback for a message. End users can rate messages as like or dislike, and optionally provide text feedback. Pass null for rating to revoke previously submitted feedback.

Parameters

Name	Located in	Description	Required	Schema
message_id	path	Message ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: MessageFeedbackPayloadWithUser

Responses

Code	Description	Schema
200	Feedback submitted successfully	application/json: ResultResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Message does not exist.

default

[POST] /apps/annotation-reply/{action}

Configure Annotation Reply

Enables or disables the annotation reply feature. Requires embedding model configuration when enabling. Executes asynchronously — use Get Annotation Reply Job Status to track progress.

Parameters

Name	Located in	Description	Required	Schema
action	path	Action to perform: `enable` or `disable`.	Yes	string, Available values: "disable", "enable"

Request Body

Required	Schema
Yes	application/json: AnnotationReplyActionPayload

Responses

Code	Description	Schema
200	Annotation reply settings task initiated.	application/json: AnnotationJobStatusResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied

[GET] /apps/annotation-reply/{action}/status/{job_id}

Get Annotation Reply Job Status

Retrieves the status of an asynchronous annotation reply configuration job started by Configure Annotation Reply.

Parameters

Name	Located in	Description	Required	Schema
action	path	Action to perform: `enable` or `disable`.	Yes	string, Available values: "disable", "enable"
job_id	path	Job ID returned by Configure Annotation Reply.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Successfully retrieved task status.	application/json: AnnotationJobStatusResponse
400	`invalid_param` : The specified job does not exist.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Job not found

[GET] /apps/annotations

List Annotations

Retrieves a paginated list of annotations for the application. Supports keyword search filtering.

Parameters

Name	Located in	Description	Required	Schema
keyword	query	Keyword to filter annotations by question or answer content.	No	string
limit	query	Number of items per page.	No	integer, Default: 20
page	query	Page number for pagination.	No	integer, Default: 1

Responses

Code	Description	Schema
200	Successfully retrieved annotation list.	application/json: AnnotationList
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied

[POST] /apps/annotations

Create Annotation

Creates a new annotation. Annotations provide predefined question-answer pairs that the app can match and return directly instead of generating a response.

Request Body

Required	Schema
Yes	application/json: AnnotationCreatePayload

Responses

Code	Description	Schema
201	Annotation created successfully.	application/json: Annotation
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied

[DELETE] /apps/annotations/{annotation_id}

Delete Annotation

Deletes an annotation and its associated hit history.

Parameters

Name	Located in	Description	Required	Schema
annotation_id	path	The unique identifier of the annotation to delete.	Yes	string (uuid)

Responses

Code	Description
204	Annotation deleted successfully.
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions to edit annotations.
404	`not_found` : Annotation does not exist.

[PUT] /apps/annotations/{annotation_id}

Update Annotation

Updates the question and answer of an existing annotation.

Parameters

Name	Located in	Description	Required	Schema
annotation_id	path	The unique identifier of the annotation to update.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: AnnotationCreatePayload

Responses

Code	Description	Schema
200	Annotation updated successfully.	application/json: Annotation
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions to edit annotations.
404	`not_found` : Annotation does not exist.

default

[POST] /audio-to-text

Convert Audio to Text

Convert audio file to text. Supported MIME types: audio/mp3, audio/mpga, audio/m4a, audio/wav, and audio/amr. File size limit is 30 MB.

Request Body

Required	Schema
Yes	multipart/form-data: { "file": binary, "user": string }

Responses

Code	Description	Schema
200	Successfully converted audio to text.	application/json: AudioTranscriptResponse
400	- `app_unavailable` : App unavailable or misconfigured. - `provider_not_support_speech_to_text` : Model provider does not support speech-to-text. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model does not support this operation. - `completion_request_error` : Speech recognition request failed.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
413	`audio_too_large` : Audio file size exceeded the limit.
415	`unsupported_audio_type` : Audio type is not allowed.
500	`internal_server_error` : Internal server error.

[POST] /text-to-audio

Convert Text to Audio

Convert text to speech.

Request Body

Required	Schema
Yes	application/json: TextToAudioPayloadWithUser

Responses

Code	Description
200	Returns the generated audio. Generator responses are streamed by the service as `audio/mpeg`; otherwise the provider output is returned directly.
400	- `app_unavailable` : App unavailable or misconfigured. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model does not support this operation. - `completion_request_error` : Text-to-speech request failed.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
500	`internal_server_error` : Internal server error.

default

[POST] /chat-messages

Send Chat Message

Send a request to the chat application.

Request Body

Required	Schema
Yes	application/json: ChatRequestPayloadWithUser

Responses

Code	Description	Schema
200	Successful response. The content type and structure depend on the `response_mode` parameter in the request. - If `response_mode` is `blocking`, returns `application/json` with a `ChatCompletionResponse` object. - If `response_mode` is `streaming`, returns `text/event-stream` with a stream of Server-Sent Events.	application/json: GeneratedAppResponse text/event-stream: GeneratedAppResponse
400	- `app_unavailable` : App unavailable or misconfigured. - `not_chat_app` : App mode does not match the API route. - `conversation_completed` : The conversation has ended. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model unavailable. - `completion_request_error` : Text generation failed.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Conversation does not exist.
429	- `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The upstream model provider rate limit was exceeded.
500	`internal_server_error` : Internal server error.

[POST] /chat-messages/{task_id}/stop

Stop Chat Message Generation

Stops a chat message generation task. Only supported in streaming mode.

Parameters

Name	Located in	Description	Required	Schema
task_id	path	Task ID, obtained from a streaming chunk returned by the Send Chat Message API.	Yes	string

Request Body

Required	Schema
Yes	application/json: RequiredServiceApiUserPayload

Responses

Code	Description	Schema
200	Task stopped successfully	application/json: SimpleResultResponse
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Task not found

[GET] /messages/{message_id}/suggested

Get Next Suggested Questions

Get next questions suggestions for the current message.

Parameters

Name	Located in	Description	Required	Schema
message_id	path	Message ID	Yes	string (uuid)
user	query	User identifier, used for end-user context.	Yes	string

Responses

Code	Description	Schema
200	Suggested questions retrieved successfully	application/json: SimpleResultStringListResponse
400	- `not_chat_app` : App mode does not match the API route. - `bad_request` : Suggested questions feature is disabled.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Message does not exist.
500	`internal_server_error` : Internal server error.

[GET] /workflow/{task_id}/events

Stream Workflow Events

Resume the Server-Sent Events stream for a workflow run after a pause or a dropped SSE connection. For runs that have already finished, the stream emits a single workflow_finished event and closes.

Parameters

Name	Located in	Description	Required	Schema
task_id	path	Workflow run ID returned by the original workflow run request.	Yes	string
continue_on_pause	query	Set to `true` to keep the stream open across multiple `workflow_paused` events, which is useful when the workflow has more than one Human Input node in sequence. By default, the stream closes after the first pause.	No	boolean
include_state_snapshot	query	When `true`, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.	No	boolean
user	query	End-user identifier that originally triggered the run. Must match the creator of the run.	Yes	string

Responses

Code	Description	Schema
200	Server-Sent Events stream. Each event is delivered as `data: {JSON}\\n\\n`. Event payloads follow the same schemas as the original streaming response.	text/event-stream: EventStreamResponse
400	`not_workflow_app` : Please check if your app mode matches the right API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Workflow run not found.

[GET] /workflows/logs

List Workflow Logs

Retrieve paginated workflow execution logs with filtering options.

Parameters

Name	Located in	Description	Required	Schema
created_at__after	query	Filter logs created after this ISO 8601 timestamp.	No	dateTime
created_at__before	query	Filter logs created before this ISO 8601 timestamp.	No	dateTime
created_by_account	query	Filter by account ID.	No	string
created_by_end_user_session_id	query	Filter by end user session ID.	No	string
keyword	query	Keyword to search in logs.	No	string
limit	query	Number of items per page.	No	integer, Default: 20
page	query	Page number for pagination.	No	integer, Default: 1
status	query	Filter by execution status.	No	string, Available values: "failed", "stopped", "succeeded"

Responses

Code	Description	Schema
200	Successfully retrieved workflow logs.	application/json: WorkflowAppLogPaginationResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied

[GET] /workflows/run/{workflow_run_id}

Get Workflow Run Detail

Retrieve the current execution results of a workflow task based on the workflow execution ID.

Parameters

Name	Located in	Description	Required	Schema
workflow_run_id	path	Workflow run ID, obtained from the workflow execution response or streaming events.	Yes	string

Responses

Code	Description	Schema
200	Successfully retrieved workflow run details.	application/json: WorkflowRunResponse
400	`not_workflow_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Workflow run not found.

default

[POST] /chat-messages

Send Chat Message

Send a request to the chat application.

Request Body

Required	Schema
Yes	application/json: ChatRequestPayloadWithUser

Responses

Code	Description	Schema
200	Successful response. The content type and structure depend on the `response_mode` parameter in the request. - If `response_mode` is `blocking`, returns `application/json` with a `ChatCompletionResponse` object. - If `response_mode` is `streaming`, returns `text/event-stream` with a stream of Server-Sent Events.	application/json: GeneratedAppResponse text/event-stream: GeneratedAppResponse
400	- `app_unavailable` : App unavailable or misconfigured. - `not_chat_app` : App mode does not match the API route. - `conversation_completed` : The conversation has ended. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model unavailable. - `completion_request_error` : Text generation failed.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Conversation does not exist.
429	- `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The upstream model provider rate limit was exceeded.
500	`internal_server_error` : Internal server error.

[POST] /chat-messages/{task_id}/stop

Stop Chat Message Generation

Stops a chat message generation task. Only supported in streaming mode.

Parameters

Name	Located in	Description	Required	Schema
task_id	path	Task ID, obtained from a streaming chunk returned by the Send Chat Message API.	Yes	string

Request Body

Required	Schema
Yes	application/json: RequiredServiceApiUserPayload

Responses

Code	Description	Schema
200	Task stopped successfully	application/json: SimpleResultResponse
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Task not found

[GET] /messages/{message_id}/suggested

Get Next Suggested Questions

Get next questions suggestions for the current message.

Parameters

Name	Located in	Description	Required	Schema
message_id	path	Message ID	Yes	string (uuid)
user	query	User identifier, used for end-user context.	Yes	string

Responses

Code	Description	Schema
200	Suggested questions retrieved successfully	application/json: SimpleResultStringListResponse
400	- `not_chat_app` : App mode does not match the API route. - `bad_request` : Suggested questions feature is disabled.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Message does not exist.
500	`internal_server_error` : Internal server error.

default

[POST] /completion-messages

Send Completion Message

Send a request to the text generation application.

Request Body

Required	Schema
Yes	application/json: CompletionRequestPayloadWithUser

Responses

Code	Description	Schema
200	Successful response. The content type and structure depend on the `response_mode` parameter in the request. - If `response_mode` is `blocking`, returns `application/json` with a `CompletionResponse` object. - If `response_mode` is `streaming`, returns `text/event-stream` with a stream of `ChunkCompletionEvent` objects.	application/json: GeneratedAppResponse text/event-stream: GeneratedAppResponse
400	- `app_unavailable` : App unavailable or misconfigured. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model unavailable. - `completion_request_error` : Text generation failed.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Conversation not found
429	`too_many_requests` : Too many concurrent requests for this app.
500	`internal_server_error` : Internal server error.

[POST] /completion-messages/{task_id}/stop

Stop Completion Message Generation

Stops a completion message generation task. Only supported in streaming mode.

Parameters

Name	Located in	Description	Required	Schema
task_id	path	Task ID, obtained from a streaming chunk returned by the Send Completion Message API.	Yes	string

Request Body

Required	Schema
Yes	application/json: RequiredServiceApiUserPayload

Responses

Code	Description	Schema
200	Task stopped successfully	application/json: SimpleResultResponse
400	`app_unavailable` : App unavailable or misconfigured.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Task not found

default

[GET] /conversations

List Conversations

Retrieve the conversation list for the current user, ordered by most recently active.

Parameters

Name	Located in	Description	Required	Schema
last_id	query	The ID of the last record on the current page. Used to fetch the next page.	No	string
limit	query	Number of records to return.	No	integer, Default: 20
sort_by	query	Sorting field. Use the `-` prefix for descending order.	No	string, Available values: "-created_at", "-updated_at", "created_at", "updated_at", Default: -updated_at
user	query	User identifier, used for end-user context.	No	string

Responses

Code	Description	Schema
200	Successfully retrieved conversations list.	application/json: ConversationInfiniteScrollPagination
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Last conversation does not exist (invalid `last_id`).

[DELETE] /conversations/{c_id}

Delete Conversation

Delete a conversation.

Parameters

Name	Located in	Description	Required	Schema
c_id	path	Conversation ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: OptionalServiceApiUserPayload

Responses

Code	Description
204	Conversation deleted successfully.
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Conversation does not exist.

[POST] /conversations/{c_id}/name

Rename Conversation

Rename a conversation or auto-generate a name. The conversation name is used for display on clients that support multiple conversations.

Parameters

Name	Located in	Description	Required	Schema
c_id	path	Conversation ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: ConversationRenamePayloadWithUser

Responses

Code	Description	Schema
200	Conversation renamed successfully.	application/json: SimpleConversation
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Conversation does not exist.

[GET] /conversations/{c_id}/variables

List Conversation Variables

Retrieve variables from a specific conversation.

Parameters

Name	Located in	Description	Required	Schema
c_id	path	Conversation ID.	Yes	string (uuid)
last_id	query	The ID of the last record on the current page. Used to fetch the next page.	No	string
limit	query	Number of records to return.	No	integer, Default: 20
user	query	User identifier, used for end-user context.	No	string
variable_name	query	Filter variables by a specific name.	No	string

Responses

Code	Description	Schema
200	Successfully retrieved conversation variables.	application/json: ConversationVariableInfiniteScrollPaginationResponse
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Conversation does not exist.

[PUT] /conversations/{c_id}/variables/{variable_id}

Update Conversation Variable

Update the value of a specific conversation variable. The value must match the expected type.

Parameters

Name	Located in	Description	Required	Schema
c_id	path	Conversation ID.	Yes	string (uuid)
variable_id	path	Variable ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: ConversationVariableUpdatePayloadWithUser

Responses

Code	Description	Schema
200	Variable updated successfully.	application/json: ConversationVariableResponse
400	- `not_chat_app` : App mode does not match the API route. - `bad_request` : Variable value type mismatch.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	- `not_found` : Conversation does not exist. - `not_found` : Conversation variable does not exist.

[GET] /messages

List Conversation Messages

Returns historical chat records in a scrolling load format, with the first page returning the latest limit messages, i.e., in reverse order.

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
user	query	User identifier, used for end-user context.	No	string

Responses

Code	Description	Schema
200	Successfully retrieved conversation history.	application/json: MessageInfiniteScrollPagination
400	`not_chat_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	- `not_found` : Conversation does not exist. - `not_found` : First message does not exist.

default

[GET] /datasets

List Knowledge Bases

Returns a paginated list of knowledge bases. Supports filtering by keyword and tags.

Parameters

Name	Located in	Description	Required	Schema
include_all	query	Whether to include all knowledge bases regardless of permissions.	No	boolean
keyword	query	Search keyword to filter by name.	No	string
limit	query	Number of items per page. Server caps at `100`.	No	integer, Default: 20
page	query	Page number to retrieve.	No	integer, Default: 1
tag_ids	query	Tag IDs to filter by.	No	[ string ]

Responses

Code	Description	Schema
200	List of knowledge bases.	application/json: DatasetListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[POST] /datasets

Create an Empty Knowledge Base

Create a new empty knowledge base. After creation, use Create Document by Text or Create Document by File to add documents.

Request Body

Required	Schema
Yes	application/json: DatasetCreatePayload

Responses

Code	Description	Schema
200	Knowledge base created successfully.	application/json: DatasetDetailResponse
400	Bad request - invalid parameters
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
409	`dataset_name_duplicate` : The dataset name already exists. Please modify your dataset name.

[DELETE] /datasets/{dataset_id}

Delete Knowledge Base

Permanently delete a knowledge base and all its documents. The knowledge base must not be in use by any application.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description
204	Success.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	`not_found` : Dataset not found.
409	`dataset_in_use` : The knowledge base is being used by some apps. Please remove it from the apps before deleting.

[GET] /datasets/{dataset_id}

Get Knowledge Base

Retrieve detailed information about a specific knowledge base, including its embedding model, retrieval configuration, and document statistics.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Knowledge base details.	application/json: DatasetDetailWithPartialMembersResponse
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions to access this knowledge base.
404	`not_found` : Dataset not found.

[PATCH] /datasets/{dataset_id}

Update Knowledge Base

Update the name, description, permissions, or retrieval settings of an existing knowledge base. Only the fields provided in the request body are updated.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DatasetUpdatePayload

Responses

Code	Description	Schema
200	Knowledge base updated successfully.	application/json: DatasetDetailWithPartialMembersResponse
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions to access this knowledge base.
404	`not_found` : Dataset not found.

[POST] /datasets/{dataset_id}/hit-testing

Retrieve Chunks from a Knowledge Base / Test Retrieval

Performs a search query against a knowledge base to retrieve the most relevant chunks. This endpoint can be used for both production retrieval and test retrieval.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: HitTestingPayload

Responses

Code	Description	Schema
200	Retrieval results.	application/json: HitTestingResponse
400	- `dataset_not_initialized` : The dataset is still being initialized or indexing. Please wait a moment. - `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `provider_quota_exceeded` : Your quota for Dify Hosted OpenAI has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials. - `model_currently_not_support` : Dify Hosted OpenAI trial currently not support the GPT-4 model. - `completion_request_error` : Completion request failed. - `invalid_param` : Invalid parameter value.
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions.
404	`not_found` : Knowledge base not found.
500	`internal_server_error` : An internal error occurred during retrieval.

[POST] /datasets/{dataset_id}/retrieve

Retrieve Chunks from a Knowledge Base / Test Retrieval

Performs a search query against a knowledge base to retrieve the most relevant chunks. This endpoint can be used for both production retrieval and test retrieval.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: HitTestingPayload

Responses

Code	Description	Schema
200	Retrieval results.	application/json: HitTestingResponse
400	- `dataset_not_initialized` : The dataset is still being initialized or indexing. Please wait a moment. - `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `provider_quota_exceeded` : Your quota for Dify Hosted OpenAI has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials. - `model_currently_not_support` : Dify Hosted OpenAI trial currently not support the GPT-4 model. - `completion_request_error` : Completion request failed. - `invalid_param` : Invalid parameter value.
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions.
404	`not_found` : Knowledge base not found.
500	`internal_server_error` : An internal error occurred during retrieval.

default

[POST] /datasets/pipeline/file-upload

Upload Pipeline File

Upload a file for use in a knowledge pipeline. Accepts a single file via multipart/form-data.

Request Body

Required	Schema
Yes	multipart/form-data: { "file": binary }

Responses

Code	Description	Schema
201	File uploaded successfully.	application/json: PipelineUploadFileResponse
400	- `no_file_uploaded` : Please upload your file. - `filename_not_exists_error` : The specified filename does not exist. - `too_many_files` : Only one file is allowed.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
413	`file_too_large` : File size exceeded.
415	`unsupported_file_type` : File type not allowed.

[GET] /datasets/{dataset_id}/pipeline/datasource-plugins

List Datasource Plugins

List the datasource nodes configured in the knowledge pipeline. Each node includes the plugin it uses plus the metadata needed to run it.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
is_published	query	Whether to retrieve nodes from the published or draft pipeline. `true` returns nodes from the published version, `false` returns nodes from the draft.	No	boolean, Default: true

Responses

Code	Description	Schema
200	List of datasource nodes configured in the pipeline.	application/json: DatasourcePluginListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	`not_found` : Dataset not found.

[POST] /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run

Run Datasource Node

Execute a single datasource node within the knowledge pipeline. Returns a streaming response with the node execution results.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
node_id	path	ID of the datasource node to execute.	Yes	string

Request Body

Required	Schema
Yes	application/json: DatasourceNodeRunPayload

Responses

Code	Description	Schema
200	Streaming response with node execution events.	text/event-stream: GeneratedAppResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	`not_found` : Dataset not found.

[POST] /datasets/{dataset_id}/pipeline/run

Run Pipeline

Execute the full knowledge pipeline for a knowledge base. Supports both streaming and blocking response modes.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: PipelineRunApiEntity

Responses

Code	Description	Schema
200	Pipeline execution result. Format depends on `response_mode`: streaming returns a `text/event-stream`, blocking returns a JSON object.	application/json: GeneratedAppResponse text/event-stream: GeneratedAppResponse
401	Unauthorized - invalid API token
403	`forbidden` : Forbidden.
404	`not_found` : Dataset not found.
500	`pipeline_run_error` : Pipeline execution failed.

default

[DELETE] /datasets/tags

Delete Knowledge Tag

Permanently delete a knowledge base tag. Does not delete the knowledge bases that were tagged.

Request Body

Required	Schema
Yes	application/json: TagDeletePayload

Responses

Code	Description
204	Success.
401	Unauthorized - invalid API token
403	Forbidden - insufficient permissions

[GET] /datasets/tags

List Knowledge Tags

Returns the list of all knowledge base tags in the workspace.

Responses

Code	Description	Schema
200	List of tags.	application/json: KnowledgeTagListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[PATCH] /datasets/tags

Update Knowledge Tag

Rename an existing knowledge base tag.

Request Body

Required	Schema
Yes	application/json: TagUpdatePayload

Responses

Code	Description	Schema
200	Tag updated successfully.	application/json: KnowledgeTagResponse
401	Unauthorized - invalid API token
403	Forbidden - insufficient permissions

[POST] /datasets/tags

Create Knowledge Tag

Create a new tag for organizing knowledge bases.

Request Body

Required	Schema
Yes	application/json: TagCreatePayload

Responses

Code	Description	Schema
200	Tag created successfully.	application/json: KnowledgeTagResponse
401	Unauthorized - invalid API token
403	Forbidden - insufficient permissions

[POST] /datasets/tags/binding

Create Tag Binding

Bind one or more tags to a knowledge base. A knowledge base can have multiple tags.

Request Body

Required	Schema
Yes	application/json: TagBindingPayload

Responses

Code	Description
204	Success.
401	Unauthorized - invalid API token
403	Forbidden - insufficient permissions

[POST] /datasets/tags/unbinding

Delete Tag Binding

Remove one or more tags from a knowledge base.

Request Body

Required	Schema
Yes	application/json: TagUnbindingPayload

Responses

Code	Description
204	Success.
401	Unauthorized - invalid API token
403	Forbidden - insufficient permissions

[GET] /datasets/{dataset_id}/tags

Get Knowledge Base Tags

Returns the list of tags bound to a specific knowledge base.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Tags bound to the knowledge base.	application/json: DatasetBoundTagListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

default

[POST] /datasets/{dataset_id}/document/create-by-file

Create Document by File

Create a document by uploading a file. Supports common document formats (PDF, TXT, DOCX, etc.). Processing is asynchronous — use the returned batch ID with Get Document Indexing Status to track progress.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	multipart/form-data: { "data": string, "file": binary }

Responses

Code	Description	Schema
200	Document created successfully.	application/json: DocumentAndBatchResponse
400	- `no_file_uploaded` : Please upload your file. - `too_many_files` : Only one file is allowed. - `filename_not_exists_error` : The specified filename does not exist. - `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `invalid_param` : Knowledge base does not exist, external datasets not supported, file too large, unsupported file type, missing required fields, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`).
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[POST] /datasets/{dataset_id}/document/create-by-text

Create Document by Text

Create a document from raw text content. The document is processed asynchronously — use the returned batch ID with Get Document Indexing Status to track progress.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DocumentTextCreatePayload

Responses

Code	Description	Schema
200	Document created successfully.	application/json: DocumentAndBatchResponse
400	- `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `invalid_param` : Knowledge base does not exist. / indexing_technique is required. / Invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`).
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[POST] /datasets/{dataset_id}/document/create_by_file

DEPRECATED

Create Document by File

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	multipart/form-data: { "data": string, "file": binary }

Responses

Code	Description	Schema
200	Document created successfully.	application/json: DocumentAndBatchResponse
400	- `no_file_uploaded` : Please upload your file. - `too_many_files` : Only one file is allowed. - `filename_not_exists_error` : The specified filename does not exist. - `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `invalid_param` : Knowledge base does not exist, external datasets not supported, file too large, unsupported file type, missing required fields, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`).
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[GET] /datasets/{dataset_id}/documents

List Documents

Returns a paginated list of documents in the knowledge base. Supports filtering by keyword and indexing status.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
keyword	query	Search keyword to filter by document name.	No	string
limit	query	Number of items per page. Server caps at `100`.	No	integer, Default: 20
page	query	Page number to retrieve.	No	integer, Default: 1
status	query	Filter by display status.	No	string, Available values: "archived", "available", "disabled", "error", "indexing", "paused", "queuing"

Responses

Code	Description	Schema
200	List of documents.	application/json: DocumentListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	`not_found` : Knowledge base not found.

[POST] /datasets/{dataset_id}/documents/download-zip

Download Documents as ZIP

Download multiple uploaded-file documents as a single ZIP archive. Accepts up to 100 document IDs.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DocumentBatchDownloadZipPayload

Responses

Code	Description
200	ZIP archive containing the requested documents.
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions.
404	`not_found` : Document or dataset not found.

[PATCH] /datasets/{dataset_id}/documents/status/{action}

Update Document Status in Batch

Enable, disable, archive, or unarchive multiple documents at once.

Parameters

Name	Located in	Description	Required	Schema
action	path	Action to perform: 'enable', 'disable', 'archive', or 'un_archive'	Yes	string, Available values: "archive", "disable", "enable", "un_archive"
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DocumentStatusPayload

Responses

Code	Description	Schema
200	Document status updated successfully	application/json: SimpleResultResponse
400	`invalid_action` : Invalid action.
401	Unauthorized - invalid API token
403	`forbidden` : Insufficient permissions.
404	`not_found` : Knowledge base not found.

[GET] /datasets/{dataset_id}/documents/{batch}/indexing-status

Get Document Indexing Status

Check the indexing progress of documents in a batch. Returns the current processing stage and chunk completion counts for each document. Poll this endpoint until indexing_status reaches completed or error. The status progresses through: waiting → parsing → cleaning → splitting → indexing → completed.

Parameters

Name	Located in	Description	Required	Schema
batch	path	Batch ID.	Yes	string
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Indexing status for documents in the batch.	application/json: DocumentStatusListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	`not_found` : Knowledge base not found. / Documents not found.

[DELETE] /datasets/{dataset_id}/documents/{document_id}

Delete Document

Permanently delete a document and all its chunks from the knowledge base.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Responses

Code	Description
204	Success.
400	`document_indexing` : Cannot delete document during indexing.
401	Unauthorized - invalid API token
403	`archived_document_immutable` : The archived document is not editable.
404	`not_found` : Document Not Exists.

[GET] /datasets/{dataset_id}/documents/{document_id}

Get Document

Retrieve detailed information about a specific document, including its indexing status, metadata, and processing statistics.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
metadata	query	`all` returns all fields including metadata. `only` returns only `id`, `doc_type`, and `doc_metadata`. `without` returns all fields except `doc_metadata`.	No	string, Available values: "all", "only", "without", Default: all

Responses

Code	Description	Schema
200	Document details. The response shape varies based on the `metadata` query parameter. When `metadata` is `only`, only `id`, `doc_type`, and `doc_metadata` are returned. When `metadata` is `without`, `doc_type` and `doc_metadata` are omitted.	application/json: DocumentDetailResponse
400	`invalid_metadata` : Invalid metadata value for the specified key.
401	Unauthorized - invalid API token
403	`forbidden` : No permission.
404	`not_found` : Document not found.

[PATCH] /datasets/{dataset_id}/documents/{document_id}

Update an existing document by uploading a file

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
No	multipart/form-data: { "data": string, "file": binary }

Responses

Code	Description	Schema
200	Document updated successfully	application/json: DocumentAndBatchResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Document not found

[GET] /datasets/{dataset_id}/documents/{document_id}/download

Download Document

Get a signed download URL for a document's original uploaded file.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Download URL generated successfully.	application/json: UrlResponse
401	Unauthorized - invalid API token
403	`forbidden` : No permission to access this document.
404	`not_found` : Document not found.

[POST] /datasets/{dataset_id}/documents/{document_id}/update-by-file

DEPRECATED

Update Document by File

Update an existing document by uploading a new file. Re-triggers indexing — use the returned batch ID with Get Document Indexing Status to track progress.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
No	multipart/form-data: { "data": string, "file": binary }

Responses

Code	Description	Schema
200	Document updated successfully.	application/json: DocumentAndBatchResponse
400	- `too_many_files` : Only one file is allowed. - `filename_not_exists_error` : The specified filename does not exist. - `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `invalid_param` : Knowledge base does not exist, external datasets not supported, file too large, unsupported file type, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`).
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Document not found

[POST] /datasets/{dataset_id}/documents/{document_id}/update-by-text

Update Document by Text

Update an existing document's text content, name, or processing configuration. Re-triggers indexing if content changes — use the returned batch ID with Get Document Indexing Status to track progress.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: DocumentTextUpdate

Responses

Code	Description	Schema
200	Document updated successfully.	application/json: DocumentAndBatchResponse
400	- `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `invalid_param` : Knowledge base does not exist, name is required when text is provided, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`).
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Document not found

[POST] /datasets/{dataset_id}/documents/{document_id}/update_by_file

DEPRECATED

Update Document by File

Update an existing document by uploading a new file. Re-triggers indexing — use the returned batch ID with Get Document Indexing Status to track progress.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
No	multipart/form-data: { "data": string, "file": binary }

Responses

Code	Description	Schema
200	Document updated successfully.	application/json: DocumentAndBatchResponse
400	- `too_many_files` : Only one file is allowed. - `filename_not_exists_error` : The specified filename does not exist. - `provider_not_initialize` : No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. - `invalid_param` : Knowledge base does not exist, external datasets not supported, file too large, unsupported file type, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`).
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Document not found

default

[POST] /datasets/{dataset_id}/documents/metadata

Update Document Metadata in Batch

Update metadata values for multiple documents at once. Each document in the request receives the specified metadata key-value pairs.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: MetadataOperationData

Responses

Code	Description	Schema
200	Document metadata updated successfully.	application/json: DatasetMetadataActionResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset not found

[GET] /datasets/{dataset_id}/metadata

List Metadata Fields

Returns the list of all metadata fields (both custom and built-in) for the knowledge base, along with the count of documents using each field.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Metadata fields for the knowledge base.	application/json: DatasetMetadataListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset not found

[POST] /datasets/{dataset_id}/metadata

Create Metadata Field

Create a custom metadata field for the knowledge base. Metadata fields can be used to annotate documents with structured information.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: MetadataArgs

Responses

Code	Description	Schema
201	Metadata field created successfully.	application/json: DatasetMetadataResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset not found

[GET] /datasets/{dataset_id}/metadata/built-in

Get Built-in Metadata Fields

Returns the list of built-in metadata fields provided by the system (e.g., document type, source URL).

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Built-in metadata fields.	application/json: DatasetMetadataBuiltInFieldsResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied

[POST] /datasets/{dataset_id}/metadata/built-in/{action}

Update Built-in Metadata Field

Enable or disable built-in metadata fields for the knowledge base.

Parameters

Name	Located in	Description	Required	Schema
action	path	`enable` to activate built-in metadata fields, `disable` to deactivate them.	Yes	string, Available values: "disable", "enable"
dataset_id	path	Knowledge base ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Built-in metadata field toggled successfully.	application/json: DatasetMetadataActionResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset not found

[DELETE] /datasets/{dataset_id}/metadata/{metadata_id}

Delete Metadata Field

Permanently delete a custom metadata field. Documents using this field will lose their metadata values for it.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
metadata_id	path	Metadata field ID.	Yes	string (uuid)

Responses

Code	Description
204	Success.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset or metadata not found

[PATCH] /datasets/{dataset_id}/metadata/{metadata_id}

Update Metadata Field

Rename a custom metadata field.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
metadata_id	path	Metadata field ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: MetadataUpdatePayload

Responses

Code	Description	Schema
200	Metadata field updated successfully.	application/json: DatasetMetadataResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset or metadata not found

default

[GET] /datasets/{dataset_id}/documents/{document_id}/segments

List Chunks

Returns a paginated list of chunks within a document. Supports filtering by keyword and status.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
keyword	query	Search keyword.	No	string
limit	query	Number of items per page. Server caps at `100`.	No	integer, Default: 20
page	query	Page number to retrieve.	No	integer, Default: 1
status	query	Filter chunks by indexing status, such as `completed`, `indexing`, or `error`.	No	[ string ]

Responses

Code	Description	Schema
200	List of chunks.	application/json: SegmentListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset or document not found

[POST] /datasets/{dataset_id}/documents/{document_id}/segments

Create Chunks

Create one or more chunks within a document. Each chunk can include optional keywords and an answer field (for QA-mode documents).

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: SegmentCreatePayload

Responses

Code	Description	Schema
200	Chunks created successfully.	application/json: SegmentCreateListResponse
400	Bad request - segments data is missing
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	`not_found` : Document is not completed or is disabled.

[DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}

Delete Chunk

Permanently delete a chunk from the document.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)

Responses

Code	Description
204	Success.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, or segment not found

[GET] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}

Get Chunk

Retrieve detailed information about a specific chunk, including its content, keywords, and indexing status.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)

Responses

Code	Description	Schema
200	Chunk details.	application/json: SegmentDetailResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, or segment not found

[POST] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}

Update Chunk

Update a chunk's content, keywords, or answer. Re-triggers indexing for the modified chunk.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: SegmentUpdatePayload

Responses

Code	Description	Schema
200	Chunk updated successfully.	application/json: SegmentDetailResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, or segment not found

[GET] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks

List Child Chunks

Returns a paginated list of child chunks under a specific parent chunk.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)
keyword	query	Search keyword.	No	string
limit	query	Number of items per page. Server caps at `100`.	No	integer, Default: 20
page	query	Page number to retrieve.	No	integer, Default: 1

Responses

Code	Description	Schema
200	List of child chunks.	application/json: ChildChunkListResponse
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, or segment not found

[POST] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks

Create Child Chunk

Create a child chunk under the specified segment.

Parameters

Name	Located in	Description	Required	Schema
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: ChildChunkCreatePayload

Responses

Code	Description	Schema
200	Child chunk created successfully.	application/json: ChildChunkDetailResponse
400	`invalid_param` : Create child chunk index failed.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, or segment not found

[DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}

Delete Child Chunk

Permanently delete a child chunk from its parent chunk.

Parameters

Name	Located in	Description	Required	Schema
child_chunk_id	path	Child chunk ID.	Yes	string (uuid)
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)

Responses

Code	Description
204	Success.
400	`invalid_param` : Delete child chunk index failed.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, segment, or child chunk not found

[PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}

Update Child Chunk

Update the content of an existing child chunk.

Parameters

Name	Located in	Description	Required	Schema
child_chunk_id	path	Child chunk ID.	Yes	string (uuid)
dataset_id	path	Knowledge base ID.	Yes	string (uuid)
document_id	path	Document ID.	Yes	string (uuid)
segment_id	path	Chunk ID.	Yes	string (uuid)

Request Body

Required	Schema
Yes	application/json: ChildChunkUpdatePayload

Responses

Code	Description	Schema
200	Child chunk updated successfully.	application/json: ChildChunkDetailResponse
400	`invalid_param` : Update child chunk index failed.
401	Unauthorized - invalid API token
403	Forbidden - dataset API access or workspace access denied
404	Dataset, document, segment, or child chunk not found

default

[GET] /end-users/{end_user_id}

Get End User Info

Retrieve an end user by ID. Useful when other APIs return an end-user ID (e.g., created_by from Upload File).

Parameters

Name	Located in	Description	Required	Schema
end_user_id	path	End user ID	Yes	string (uuid)

Responses

Code	Description	Schema
200	End user retrieved successfully.	application/json: EndUserDetail
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`end_user_not_found` : End user not found.

default

[POST] /files/upload

Upload File

Upload a file for use when sending messages, enabling multimodal understanding of images, documents, audio, and video. Uploaded files are for use by the current end-user only.

Request Body

Required	Schema
Yes	multipart/form-data: { "file": binary, "user": string }

Responses

Code	Description	Schema
201	File uploaded successfully.	application/json: FileResponse
400	- `no_file_uploaded` : No file was provided in the request. - `too_many_files` : Only one file is allowed per request. - `filename_not_exists_error` : The uploaded file has no filename.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
413	`file_too_large` : File size exceeded.
415	`unsupported_file_type` : File type not allowed.

[GET] /files/{file_id}/preview

Download File

Preview or download uploaded files previously uploaded via the Upload File API. Files can only be accessed if they belong to messages within the requesting application.

Parameters

Name	Located in	Description	Required	Schema
file_id	path	The unique identifier of the file to preview, obtained from the Upload File API response.	Yes	string (uuid)
as_attachment	query	If `true`, forces the file to download as an attachment instead of previewing in browser.	No	boolean
user	query	User identifier, used for end-user context.	No	string

Responses

Code	Description
200	Returns the raw file content. The `Content-Type` header is set to the file's MIME type. If `as_attachment` is `true`, the file is returned as a download with `Content-Disposition: attachment`.
401	Unauthorized - invalid API token
403	`file_access_denied` : Access to the requested file is denied.
404	`file_not_found` : The requested file was not found.

default

[GET] /form/human_input/{form_token}

Get Human Input Form

Retrieve a paused Human Input form's contents using the form_token from a human_input_required event. Requires WebApp delivery.

Parameters

Name	Located in	Description	Required	Schema
form_token	path	Human input form token	Yes	string

Responses

Code	Description	Schema
200	Form contents retrieved successfully.	application/json: HumanInputFormDefinitionResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Form not found.
412	- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it. - `human_input_form_expired` : The form's expiration time passed before submission arrived.

[POST] /form/human_input/{form_token}

Submit Human Input Form

Submit the recipient's response to a paused Human Input form. The workflow resumes on acceptance; use Stream Workflow Events to follow subsequent events. Requires WebApp delivery.

Parameters

Name	Located in	Description	Required	Schema
form_token	path	Human input form token	Yes	string

Request Body

Required	Schema
Yes	application/json: HumanInputFormSubmitPayloadWithUser

Responses

Code	Description	Schema
200	Form submitted successfully. The response body is an empty object.	application/json: HumanInputFormSubmitResponse
400	- `bad_request` : Form recipient type is invalid. - `invalid_form_data` : Submission failed validation against the form definition.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Form not found.
412	- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it. - `human_input_form_expired` : The form's expiration time passed before submission arrived.

default

[GET] /info

Get App Info

Retrieve basic information about this application, including name, description, tags, and mode.

Responses

Code	Description	Schema
200	Basic information of the application.	application/json: AppInfoResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Application not found

[GET] /meta

Get App Meta

Retrieve metadata about this application, including tool icons and other configuration details.

Responses

Code	Description	Schema
200	Successfully retrieved application meta information.	application/json: AppMetaResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Application not found

[GET] /parameters

Get App Parameters

Retrieve the application's input form configuration, including feature switches, input parameter names, types, and default values.

Responses

Code	Description	Schema
200	Application parameters information.	application/json: Parameters
400	`app_unavailable` : App unavailable or misconfigured.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Application not found

[GET] /site

Get App WebApp Settings

Retrieve the WebApp settings of this application, including site configuration, theme, and customization options.

Responses

Code	Description	Schema
200	WebApp settings of the application.	application/json: Site
401	Unauthorized - invalid API token
403	`forbidden` : Site not found for this application or the workspace has been archived.

default

[GET] /workflow/{task_id}/events

Stream Workflow Events

Resume the Server-Sent Events stream for a workflow run after a pause or a dropped SSE connection. For runs that have already finished, the stream emits a single workflow_finished event and closes.

Parameters

Name	Located in	Description	Required	Schema
task_id	path	Workflow run ID returned by the original workflow run request.	Yes	string
continue_on_pause	query	Set to `true` to keep the stream open across multiple `workflow_paused` events, which is useful when the workflow has more than one Human Input node in sequence. By default, the stream closes after the first pause.	No	boolean
include_state_snapshot	query	When `true`, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.	No	boolean
user	query	End-user identifier that originally triggered the run. Must match the creator of the run.	Yes	string

Responses

Code	Description	Schema
200	Server-Sent Events stream. Each event is delivered as `data: {JSON}\\n\\n`. Event payloads follow the same schemas as the original streaming response.	text/event-stream: EventStreamResponse
400	`not_workflow_app` : Please check if your app mode matches the right API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Workflow run not found.

[GET] /workflows/logs

List Workflow Logs

Retrieve paginated workflow execution logs with filtering options.

Parameters

Name	Located in	Description	Required	Schema
created_at__after	query	Filter logs created after this ISO 8601 timestamp.	No	dateTime
created_at__before	query	Filter logs created before this ISO 8601 timestamp.	No	dateTime
created_by_account	query	Filter by account ID.	No	string
created_by_end_user_session_id	query	Filter by end user session ID.	No	string
keyword	query	Keyword to search in logs.	No	string
limit	query	Number of items per page.	No	integer, Default: 20
page	query	Page number for pagination.	No	integer, Default: 1
status	query	Filter by execution status.	No	string, Available values: "failed", "stopped", "succeeded"

Responses

Code	Description	Schema
200	Successfully retrieved workflow logs.	application/json: WorkflowAppLogPaginationResponse
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied

[POST] /workflows/run

Run Workflow

Execute a workflow. Cannot be executed without a published workflow.

Request Body

Required	Schema
Yes	application/json: WorkflowRunPayloadWithUser

Responses

Code	Description	Schema
200	Successful response. The content type and structure depend on the `response_mode` parameter in the request. - If `response_mode` is `blocking`, returns `application/json` with a `WorkflowBlockingResponse` object. - If `response_mode` is `streaming`, returns `text/event-stream` with a stream of `ChunkWorkflowEvent` objects.	application/json: GeneratedAppResponse text/event-stream: GeneratedAppResponse
400	- `not_workflow_app` : App mode does not match the API route. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model unavailable. - `completion_request_error` : Workflow execution request failed. - `invalid_param` : Invalid parameter value.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Workflow not found
429	- `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The upstream model provider rate limit was exceeded.
500	`internal_server_error` : Internal server error.

[GET] /workflows/run/{workflow_run_id}

Get Workflow Run Detail

Retrieve the current execution results of a workflow task based on the workflow execution ID.

Parameters

Name	Located in	Description	Required	Schema
workflow_run_id	path	Workflow run ID, obtained from the workflow execution response or streaming events.	Yes	string

Responses

Code	Description	Schema
200	Successfully retrieved workflow run details.	application/json: WorkflowRunResponse
400	`not_workflow_app` : App mode does not match the API route.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Workflow run not found.

[POST] /workflows/tasks/{task_id}/stop

Stop Workflow Task

Stop a running workflow task. Only supported in streaming mode.

Parameters

Name	Located in	Description	Required	Schema
task_id	path	Task ID, obtained from the streaming chunk returned by the Run Workflow API.	Yes	string

Request Body

Required	Schema
Yes	application/json: RequiredServiceApiUserPayload

Responses

Code	Description	Schema
200	Task stopped successfully	application/json: SimpleResultResponse
400	- `not_workflow_app` : App mode does not match the API route. - `invalid_param` : Required parameter missing or invalid.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	Task not found

[POST] /workflows/{workflow_id}/run

Run Workflow by ID

Execute a specific workflow version identified by its ID. Useful for running a particular published version of the workflow.

Parameters

Name	Located in	Description	Required	Schema
workflow_id	path	Workflow ID of the specific version to execute. This value is returned in the `workflow_id` field of workflow run responses.	Yes	string

Request Body

Required	Schema
Yes	application/json: WorkflowRunPayloadWithUser

Responses

Code	Description	Schema
200	Successful response. The content type and structure depend on the `response_mode` parameter in the request. - If `response_mode` is `blocking`, returns `application/json` with a `WorkflowBlockingResponse` object. - If `response_mode` is `streaming`, returns `text/event-stream` with a stream of `ChunkWorkflowEvent` objects.	application/json: GeneratedAppResponse text/event-stream: GeneratedAppResponse
400	- `not_workflow_app` : App mode does not match the API route. - `bad_request` : Workflow is a draft or has an invalid ID format. - `provider_not_initialize` : No valid model provider credentials found. - `provider_quota_exceeded` : Model provider quota exhausted. - `model_currently_not_support` : Current model unavailable. - `completion_request_error` : Workflow execution request failed. - `invalid_param` : Required parameter missing or invalid.
401	Unauthorized - invalid API token
403	Forbidden - token scope, app, dataset, or workspace access denied
404	`not_found` : Workflow not found.
429	- `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The upstream model provider rate limit was exceeded.
500	`internal_server_error` : Internal server error.

default

[GET] /workspaces/current/models/model-types/{model_type}

Get Available Models

Retrieve the list of available models by type. Primarily used to query text-embedding and rerank models for knowledge base configuration.

Parameters

Name	Located in	Description	Required	Schema
model_type	path	Type of model to retrieve.	Yes	string, Available values: "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts"

Responses

Code	Description	Schema
200	Available models for the specified type.	application/json: ProviderWithModelsListResponse
401	Unauthorized - invalid API token

Schemas

AgentThought

Name	Type	Required
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	JSONValue	Yes

Annotation

Name	Type	Required
content	string	No
created_at	integer	No
hit_count	integer	No
id	string	Yes
question	string	No

AnnotationCreatePayload

Name	Type	Description	Required
answer	string	Annotation answer.	Yes
question	string	Annotation question.	Yes

AnnotationJobStatusResponse

Name	Type	Required
error_msg	string	No
job_id	string	Yes
job_status	string	Yes

AnnotationList

Name	Type	Required
data	[ Annotation ]	Yes
has_more	boolean	Yes
limit	integer	Yes
page	integer	Yes
total	integer	Yes

AnnotationListQuery

Name	Type	Description	Required
keyword	string	Keyword to filter annotations by question or answer content.	No
limit	integer, Default: 20	Number of items per page.	No
page	integer, Default: 1	Page number for pagination.	No

AnnotationReplyActionPayload

Name	Type	Description	Required
embedding_model_name	string	Name of the embedding model to use for annotation matching.	Yes
embedding_provider_name	string	Name of the embedding model provider.	Yes
score_threshold	float	Minimum similarity score for an annotation to be considered a match. Higher values require closer matches.	Yes

AppFeedbackListResponse

Name	Type	Description	Required
data	[ AppFeedbackResponse ]		Yes

AppFeedbackResponse

Name	Type	Required
app_id	string	Yes
content	string	No
conversation_id	string	Yes
created_at	string	Yes
from_account_id	string	No
from_end_user_id	string	No
from_source	string	Yes
id	string	Yes
message_id	string	Yes
rating	string	Yes
updated_at	string	Yes

AppInfoResponse

Name	Type	Required
author_name	string	Yes
description	string	Yes
mode	string	Yes
name	string	Yes
tags	[ string ]	Yes

AppMetaResponse

Name	Type	Description	Required
tool_icons	object		No

AudioBinaryResponse

Name	Type	Description	Required
AudioBinaryResponse	string

AudioTranscriptResponse

Name	Type	Description	Required
text	string		Yes

BinaryFileResponse

Name	Type	Description	Required
BinaryFileResponse	string

ButtonStyle

Button styles for user actions.

Name	Type	Description	Required
ButtonStyle	string	Button styles for user actions.

ChatRequestPayload

Name	Type	Description	Required
auto_generate_name	boolean, Default: true	Auto-generate the conversation title. If `false`, use the Rename Conversation API with `auto_generate: true` to generate the title asynchronously.	No
conversation_id	string	Conversation ID to continue a conversation. Omit this field or pass an empty string to start a new conversation, then pass the returned `conversation_id` in subsequent requests.	No
files	[ object ]	File list for multimodal understanding, including images, documents, audio, and video. 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	Values for app-defined variables. Refer to the `user_input_form` field in the Get App Parameters response to discover expected variable names and types.	Yes
query	string	User input or question content.	Yes
response_mode	string	Response mode. `streaming` uses Server-Sent Events; `blocking` returns after completion. New Agent app mode supports streaming only. When omitted, non-Agent apps run in blocking mode and new Agent apps stream.	No
workflow_id	string	Published workflow version ID to execute for advanced chat. If omitted, the app's current published workflow is used.	No

ChatRequestPayloadWithUser

Name	Type	Description	Required
auto_generate_name	boolean, Default: true	Auto-generate the conversation title. If `false`, use the Rename Conversation API with `auto_generate: true` to generate the title asynchronously.	No
conversation_id	string	Conversation ID to continue a conversation. Omit this field or pass an empty string to start a new conversation, then pass the returned `conversation_id` in subsequent requests.	No
files	[ object ]	File list for multimodal understanding, including images, documents, audio, and video. 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	Values for app-defined variables. Refer to the `user_input_form` field in the Get App Parameters response to discover expected variable names and types.	Yes
query	string	User input or question content.	Yes
response_mode	string	Response mode. `streaming` uses Server-Sent Events; `blocking` returns after completion. New Agent app mode supports streaming only. When omitted, non-Agent apps run in blocking mode and new Agent apps stream.	No
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	Yes
workflow_id	string	Published workflow version ID to execute for advanced chat. If omitted, the app's current published workflow is used.	No

ChildChunkCreatePayload

Name	Type	Description	Required
content	string	Child chunk text content.	Yes

ChildChunkDetailResponse

Name	Type	Description	Required
data	ChildChunkResponse		Yes

ChildChunkListQuery

Name	Type	Description	Required
keyword	string	Search keyword.	No
limit	integer, Default: 20	Number of items per page. Server caps at `100`.	No
page	integer, Default: 1	Page number to retrieve.	No

ChildChunkListResponse

Name	Type	Required
data	[ ChildChunkResponse ]	Yes
limit	integer	Yes
page	integer	Yes
total	integer	Yes
total_pages	integer	Yes

ChildChunkResponse

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

ChildChunkUpdatePayload

Name	Type	Description	Required
content	string	Child chunk text content.	Yes

CompletionRequestPayload

Name	Type	Description	Required
files	[ object ]	File list for multimodal understanding, including images, documents, audio, and video. 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	Values for app-defined variables. Refer to the `user_input_form` field in the Get App Parameters response to discover expected variable names and types.	Yes
query	string	User input or prompt content.	No
response_mode	string	Response mode. `streaming` uses Server-Sent Events; `blocking` returns after completion. When omitted, the request runs in blocking mode.	No

CompletionRequestPayloadWithUser

Name	Type	Description	Required
files	[ object ]	File list for multimodal understanding, including images, documents, audio, and video. 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	Values for app-defined variables. Refer to the `user_input_form` field in the Get App Parameters response to discover expected variable names and types.	Yes
query	string	User input or prompt content.	No
response_mode	string	Response mode. `streaming` uses Server-Sent Events; `blocking` returns after completion. When omitted, the request runs in blocking mode.	No
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	Yes

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

ConversationInfiniteScrollPagination

Name	Type	Required
data	[ SimpleConversation ]	Yes
has_more	boolean	Yes
limit	integer	Yes

ConversationListQuery

Name	Type	Description	Required
last_id	string	The ID of the last record on the current page. Used to fetch the next page.	No
limit	integer, Default: 20	Number of records to return.	No
sort_by	string, Available values: "-created_at", "-updated_at", "created_at", "updated_at", Default: -updated_at	Sorting field. Use the `-` prefix for descending order. Enum: `"-created_at"`, `"-updated_at"`, `"created_at"`, `"updated_at"`	No

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

ConversationRenamePayloadWithUser

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
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	No

ConversationVariableInfiniteScrollPaginationResponse

Name	Type	Required
data	[ ConversationVariableResponse ]	Yes
has_more	boolean	Yes
limit	integer	Yes

ConversationVariableResponse

Name	Type	Required
created_at	integer	No
description	string	No
id	string	Yes
name	string	Yes
updated_at	integer	No
value	string	No
value_type	string	Yes

ConversationVariableUpdatePayload

Name	Type	Description	Required
value		The new value for the variable. Must match the variable's expected type.	Yes

ConversationVariableUpdatePayloadWithUser

Name	Type	Description	Required
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	No
value		The new value for the variable. Must match the variable's expected type.	Yes

ConversationVariablesQuery

Name	Type	Description	Required
last_id	string	The ID of the last record on the current page. Used to fetch the next page.	No
limit	integer, Default: 20	Number of records to return.	No
variable_name	string	Filter variables by a specific name.	No

CustomConfigurationStatus

Enum class for custom configuration status.

Name	Type	Description	Required
CustomConfigurationStatus	string	Enum class for custom configuration status.

DatasetBoundTagListResponse

Name	Type	Description	Required
data	[ DatasetBoundTagResponse ]		Yes
total	integer		Yes

DatasetBoundTagResponse

Name	Type	Description	Required
id	string		Yes
name	string		Yes

DatasetCreatePayload

Name	Type	Description	Required
description	string	Description of the knowledge base.	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
external_knowledge_api_id	string	ID of the external knowledge API.	No
external_knowledge_id	string	ID of the external knowledge base.	No
indexing_technique	string	`high_quality` uses embedding models for precise search; `economy` uses keyword-based indexing.	No
name	string	Name of the knowledge base.	Yes
permission	PermissionEnum	Controls who can access this knowledge base. `only_me` restricts access to the creator, `all_team_members` grants workspace-wide access, and `partial_members` grants access to specified members.	No
provider	string, Available values: "external", "vendor", Default: vendor	Knowledge base provider: `vendor` for internal knowledge bases, `external` for external ones. Enum: `"external"`, `"vendor"`	No
retrieval_model	RetrievalModel	Retrieval model configuration. Controls how chunks are searched and ranked.	No
summary_index_setting	object	Summary index configuration.	No

DatasetDetailResponse

Name	Type	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	No
external_retrieval_model	DatasetExternalRetrievalModelResponse	Yes
icon_info	DatasetIconInfoResponse	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	Yes
runtime_mode	string	Yes
summary_index_setting	DatasetSummaryIndexSettingResponse	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	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	No
external_retrieval_model	DatasetExternalRetrievalModelResponse	Yes
icon_info	DatasetIconInfoResponse	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	Yes
runtime_mode	string	Yes
summary_index_setting	DatasetSummaryIndexSettingResponse	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	Required
id	string	Yes
name	string	Yes
type	string	Yes

DatasetExternalKnowledgeInfoResponse

Name	Type	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	Required
score_threshold	number	No
score_threshold_enabled	boolean	No
top_k	integer	Yes

DatasetIconInfoResponse

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

DatasetListQuery

Name	Type	Description	Required
include_all	boolean	Whether to include all knowledge bases regardless of permissions.	No
keyword	string	Search keyword to filter by name.	No
limit	integer, Default: 20	Number of items per page. Server caps at `100`.	No
page	integer, Default: 1	Page number to retrieve.	No
tag_ids	[ string ]	Tag IDs to filter by.	No

DatasetListResponse

Name	Type	Required
data	[ DatasetDetailResponse ]	Yes
has_more	boolean	Yes
limit	integer	Yes
page	integer	Yes
total	integer	Yes

DatasetMetadataActionResponse

Name	Type	Description	Required
result	string		Yes

DatasetMetadataBuiltInFieldResponse

Name	Type	Description	Required
name	string		Yes
type	string		Yes

DatasetMetadataBuiltInFieldsResponse

Name	Type	Description	Required
fields	[ DatasetMetadataBuiltInFieldResponse ]		Yes

DatasetMetadataListItemResponse

Name	Type	Required
count	integer	No
id	string	Yes
name	string	Yes
type	string	Yes

DatasetMetadataListResponse

Name	Type	Description	Required
built_in_field_enabled	boolean		Yes
doc_metadata	[ DatasetMetadataListItemResponse ]		Yes

DatasetMetadataResponse

Name	Type	Required
id	string	Yes
name	string	Yes
type	string	Yes

DatasetRerankingModelResponse

Name	Type	Description	Required
reranking_model_name	string		No
reranking_provider_name	string		No

DatasetRetrievalModelResponse

Name	Type	Required
reranking_enable	boolean	Yes
reranking_mode	string	No
reranking_model	DatasetRerankingModelResponse	No
score_threshold	number	No
score_threshold_enabled	boolean	Yes
search_method	string	Yes
top_k	integer	Yes
weights	DatasetWeightedScoreResponse	No

DatasetSummaryIndexSettingResponse

Name	Type	Required
enable	boolean	No
model_name	string	No
model_provider_name	string	No
summary_prompt	string	No

DatasetTagResponse

Name	Type	Required
id	string	Yes
name	string	Yes
type	string	Yes

DatasetUpdatePayload

Name	Type	Description	Required
description	string	Description of the knowledge base.	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
external_knowledge_api_id	string	ID of the external knowledge API.	No
external_knowledge_id	string	ID of the external knowledge base.	No
external_retrieval_model	object	Retrieval settings for external knowledge bases.	No
indexing_technique	string	`high_quality` uses embedding models for precise search; `economy` uses keyword-based indexing.	No
name	string	Name of the knowledge base.	No
partial_member_list	[ object ]	List of team members with access when `permission` is `partial_members`.	No
permission	PermissionEnum	Controls who can access this knowledge base. `only_me` restricts access to the creator, `all_team_members` grants workspace-wide access, and `partial_members` grants access to specified members.	No
retrieval_model	RetrievalModel	Retrieval model configuration. Controls how chunks are searched and ranked.	No

DatasetVectorSettingResponse

Name	Type	Required
embedding_model_name	string	No
embedding_provider_name	string	No
vector_weight	number	No

DatasetWeightedScoreResponse

Name	Type	Required
keyword_setting	DatasetKeywordSettingResponse	No
vector_setting	DatasetVectorSettingResponse	No
weight_type	string	No

DatasourceCredentialInfoResponse

Name	Type	Required
id	string	No
is_default	boolean	No
name	string	No
type	string	No

DatasourceNodeRunPayload

Name	Type	Description	Required
credential_id	string	Datasource credential ID. Uses the default if omitted.	No
datasource_type	string, Available values: "local_file", "online_document", "online_drive", "website_crawl"	Type of the datasource. Enum: `"local_file"`, `"online_document"`, `"online_drive"`, `"website_crawl"`	Yes
inputs	object	Input variables for the datasource node.	Yes
is_published	boolean	Whether to run the published or draft version of the node. `true` runs the published version, `false` runs the draft.	Yes

DatasourcePluginListResponse

Name	Type	Description	Required
DatasourcePluginListResponse	array

DatasourcePluginResponse

Name	Type	Required
credentials	[ DatasourceCredentialInfoResponse ]	Yes
datasource_type	string	No
node_id	string	No
plugin_id	string	No
provider_name	string	No
title	string	No
user_input_variables	[ object ]	No

DatasourcePluginsQuery

Name	Type	Description	Required
is_published	boolean, Default: true	Whether to retrieve nodes from the published or draft pipeline. `true` returns nodes from the published version, `false` returns nodes from the draft.	No

DocumentAndBatchResponse

Name	Type	Description	Required
batch	string		Yes
document	DocumentResponse		Yes

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	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_info	object	No
data_source_type	string	No
dataset_process_rule	object	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	object	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
summary_index_status	string	No
tokens	integer	No
updated_at	integer	No

DocumentGetQuery

Name	Type	Description	Required
metadata	string, Available values: "all", "only", "without", Default: all	`all` returns all fields including metadata. `only` returns only `id`, `doc_type`, and `doc_metadata`. `without` returns all fields except `doc_metadata`. Enum: `"all"`, `"only"`, `"without"`	No

DocumentListQuery

Name	Type	Description	Required
keyword	string	Search keyword to filter by document name.	No
limit	integer, Default: 20	Number of items per page. Server caps at `100`.	No
page	integer, Default: 1	Page number to retrieve.	No
status	string	Filter by display status.	No

DocumentListResponse

Name	Type	Required
data	[ DocumentResponse ]	Yes
has_more	boolean	Yes
limit	integer	Yes
page	integer	Yes
total	integer	Yes

DocumentMetadataOperation

Name	Type	Description	Required
document_id	string	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	Required
id	string	Yes
name	string	Yes
type	string	Yes
value	string integer number boolean	No

DocumentResponse

Name	Type	Required
archived	boolean	No
created_at	integer	No
created_by	string	No
created_from	string	No
data_source_detail_dict		No
data_source_info		No
data_source_type	string	No
dataset_process_rule_id	string	No
disabled_at	integer	No
disabled_by	string	No
display_status	string	No
doc_form	string	No
doc_metadata	[ DocumentMetadataResponse ]	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

DocumentStatusListResponse

Name	Type	Description	Required
data	[ DocumentStatusResponse ]		Yes

DocumentStatusPayload

Name	Type	Description	Required
document_ids	[ string ]	List of document IDs to update.	No

DocumentStatusResponse

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

DocumentTextCreatePayload

Name	Type	Description	Required
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
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	`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.	No
name	string	Document name.	Yes
original_document_id	string	Original document ID for replacement.	No
process_rule	ProcessRule	Processing rules for chunking.	No
retrieval_model	RetrievalModel	Retrieval model configuration. Controls how chunks are searched and ranked.	No
text	string	Document text content.	Yes

DocumentTextUpdate

Name	Type	Description	Required
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
name	string	Document name. Required when `text` is provided.	No
process_rule	ProcessRule	Processing rules for chunking.	No
retrieval_model	RetrievalModel	Retrieval model configuration. Controls how chunks are searched and ranked.	No
text	string	Document text content.	No

EndUserDetail

Full EndUser record for API responses.

Note: The SQLAlchemy model defines an is_anonymous property for Flask-Login semantics (always False). The database column is exposed as _is_anonymous, so this DTO maps is_anonymous from _is_anonymous to return the stored value.

Name	Type	Required
app_id	string	No
created_at	dateTime	Yes
external_user_id	string	No
id	string	Yes
is_anonymous	boolean	Yes
name	string	No
session_id	string	Yes
tenant_id	string	Yes
type	string	Yes
updated_at	dateTime	Yes

EventStreamResponse

Name	Type	Description	Required
EventStreamResponse	string

ExecutionContentType

Name	Type	Description	Required
ExecutionContentType	string

FeedbackListQuery

Name	Type	Description	Required
limit	integer, Default: 20	Number of records per page.	No
page	integer, Default: 1	Page number for pagination.	No

FetchFrom

Enum class for fetch from.

Name	Type	Description	Required
FetchFrom	string	Enum class for fetch from.

FileInputConfig

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

FilePreviewQuery

Name	Type	Description	Required
as_attachment	boolean	If `true`, forces the file to download as an attachment instead of previewing in browser.	No

FileResponse

Name	Type	Required
conversation_id	string	No
created_at	integer	No
created_by	string	No
extension	string	No
file_key	string	No
id	string	Yes
mime_type	string	No
name	string	Yes
original_url	string	No
preview_url	string	No
reference	string	No
size	integer	Yes
source_url	string	No
tenant_id	string	No
user_id	string	No

FileTransferMethod

Name	Type	Description	Required
FileTransferMethod	string

FileType

Name	Type	Description	Required
FileType	string

FormInputConfig

Name	Type	Description	Required
FormInputConfig	ParagraphInputConfig SelectInputConfig FileInputConfig FileListInputConfig

GeneratedAppResponse

Name	Type	Description	Required
GeneratedAppResponse

HitTestingChildChunk

Name	Type	Required
content	string	Yes
id	string	Yes
position	integer	Yes
score	number	Yes

HitTestingDocument

Name	Type	Required
data_source_type	string	Yes
doc_metadata		Yes
doc_type	string	Yes
id	string	Yes
name	string	Yes

HitTestingFile

Name	Type	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.	No

HitTestingQuery

Name	Type	Description	Required
content	string		Yes

HitTestingRecord

Name	Type	Required
child_chunks	[ HitTestingChildChunk ]	Yes
files	[ HitTestingFile ]	Yes
score	number	Yes
segment	HitTestingSegment	Yes
summary	string	Yes
tsne_position		Yes

HitTestingResponse

Name	Type	Description	Required
query	HitTestingQuery		Yes
records	[ HitTestingRecord ]		Yes

HitTestingSegment

Name	Type	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	Yes
document_id	string	Yes
enabled	boolean	Yes
error	string	Yes
hit_count	integer	Yes
id	string	Yes
index_node_hash	string	Yes
index_node_id	string	Yes
indexing_at	integer	Yes
keywords	[ string ]	Yes
position	integer	Yes
sign_content	string	Yes
status	string	Yes
stopped_at	integer	Yes
tokens	integer	Yes
word_count	integer	Yes

HumanInputContent

Name	Type	Required
form_definition	HumanInputFormDefinition	No
form_submission_data	HumanInputFormSubmissionData	No
submitted	boolean	Yes
type	ExecutionContentType	No
workflow_run_id	string	Yes

HumanInputFormDefinition

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

HumanInputFormDefinitionResponse

Name	Type	Required
expiration_time	integer	No
form_content	string	Yes
inputs	[ object ]	No
resolved_default_values	object	Yes
user_actions	[ object ]	No

HumanInputFormSubmissionData

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

HumanInputFormSubmitPayloadWithUser

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
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	Yes

HumanInputFormSubmitResponse

Name	Type	Description	Required

I18nObject

Model class for i18n object.

Name	Type	Description	Required
en_US	string		Yes
zh_Hans	string		No

IndexInfoResponse

Name	Type	Required
api_version	string	Yes
server_version	string	Yes
welcome	string	Yes

JSONObject

Name	Type	Description	Required
JSONObject	object

JSONValue

Name	Type	Description	Required
JSONValue	string integer number boolean object [ object ]

JSONValueType

Name	Type	Description	Required
JSONValueType

JsonValue

Name	Type	Description	Required
JsonValue

KnowledgeTagListResponse

Name	Type	Description	Required
KnowledgeTagListResponse	array

KnowledgeTagResponse

Name	Type	Required
binding_count	string	No
id	string	Yes
name	string	Yes
type	string	Yes

MessageFeedbackPayload

Name	Type	Description	Required
content	string	Optional text feedback providing additional detail.	No
rating	string	Feedback rating. Set to `null` to revoke previously submitted feedback.	No

MessageFeedbackPayloadWithUser

Name	Type	Description	Required
content	string	Optional text feedback providing additional detail.	No
rating	string	Feedback rating. Set to `null` to revoke previously submitted feedback.	No
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	Yes

MessageFile

Name	Type	Required
belongs_to	string	No
filename	string	Yes
id	string	Yes
mime_type	string	No
size	integer	No
transfer_method	string	Yes
type	string	Yes
upload_file_id	string	No
url	string	No

MessageInfiniteScrollPagination

Name	Type	Required
data	[ MessageListItem ]	Yes
has_more	boolean	Yes
limit	integer	Yes

MessageListItem

Name	Type	Required
agent_thoughts	[ AgentThought ]	Yes
answer	string	Yes
conversation_id	string	Yes
created_at	integer	No
error	string	No
extra_contents	[ HumanInputContent ]	Yes
feedback	SimpleFeedback	No
id	string	Yes
inputs	object	Yes
message_files	[ MessageFile ]	Yes
parent_message_id	string	No
query	string	Yes
retriever_resources	[ RetrieverResource ]	Yes
status	string	Yes

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

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

ModelFeature

Enum class for llm feature.

Name	Type	Description	Required
ModelFeature	string	Enum class for llm feature.

ModelPropertyKey

Enum class for model property key.

Name	Type	Description	Required
ModelPropertyKey	string	Enum class for model property key.

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.

OptionalServiceApiUserPayload

Name	Type	Description	Required
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	No

ParagraphInputConfig

Form input definition.

Name	Type	Required
default	StringSource	No
output_variable_name	string	Yes
type	string	No

Parameters

Name	Type	Required
annotation_reply	JSONObject	Yes
file_upload	JSONObject	Yes
more_like_this	JSONObject	Yes
opening_statement		No
retriever_resource	JSONObject	Yes
sensitive_word_avoidance	JSONObject	Yes
speech_to_text	JSONObject	Yes
suggested_questions	[ string ]	Yes
suggested_questions_after_answer	JSONObject	Yes
system_parameters	SystemParameters	Yes
text_to_speech	JSONObject	Yes
user_input_form	[ JSONObject ]	Yes

PermissionEnum

Shared permission levels for resources (datasets, credentials, etc.)

Name	Type	Description	Required
PermissionEnum	string	Shared permission levels for resources (datasets, credentials, etc.)

PipelineRunApiEntity

Name	Type	Description	Required
datasource_info_list	[ ]	List of datasource objects to process. The expected item structure depends on `datasource_type`.	Yes
datasource_type	string, Available values: "local_file", "online_document", "online_drive", "website_crawl"	Type of the datasource. Determines which fields are expected in `datasource_info_list` items. Enum: `"local_file"`, `"online_document"`, `"online_drive"`, `"website_crawl"`	Yes
inputs	object	Key-value pairs for pipeline input variables defined in the workflow. Pass `{}` if the pipeline has no input variables.	Yes
is_published	boolean	Whether to run the published or draft version of the pipeline. `true` runs the latest published version; `false` runs the current draft (useful for testing unpublished changes).	Yes
response_mode	string, Available values: "blocking", "streaming"	Response mode. Use `streaming` for SSE or `blocking` for JSON. Enum: `"blocking"`, `"streaming"`	Yes
start_node_id	string	ID of the datasource node where the run starts.	Yes

PipelineUploadFileResponse

Name	Type	Required
created_at	string	No
created_by	string	Yes
extension	string	Yes
id	string	Yes
mime_type	string	No
name	string	Yes
size	integer	Yes

PreProcessingRule

Name	Type	Description	Required
enabled	boolean	Whether this preprocessing rule is enabled.	Yes
id	string, Available values: "remove_extra_spaces", "remove_stopwords", "remove_urls_emails"	Rule identifier. Enum: `"remove_extra_spaces"`, `"remove_stopwords"`, `"remove_urls_emails"`	Yes

ProcessRule

Name	Type	Description	Required
mode	ProcessRuleMode	Processing mode. `automatic` uses built-in rules, `custom` allows manual configuration, and `hierarchical` enables parent-child chunk structure for `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

ProviderModelWithStatusEntity

Model class for model response.

Name	Type	Required
deprecated	boolean	No
features	[ ModelFeature ]	No
fetch_from	FetchFrom	Yes
has_invalid_load_balancing_configs	boolean	No
label	I18nObject	Yes
load_balancing_enabled	boolean	No
model	string	Yes
model_properties	object	Yes
model_type	ModelType	Yes
status	ModelStatus	Yes

ProviderWithModelsListResponse

Name	Type	Description	Required
data	[ ProviderWithModelsResponse ]		Yes

ProviderWithModelsResponse

Model class for provider with models response.

Name	Type	Required
icon_small	I18nObject	No
icon_small_dark	I18nObject	No
label	I18nObject	Yes
models	[ ProviderModelWithStatusEntity ]	Yes
provider	string	Yes
status	CustomConfigurationStatus	Yes
tenant_id	string	Yes

RequiredServiceApiUserPayload

Name	Type	Description	Required
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	Yes

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

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

RetrieverResource

Name	Type	Required
content	string	No
created_at	integer	No
data_source_type	string	No
dataset_id	string	No
dataset_name	string	No
document_id	string	No
document_name	string	No
hit_count	integer	No
id	string	No
index_node_hash	string	No
message_id	string	No
position	integer	Yes
score	number	No
segment_id	string	No
segment_position	integer	No
summary	string	No
word_count	integer	No

Rule

Name	Type	Description	Required
parent_mode	string	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

SegmentAttachmentResponse

Name	Type	Required
extension	string	Yes
id	string	Yes
mime_type	string	Yes
name	string	Yes
size	integer	Yes
source_url	string	Yes

SegmentCreateItemPayload

Name	Type	Description	Required
answer	string	Answer content for QA mode.	No
attachment_ids	[ string ]	Attachment file IDs.	No
content	string	Chunk text content.	Yes
keywords	[ string ]	Keywords for the chunk.	No

SegmentCreateListResponse

Name	Type	Description	Required
data	[ SegmentResponse ]		Yes
doc_form	string		Yes

SegmentCreatePayload

Name	Type	Description	Required
segments	[ SegmentCreateItemPayload ]	Array of chunk objects to create.	Yes

SegmentDetailResponse

Name	Type	Description	Required
data	SegmentResponse		Yes
doc_form	string		Yes

SegmentListQuery

Name	Type	Description	Required
keyword	string	Search keyword.	No
limit	integer, Default: 20	Number of items per page. Server caps at `100`.	No
page	integer, Default: 1	Page number to retrieve.	No
status	[ string ]	Filter chunks by indexing status, such as `completed`, `indexing`, or `error`.	No

SegmentListResponse

Name	Type	Required
data	[ SegmentResponse ]	Yes
doc_form	string	Yes
has_more	boolean	Yes
limit	integer	Yes
page	integer	Yes
total	integer	Yes

SegmentResponse

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

SegmentUpdateArgs

Name	Type	Description	Required
answer	string	Updated answer content for QA mode.	No
attachment_ids	[ string ]	Attachment file IDs.	No
content	string	Updated chunk text content.	No
enabled	boolean	Whether the chunk is enabled.	No
keywords	[ string ]	Updated keywords for the chunk.	No
regenerate_child_chunks	boolean	Whether to regenerate child chunks after updating a parent chunk.	No
summary	string	Summary content for summary index.	No

SegmentUpdatePayload

Name	Type	Description	Required
segment	SegmentUpdateArgs	Chunk update payload.	Yes

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	Required
option_source	StringListSource	Yes
output_variable_name	string	Yes
type	string	No

SimpleAccount

Name	Type	Required
email	string	Yes
id	string	Yes
name	string	Yes

SimpleConversation

Name	Type	Required
created_at	integer	No
id	string	Yes
inputs	object	Yes
introduction	string	No
name	string	Yes
status	string	Yes
updated_at	integer	No

SimpleEndUser

Name	Type	Required
id	string	Yes
is_anonymous	boolean	Yes
session_id	string	No
type	string	Yes

SimpleFeedback

Name	Type	Description	Required
rating	string		No

SimpleResultResponse

Name	Type	Description	Required
result	string		Yes

SimpleResultStringListResponse

Name	Type	Description	Required
data	[ string ]		Yes
result	string		Yes

Site

Name	Type	Required
chat_color_theme	string	No
chat_color_theme_inverted	boolean	Yes
copyright	string	No
custom_disclaimer	string	No
default_language	string	Yes
description	string	No
icon	string	No
icon_background	string	No
icon_type	string	No
icon_url	string	Yes
privacy_policy	string	No
show_workflow_steps	boolean	Yes
title	string	Yes
use_icon_as_answer_icon	boolean	Yes

StringListSource

Name	Type	Required
selector	[ string ]	No
type	ValueSourceType	Yes
value	[ string ]	No

StringSource

Default configuration for form inputs.

Name	Type	Required
selector	[ string ]	No
type	ValueSourceType	Yes
value	string	No

SystemParameters

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

TagBindingPayload

Name	Type	Description	Required
tag_ids	[ string ]	Tag IDs to bind.	Yes
target_id	string	Knowledge base ID to bind the tags to.	Yes

TagCreatePayload

Name	Type	Description	Required
name	string	Tag name.	Yes

TagDeletePayload

Name	Type	Description	Required
tag_id	string	Tag ID to delete.	Yes

TagUnbindingPayload

Accepts either the legacy tag_id payload or the normalized tag_ids payload.

Name	Type	Description	Required
TagUnbindingPayload	object object	Accepts either the legacy tag_id payload or the normalized tag_ids payload.

TagUpdatePayload

Name	Type	Description	Required
name	string	Tag name.	Yes
tag_id	string	Tag ID to update.	Yes

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

TextToAudioPayloadWithUser

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
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	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

UrlResponse

Name	Type	Description	Required
url	string		Yes

UserActionConfig

User action configuration.

Name	Type	Required
button_style	ButtonStyle	No
id	string	Yes
title	string	Yes

ValueSourceType

ValueSourceType records whether the value comes from a static setting in form definiton, or a variable while the workflow is running.

Name	Type	Description	Required
ValueSourceType	string	ValueSourceType records whether the value comes from a static setting in form definiton, or a variable while the workflow is running.

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

WorkflowAppLogPaginationResponse

Name	Type	Required
data	[ WorkflowAppLogPartialResponse ]	Yes
has_more	boolean	Yes
limit	integer	Yes
page	integer	Yes
total	integer	Yes

WorkflowAppLogPartialResponse

Name	Type	Required
created_at	integer	No
created_by_account	SimpleAccount	No
created_by_end_user	SimpleEndUser	No
created_by_role	string	No
created_from	string	No
details	object [ object ] string integer number boolean	No
id	string	Yes
workflow_run	WorkflowRunForLogResponse	No

WorkflowEventsQuery

Name	Type	Description	Required
continue_on_pause	boolean	Set to `true` to keep the stream open across multiple `workflow_paused` events, which is useful when the workflow has more than one Human Input node in sequence. By default, the stream closes after the first pause.	No
include_state_snapshot	boolean	When `true`, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.	No
user	string	End-user identifier that originally triggered the run. Must match the creator of the run.	Yes

WorkflowLogQuery

Name	Type	Description	Required
created_at__after	string	Filter logs created after this ISO 8601 timestamp.	No
created_at__before	string	Filter logs created before this ISO 8601 timestamp.	No
created_by_account	string	Filter by account ID.	No
created_by_end_user_session_id	string	Filter by end user session ID.	No
keyword	string	Keyword to search in logs.	No
limit	integer, Default: 20	Number of items per page.	No
page	integer, Default: 1	Page number for pagination.	No
status	string	Filter by execution status.	No

WorkflowRunForLogResponse

Name	Type	Required
created_at	integer	No
elapsed_time	number integer	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

WorkflowRunPayload

Name	Type	Description	Required
files	[ 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
response_mode	string	Response mode. Use `blocking` for synchronous responses or `streaming` for Server-Sent Events. When omitted, the request runs in blocking mode.	No

WorkflowRunPayloadWithUser

Name	Type	Description	Required
files	[ 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
response_mode	string	Response mode. Use `blocking` for synchronous responses or `streaming` for Server-Sent Events. When omitted, the request runs in blocking mode.	No
user	string	User identifier, unique within the application. This identifier scopes data access; resources created with one `user` value are only visible when queried with the same `user` value.	Yes

WorkflowRunResponse

Name	Type	Required
created_at	integer	No
elapsed_time	number integer	No
error	string	No
finished_at	integer	No
id	string	Yes
inputs	object [ object ] string integer number boolean	No
outputs	object	No
status	string	Yes
total_steps	integer	No
total_tokens	integer	No
workflow_id	string	Yes

173 KiB Raw Blame History

Service API

Version: 1.0

Available authorizations

Bearer (HTTP, bearer)

service_api

[GET] /

Responses

[POST] /datasets/{dataset_id}/document/create_by_text

Parameters

Request Body

Responses

[DELETE] /datasets/{dataset_id}/documents/{document_id}

Parameters

Responses

[GET] /datasets/{dataset_id}/documents/{document_id}

Parameters

Responses

[PATCH] /datasets/{dataset_id}/documents/{document_id}

Parameters

Request Body

Responses

[POST] /datasets/{dataset_id}/documents/{document_id}/update_by_text

Parameters

Request Body

Responses

default

[GET] /app/feedbacks

Parameters

Responses

[POST] /messages/{message_id}/feedbacks

Parameters

Request Body

Responses

default

[POST] /apps/annotation-reply/{action}

Parameters

Request Body

Responses

[GET] /apps/annotation-reply/{action}/status/{job_id}

Parameters

Responses

[GET] /apps/annotations

Parameters

Responses

[POST] /apps/annotations

Request Body

Responses

[DELETE] /apps/annotations/{annotation_id}

Parameters

Responses

[PUT] /apps/annotations/{annotation_id}

Parameters

Request Body

Responses

default

[POST] /audio-to-text

Request Body

Responses

[POST] /text-to-audio

Request Body

Responses

default

[POST] /chat-messages

Request Body

Responses

[POST] /chat-messages/{task_id}/stop

Parameters

Request Body

Responses

[GET] /messages/{message_id}/suggested

Parameters

Responses

[GET] /workflow/{task_id}/events

Parameters

Responses

[GET] /workflows/logs

Parameters

Responses

[GET] /workflows/run/{workflow_run_id}

173 KiB

Raw Blame History