# 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] /
**Return public Service API metadata without requiring an API key**
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: [IndexInfoResponse](#indexinforesponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /datasets/{dataset_id}/document/create_by_text~~
***DEPRECATED***
**Create document by text through the deprecated underscore alias**
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](#documenttextcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document created successfully | **application/json**: [DocumentAndBatchResponse](#documentandbatchresponse)
|
| 400 | Bad request - invalid parameters | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /datasets/{dataset_id}/documents/{document_id}/update_by_text~~
***DEPRECATED***
**Update document by text through the deprecated underscore alias**
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](#documenttextupdate)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document updated successfully | **application/json**: [DocumentAndBatchResponse](#documentandbatchresponse)
|
| 400 | Bad Request | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/query-stream
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSAdmittedQueryRequest](#knowledgefsadmittedqueryrequest)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base query event stream | **text/event-stream**: string
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/background-tasks
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| task_ids | query | Comma-separated document or document_bulk task IDs for an exact lookup | No | string |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | listBackgroundTasks | **application/json**: [KnowledgeFSBackgroundTaskListResponse](#knowledgefsbackgroundtasklistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/bulk-jobs/{job_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| job_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base bulk job | **application/json**: [KnowledgeFSBulkJobResponse](#knowledgefsbulkjobresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/deletion-batches/{batch_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| batch_id | path | | Yes | string |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Deletion batch status | **application/json**: [KnowledgeFSBulkDeletionAcceptedResponse](#knowledgefsbulkdeletionacceptedresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/deletion-jobs/{job_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| job_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | getDeletionJob | **application/json**: [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/deletion-jobs/{job_id}/retry
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| job_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | retryDeletionJob | **application/json**: [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/document-references/resolve
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| document_asset_id | query | | Yes | string |
| document_asset_version | query | | Yes | integer |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | resolveDocumentReference | **application/json**: [KnowledgeFSResolvedDocumentReferenceResponse](#knowledgefsresolveddocumentreferenceresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base documents | **application/json**: [KnowledgeFSDocumentListResponse](#knowledgefsdocumentlistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/documents/bulk
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSBulkDocumentDeletePayload](#knowledgefsbulkdocumentdeletepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base document deletions accepted | **application/json**: [KnowledgeFSBulkDeletionAcceptedResponse](#knowledgefsbulkdeletionacceptedresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/documents/reindex
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | No | string |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSDocumentReindexPayload](#knowledgefsdocumentreindexpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base document reindex queued | **application/json**: [KnowledgeFSDocumentReindexResponse](#knowledgefsdocumentreindexresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSDocumentDeletePayload](#knowledgefsdocumentdeletepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base document deletion accepted | **application/json**: [KnowledgeFSDurableDeletionAcceptedResponse](#knowledgefsdurabledeletionacceptedresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base document | **application/json**: [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSDocumentMetadataPayload](#knowledgefsdocumentmetadatapayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base document metadata updated | **application/json**: [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/outline
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base document outline | **application/json**: [KnowledgeFSDocumentOutlineResponse](#knowledgefsdocumentoutlineresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base document revisions | **application/json**: [KnowledgeFSDocumentRevisionListResponse](#knowledgefsdocumentrevisionlistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions/{revision}/chunks
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| query | query | | No | string |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
| revision | path | | Yes | integer |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base document chunks | **application/json**: [KnowledgeFSDocumentChunkListResponse](#knowledgefsdocumentchunklistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| chunk_id | path | | Yes | string |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
| revision | path | | Yes | integer |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base document chunk | **application/json**: [KnowledgeFSDocumentChunkResponse](#knowledgefsdocumentchunkresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/jobs/{job_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| job_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base compilation job canceled | **application/json**: [KnowledgeFSDocumentCompilationJobResponse](#knowledgefsdocumentcompilationjobresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/jobs/{job_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| job_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base compilation job | **application/json**: [KnowledgeFSDocumentCompilationJobResponse](#knowledgefsdocumentcompilationjobresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/jobs/{job_id}/retry
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| job_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base compilation job retried | **application/json**: [KnowledgeFSDocumentCompilationJobResponse](#knowledgefsdocumentcompilationjobresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | listLogicalDocuments | **application/json**: [KnowledgeFSLogicalDocumentListResponse](#knowledgefslogicaldocumentlistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}
Delete a logical document and its historical revisions. Use the logical document ID and its rowVersion as expectedRevision; the accepted deletion job runs asynchronously.
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSLogicalDocumentDeletePayload](#knowledgefslogicaldocumentdeletepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base logical document deletion accepted | **application/json**: [KnowledgeFSDurableDeletionAcceptedResponse](#knowledgefsdurabledeletionacceptedresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | getLogicalDocument | **application/json**: [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}/processing-tasks
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document processing history | **application/json**: [KnowledgeFSDocumentProcessingTaskListResponse](#knowledgefsdocumentprocessingtasklistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}/processing-tasks/{task_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| document_id | path | | Yes | string |
| task_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document processing task | **application/json**: [KnowledgeFSDocumentProcessingTaskResponse](#knowledgefsdocumentprocessingtaskresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/queries/admission
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSQueryCreatePayload](#knowledgefsquerycreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base streaming query admitted through Dify API | **application/json**: [KnowledgeFSQueryAdmissionResponse](#knowledgefsqueryadmissionresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)
[ErrorResponse](#errorresponse)
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/query-images
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **multipart/form-data**: { **"file"**: binary }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Query image uploaded | **application/json**: [KnowledgeFSServiceQueryImageUploadResponse](#knowledgefsservicequeryimageuploadresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)
[ErrorResponse](#errorresponse)
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/research-tasks
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base research tasks | **application/json**: [KnowledgeFSResearchTaskListResponse](#knowledgefsresearchtasklistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/research-tasks
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | No | string |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSResearchTaskCreatePayload](#knowledgefsresearchtaskcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base research task accepted | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)
[ErrorResponse](#errorresponse)
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/research-tasks/plan
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSResearchTaskPlanPayload](#knowledgefsresearchtaskplanpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base research task plan | **application/json**: [KnowledgeFSResearchTaskPlanResponse](#knowledgefsresearchtaskplanresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)
[ErrorResponse](#errorresponse)
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| task_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base research task canceled | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| task_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base research task | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}/partials
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 25 |
| control_space_id | path | | Yes | string |
| task_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base research task partial evidence | **application/json**: [KnowledgeFSResearchTaskPartialListResponse](#knowledgefsresearchtaskpartiallistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}/resume
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| task_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | resumeResearchTask | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/settings
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base settings | **application/json**: [KnowledgeFSSettingsResponse](#knowledgefssettingsresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/settings
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSettingsPayload](#knowledgefssettingspayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base settings updated | **application/json**: [KnowledgeFSSettingsUpdateResponse](#knowledgefssettingsupdateresponse)
|
| 202 | Agent Knowledge Base settings migration accepted | **application/json**: [KnowledgeFSSettingsUpdateResponse](#knowledgefssettingsupdateresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/settings/migrations/{migration_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| migration_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | getProfileMigration | **application/json**: [KnowledgeFSProfileMigrationResponse](#knowledgefsprofilemigrationresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-connections
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | listSourceConnections | **application/json**: [KnowledgeFSSourceConnectionListResponse](#knowledgefssourceconnectionlistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-connections
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSServiceSourceConnectionCreatePayload](#knowledgefsservicesourceconnectioncreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | createSourceConnection | **application/json**: [KnowledgeFSSourceConnectionResponse](#knowledgefssourceconnectionresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-connections/{connection_id}/refresh
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| connection_id | path | | Yes | string |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceConnectionRefreshPayload](#knowledgefssourceconnectionrefreshpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | refreshSourceConnection | **application/json**: [KnowledgeFSSourceConnectionResponse](#knowledgefssourceconnectionresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-providers
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Source providers | **application/json**: [KnowledgeFSSourceProviderListResponse](#knowledgefssourceproviderlistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-workflows
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| sourceId | query | | No | string |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | listSourceWorkflows | **application/json**: [KnowledgeFSSourceWorkflowListResponse](#knowledgefssourceworkflowlistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| run_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | getSourceWorkflow | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/cancel
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| run_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceWorkflowCancelPayload](#knowledgefssourceworkflowcancelpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | cancelSourceWorkflow | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/pages
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
| run_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | listCrawlPreviewPages | **application/json**: [KnowledgeFSCrawlPreviewPageListResponse](#knowledgefscrawlpreviewpagelistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/retry
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| run_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | retrySourceWorkflow | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/selection
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| run_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSCrawlPreviewSelectionPayload](#knowledgefscrawlpreviewselectionpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | selectCrawlPreviewPages | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base sources | **application/json**: [KnowledgeFSSourceListResponse](#knowledgefssourcelistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSServiceSourceCreatePayload](#knowledgefsservicesourcecreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Agent Knowledge Base source created | **application/json**: [KnowledgeFSSourceResponse](#knowledgefssourceresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 429 | Too Many Requests | **application/json**: [KnowledgeFsRateLimitExceededError](#knowledgefsratelimitexceedederror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| documents | query | | No | string,
**Available values:** "cascade", "keep",
**Default:** cascade |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceDeletePayload](#knowledgefssourcedeletepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base source deletion accepted | **application/json**: [KnowledgeFSDurableDeletionAcceptedResponse](#knowledgefsdurabledeletionacceptedresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base source | **application/json**: [KnowledgeFSSourceResponse](#knowledgefssourceresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSServiceSourceUpdatePayload](#knowledgefsservicesourceupdatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base source updated | **application/json**: [KnowledgeFSSourceResponse](#knowledgefssourceresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl~~
***DEPRECATED***
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base source crawl | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl-import
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSCrawlImportPayload](#knowledgefscrawlimportpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | importSelectedSourceCrawl | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl-preview
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | previewSourceCrawl | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/files
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| bucket | query | | No | string |
| continuationToken | query | | No | string |
| maxKeys | query | | No | integer |
| prefix | query | | No | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base source files | **application/json**: [KnowledgeFSSourceFilesResponse](#knowledgefssourcefilesresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/import~~
***DEPRECATED***
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceImportPagesPayload](#knowledgefssourceimportpagespayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base source pages imported | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/import-files~~
***DEPRECATED***
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceImportFilesPayload](#knowledgefssourceimportfilespayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Agent Knowledge Base source files imported | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/pages
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| parentId | query | | No | string |
| view | query | | No | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base source pages | **application/json**: [KnowledgeFSSourcePagesResponse](#knowledgefssourcepagesresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | syncSource | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync-policy
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | getSourceSyncPolicy | **application/json**: [KnowledgeFSSourceSyncPolicyResponse](#knowledgefssourcesyncpolicyresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PUT] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync-policy
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceSyncPolicyPayload](#knowledgefssourcesyncpolicypayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | updateSourceSyncPolicy | **application/json**: [KnowledgeFSSourceSyncPolicyResponse](#knowledgefssourcesyncpolicyresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/test
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base source credential test | **application/json**: [KnowledgeFSSourceCredentialTestResponse](#knowledgefssourcecredentialtestresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/workflow-imports
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| Idempotency-Key | header | | Yes | string |
| control_space_id | path | | Yes | string |
| source_id | path | | Yes | string |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [KnowledgeFSSourceWorkflowImportPayload](#knowledgefssourceworkflowimportpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | importSourceWorkflow | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 50 |
| source | query | | No | string,
**Available values:** "agent", "mcp", "retrieval_test", "service_api", "workflow" |
| control_space_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base traces | **application/json**: [KnowledgeFSTraceListResponse](#knowledgefstracelistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| control_space_id | path | | Yes | string |
| trace_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base answer trace | **application/json**: [KnowledgeFSAnswerTraceResponse](#knowledgefsanswertraceresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/conflicts
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 100 |
| control_space_id | path | | Yes | string |
| trace_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base trace conflicts | **application/json**: [KnowledgeFSTraceEntryListResponse](#knowledgefstraceentrylistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/evidence
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 100 |
| control_space_id | path | | Yes | string |
| trace_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base trace evidence view | **application/json**: [KnowledgeFSTraceEntryListResponse](#knowledgefstraceentrylistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/missing
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| cursor | query | | No | string |
| limit | query | | No | integer,
**Default:** 100 |
| control_space_id | path | | Yes | string |
| trace_id | path | | Yes | string |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Agent Knowledge Base trace missing evidence | **application/json**: [KnowledgeFSTraceEntryListResponse](#knowledgefstraceentrylistresponse)
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized | **application/json**: [KnowledgeFsInvalidCredentialError](#knowledgefsinvalidcredentialerror)
[ErrorResponse](#errorresponse)
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)
[ErrorResponse](#errorresponse)
|
| 502 | Bad Gateway | **application/json**: [KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)
[ErrorResponse](#errorresponse)
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#appfeedbacklistresponse)
|
| 400 | `app_unavailable`: App is no longer available. | **application/json**: [AppUnavailableError](#appunavailableerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#messagefeedbackpayloadwithuser)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Feedback submitted successfully | **application/json**: [ResultResponse](#resultresponse)
|
| 400 | `message_feedback_rating_required`: Cannot revoke feedback that does not exist. `app_unavailable`: App is no longer available. | **application/json**: [AppUnavailableError](#appunavailableerror)
[MessageFeedbackRatingRequiredError](#messagefeedbackratingrequirederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Message does not exist. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](/api-reference/annotations/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](#annotationreplyactionpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Annotation reply settings task initiated. | **application/json**: [AnnotationJobStatusResponse](#annotationjobstatusresponse)
|
| 400 | `invalid_param` : Invalid action or app selection. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | `unauthorized` : Invalid API credential or workspace owner unavailable. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : App no longer exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| 422 | `unprocessable_entity` : Invalid annotation reply payload. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](/api-reference/annotations/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](/api-reference/annotations/configure-annotation-reply). | Yes | string (uuid) |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Successfully retrieved task status. | **application/json**: [AnnotationJobStatusDetailResponse](#annotationjobstatusdetailresponse)
|
| 400 | `invalid_param` : Invalid action or app selection. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | `unauthorized` : Invalid API credential or workspace owner unavailable. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : The specified job does not belong to this app or no longer exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#annotationlist)
|
| 400 | `invalid_param` : Invalid app selection. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | `unauthorized` : Invalid API credential or workspace owner unavailable. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : App no longer exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| 422 | `unprocessable_entity` : Invalid pagination query. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#annotationcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Annotation created successfully. | **application/json**: [Annotation](#annotation)
|
| 400 | `invalid_param` : Invalid app selection. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | `unauthorized` : Invalid API credential or workspace owner unavailable. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : App no longer exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| 422 | `unprocessable_entity` : Invalid annotation payload. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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 | Schema |
| ---- | ----------- | ------ |
| 204 | Annotation deleted successfully. | |
| 400 | `invalid_param` : Invalid app selection. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | `unauthorized` : Invalid API credential or workspace owner unavailable. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : API credential scope, app, or workspace access denied. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : App or annotation no longer exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#annotationcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Annotation updated successfully. | **application/json**: [Annotation](#annotation)
|
| 400 | `invalid_param` : Invalid app selection. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | `unauthorized` : Invalid API credential or workspace owner unavailable. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : API credential scope, app, or workspace access denied. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : App or annotation no longer exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| 422 | `unprocessable_entity` : Invalid annotation payload. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## default
### [POST] /audio-to-text
**Convert Audio to Text**
Convert audio file to text. Supported MIME types: `audio/mp3`, `audio/mpga`, `audio/m4a`, `audio/x-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](#audiotranscriptresponse)
|
| 400 | - `app_unavailable` : App unavailable or misconfigured. - `speech_to_text_disabled` : Speech-to-text is disabled for this app. - `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. | **application/json**: [AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NoAudioUploadedError](#noaudiouploadederror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderNotSupportSpeechToTextError](#providernotsupportspeechtotexterror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[SpeechToTextDisabledError](#speechtotextdisablederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `audio_too_large` : Audio file size exceeded the limit. | **application/json**: [AudioTooLargeError](#audiotoolargeerror)
[ErrorResponse](#errorresponse)
|
| 415 | `unsupported_audio_type` : Audio type is not allowed. | **application/json**: [UnsupportedAudioTypeError](#unsupportedaudiotypeerror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /text-to-audio
**Convert Text to Audio**
Convert text to speech.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [TextToAudioPayloadWithUser](#texttoaudiopayloadwithuser)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Returns the generated audio. The `Content-Type` header reflects the provider audio container, verified from the response bytes when recognizable. The binary response can be AAC, FLAC, MP4, MP3, Ogg, WAV, or WebM. | **audio/aac**: binary
**audio/flac**: binary
**audio/mp4**: binary
**audio/mpeg**: binary
**audio/ogg**: binary
**audio/wav**: binary
**audio/webm**: binary
|
| 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. | **application/json**: [AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## default
### [POST] /chat-messages
**Send Chat Message**
Send a request to the chat application.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [ChatRequestPayloadWithUser](#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**: [ChatBlockingResponse](#chatblockingresponse)
**text/event-stream**: string
|
| 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. | **application/json**: [AgentNotPublishedError](#agentnotpublishederror)
[AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NotChatAppError](#notchatapperror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `workflow_version_execution_not_allowed` : Workflow version execution is unavailable on the current plan. Upgrade to a paid plan. | **application/json**: [WorkflowVersionExecutionNotAllowedError](#workflowversionexecutionnotallowederror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Conversation does not exist. | **application/json**: [ErrorResponse](#errorresponse)
|
| 429 | - `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The Dify Cloud workflow execution quota for this workspace has been reached. | **application/json**: [RateLimitError](#ratelimiterror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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**: [ScopedTaskStopPayload](#scopedtaskstoppayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)
|
| 400 | `not_chat_app` : App mode does not match the API route. | **application/json**: [NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /messages/{message_id}/suggested
**Get Next Suggested Questions**
Get next question suggestions for the current message. If no usable model can be resolved or the model call to generate questions fails, the response is HTTP 200 with an empty data list. Model invocation failures during history token counting instead return HTTP 400 with `completion_request_error`.
#### 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](#simpleresultstringlistresponse)
|
| 400 | - `not_chat_app` : App mode does not match the API route. - `app_unavailable` : App is no longer available. - `completion_request_error` : Model invocation failed while counting history tokens. | **application/json**: [AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NotChatAppError](#notchatapperror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | - `forbidden` : Token scope does not allow access. - `app_not_found` : The token's app no longer exists. - `app_abnormal_status` : App status does not allow API access. - `app_api_disabled` : The app's API service has been disabled. - `workspace_not_found` : The app's workspace no longer exists. - `workspace_archived` : The app's workspace is archived. - `app_suggested_questions_after_answer_disabled` : Suggested questions feature is disabled. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[AppSuggestedQuestionsAfterAnswerDisabledError](#appsuggestedquestionsafteranswerdisablederror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | - `not_found` : End user, message, or conversation does not exist. - `agent_version_not_found_error` : Agent config version does not exist. | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /workflow/{workflow_run_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 |
| ---- | ---------- | ----------- | -------- | ------ |
| workflow_run_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**: string
|
| 400 | `not_workflow_app` : Please check if your app mode matches the right API route. | **application/json**: [NotWorkflowAppError](#notworkflowapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Workflow run not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#workflowapplogpaginationresponse)
|
| 400 | Bad request - invalid query parameters | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#workflowrunresponse)
|
| 400 | `not_workflow_app` : App mode does not match the API route. | **application/json**: [NotWorkflowAppError](#notworkflowapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Workflow run not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## default
### [POST] /chat-messages
**Send Chat Message**
Send a request to the chat application.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [ChatRequestPayloadWithUser](#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**: [ChatBlockingResponse](#chatblockingresponse)
**text/event-stream**: string
|
| 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. | **application/json**: [AgentNotPublishedError](#agentnotpublishederror)
[AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NotChatAppError](#notchatapperror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `workflow_version_execution_not_allowed` : Workflow version execution is unavailable on the current plan. Upgrade to a paid plan. | **application/json**: [WorkflowVersionExecutionNotAllowedError](#workflowversionexecutionnotallowederror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Conversation does not exist. | **application/json**: [ErrorResponse](#errorresponse)
|
| 429 | - `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The Dify Cloud workflow execution quota for this workspace has been reached. | **application/json**: [RateLimitError](#ratelimiterror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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**: [ScopedTaskStopPayload](#scopedtaskstoppayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)
|
| 400 | `not_chat_app` : App mode does not match the API route. | **application/json**: [NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /messages/{message_id}/suggested
**Get Next Suggested Questions**
Get next question suggestions for the current message. If no usable model can be resolved or the model call to generate questions fails, the response is HTTP 200 with an empty data list. Model invocation failures during history token counting instead return HTTP 400 with `completion_request_error`.
#### 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](#simpleresultstringlistresponse)
|
| 400 | - `not_chat_app` : App mode does not match the API route. - `app_unavailable` : App is no longer available. - `completion_request_error` : Model invocation failed while counting history tokens. | **application/json**: [AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NotChatAppError](#notchatapperror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | - `forbidden` : Token scope does not allow access. - `app_not_found` : The token's app no longer exists. - `app_abnormal_status` : App status does not allow API access. - `app_api_disabled` : The app's API service has been disabled. - `workspace_not_found` : The app's workspace no longer exists. - `workspace_archived` : The app's workspace is archived. - `app_suggested_questions_after_answer_disabled` : Suggested questions feature is disabled. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[AppSuggestedQuestionsAfterAnswerDisabledError](#appsuggestedquestionsafteranswerdisablederror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | - `not_found` : End user, message, or conversation does not exist. - `agent_version_not_found_error` : Agent config version does not exist. | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## default
### [POST] /completion-messages
**Send Completion Message**
Send a request to the text generation application.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [CompletionRequestPayloadWithUser](#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**: [CompletionBlockingResponse](#completionblockingresponse)
**text/event-stream**: string
|
| 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. | **application/json**: [AppUnavailableError](#appunavailableerror)
[CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 429 | `too_many_requests` : Too many concurrent requests for this app. | **application/json**: [ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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**: [ScopedTaskStopPayload](#scopedtaskstoppayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)
|
| 400 | `app_unavailable` : App unavailable or misconfigured. | **application/json**: [AppUnavailableError](#appunavailableerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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 | Conversations retrieved successfully. | **application/json**: [ConversationInfiniteScrollPagination](#conversationinfinitescrollpagination)
|
| 400 | Invalid app selection or app mode does not match the API route. | **application/json**: [NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Invalid API credentials. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | API credential, app or workspace access is unavailable. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `conversation_cursor_not_found`: Cursor is outside the current list. `conversation_not_found`: The app or user is no longer available. | **application/json**: [ConversationCursorNotFoundError](#conversationcursornotfounderror)
[ConversationNotFoundError](#conversationnotfounderror)
[ErrorResponse](#errorresponse)
|
| 422 | Invalid conversation list query. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /conversations/{conversation_id}
**Delete Conversation**
Delete a conversation.
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| conversation_id | path | Conversation ID. | Yes | string (uuid) |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [OptionalServiceApiUserPayload](#optionalserviceapiuserpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 204 | Conversation deleted successfully. | |
| 400 | Invalid app selection or app mode does not match the API route. | **application/json**: [NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Invalid API credentials. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | API credential, app or workspace access is unavailable. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `conversation_not_found`: Conversation does not exist for this user and app. | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /conversations/{conversation_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 |
| ---- | ---------- | ----------- | -------- | ------ |
| conversation_id | path | Conversation ID. | Yes | string (uuid) |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [ConversationRenamePayloadWithUser](#conversationrenamepayloadwithuser)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Conversation renamed successfully; model failure preserves the existing name. | **application/json**: [SimpleConversation](#simpleconversation)
|
| 400 | Invalid app selection or app mode does not match the API route. | **application/json**: [NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Invalid API credentials. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | API credential, app or workspace access is unavailable. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `conversation_not_found`: Conversation does not exist. `conversation_first_message_not_found`: No first message is available for automatic naming. | **application/json**: [ConversationFirstMessageNotFoundError](#conversationfirstmessagenotfounderror)
[ConversationNotFoundError](#conversationnotfounderror)
[ErrorResponse](#errorresponse)
|
| 422 | Invalid conversation rename payload. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /conversations/{conversation_id}/variables
**List Conversation Variables**
Retrieve variables from a specific conversation.
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| conversation_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 | Conversation variables retrieved successfully. | **application/json**: [ConversationVariableInfiniteScrollPaginationResponse](#conversationvariableinfinitescrollpaginationresponse)
|
| 400 | Invalid app selection or app mode does not match the API route. | **application/json**: [NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Invalid API credentials. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | API credential, app or workspace access is unavailable. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `conversation_not_found`: Conversation does not exist for this user and app. `conversation_variable_not_found`: Cursor variable is outside the current list. | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)
[ConversationVariableNotFoundError](#conversationvariablenotfounderror)
[ErrorResponse](#errorresponse)
|
| 422 | Invalid conversation variables query. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PUT] /conversations/{conversation_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 |
| ---- | ---------- | ----------- | -------- | ------ |
| conversation_id | path | Conversation ID. | Yes | string (uuid) |
| variable_id | path | Variable ID. | Yes | string (uuid) |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [ConversationVariableUpdatePayloadWithUser](#conversationvariableupdatepayloadwithuser)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Variable updated successfully. | **application/json**: [ConversationVariableResponse](#conversationvariableresponse)
|
| 400 | Invalid app selection or app mode does not match the API route. `conversation_variable_type_mismatch`: Value does not match the variable's expected type. `invalid_param`: Value violates variable constraints, including the size limit. | **application/json**: [ConversationVariableTypeMismatchError](#conversationvariabletypemismatcherror)
[NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Invalid API credentials. | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | API credential, app or workspace access is unavailable. | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | `conversation_not_found`: Conversation does not exist for this user and app. `conversation_variable_not_found`: Variable does not exist for this conversation. | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)
[ConversationVariableNotFoundError](#conversationvariablenotfounderror)
[ErrorResponse](#errorresponse)
|
| 422 | Invalid conversation variable update payload. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#messageinfinitescrollpagination)
|
| 400 | `not_chat_app` : App mode does not match the API route. `app_unavailable` : App is no longer available. | **application/json**: [AppUnavailableError](#appunavailableerror)
[NotChatAppError](#notchatapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [AppAbnormalStatusError](#appabnormalstatuserror)
[AppApiDisabledError](#appapidisablederror)
[AppNotFoundError](#appnotfounderror)
[ForbiddenError](#forbiddenerror)
[WorkspaceArchivedError](#workspacearchivederror)
[WorkspaceNotFoundError](#workspacenotfounderror)
[ErrorResponse](#errorresponse)
|
| 404 | - `not_found` : Conversation does not exist. - `not_found` : First message does not exist. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#datasetlistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /datasets
**Create an Empty Knowledge Base**
Create a new empty knowledge base. After creation, use [Create Document by Text](/api-reference/documents/create-document-by-text) or [Create Document by File](/api-reference/documents/create-document-by-file) to add documents.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [DatasetCreatePayload](#datasetcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Knowledge base created successfully. | **application/json**: [DatasetDetailResponse](#datasetdetailresponse)
|
| 400 | Bad request - invalid parameters | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 409 | `dataset_name_duplicate` : The dataset name already exists. Please modify your dataset name. | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [DELETE] /datasets/{dataset_id}
**Delete Knowledge Base**
Permanently delete a knowledge base and all its documents.
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Knowledge base ID. | Yes | string (uuid) |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasetdetailwithpartialmembersresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Insufficient permissions to access this knowledge base. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasetupdatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Knowledge base updated successfully. | **application/json**: [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse)
|
| 400 | Bad request - invalid embedding or reranking model configuration | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Insufficient permissions to access this knowledge base. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /datasets/{dataset_id}/hit-testing~~
***DEPRECATED***
**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](#hittestingpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Retrieval results. | **application/json**: [HitTestingResponse](#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. | **application/json**: [CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Insufficient permissions. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : An internal error occurred during retrieval. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#hittestingpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Retrieval results. | **application/json**: [HitTestingResponse](#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. | **application/json**: [CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Insufficient permissions. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : An internal error occurred during retrieval. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#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. | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)
[NoFileUploadedError](#nofileuploadederror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 415 | `unsupported_file_type` : File type not allowed. | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasourcepluginlistresponse)
|
| 400 | Bad request - pipeline is not configured | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasourcenoderunpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Streaming response with node execution events. | **text/event-stream**: string
|
| 400 | Bad request - invalid payload or pipeline is not configured | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /datasets/{dataset_id}/pipeline/run
**Run Pipeline**
Execute the full knowledge pipeline for a knowledge base. Published runs are queued and return batch metadata as JSON. Draft runs support blocking JSON and streaming Server-Sent Events.
#### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| dataset_id | path | Knowledge base ID. | Yes | string (uuid) |
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [PipelineRunApiEntity](#pipelinerunapientity)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Pipeline execution result. Published runs return a JSON object containing `batch`, `dataset`, and `documents`. Draft runs return `text/event-stream` for streaming mode or a workflow result JSON object for blocking mode. | **application/json**: [PipelineRunJsonResponse](#pipelinerunjsonresponse)
**text/event-stream**: string
|
| 400 | Bad request - invalid payload or pipeline is not configured | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Forbidden. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 500 | `pipeline_run_error` : Pipeline execution failed. | **application/json**: [PipelineRunError](#pipelinerunerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#tagdeletepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Tag not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#knowledgetaglistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PATCH] /datasets/tags
**Update Knowledge Tag**
Rename an existing knowledge base tag.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [TagUpdatePayload](#tagupdatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tag updated successfully. | **application/json**: [KnowledgeTagResponse](#knowledgetagresponse)
|
| 400 | Bad request - tag name already exists | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Tag not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /datasets/tags
**Create Knowledge Tag**
Create a new tag for organizing knowledge bases.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [TagCreatePayload](#tagcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Tag created successfully. | **application/json**: [KnowledgeTagResponse](#knowledgetagresponse)
|
| 400 | Bad request - tag name already exists | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#tagbindingpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /datasets/tags/unbinding
**Delete Tag Binding**
Remove one or more tags from a knowledge base.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [TagUnbindingPayload](#tagunbindingpayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasetboundtaglistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](/api-reference/documents/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](#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, unsupported file type, missing required fields, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`). | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)
[NoFileUploadedError](#nofileuploadederror)
[ProviderNotInitializeError](#providernotinitializeerror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](/api-reference/documents/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](#documenttextcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document created successfully. | **application/json**: [DocumentAndBatchResponse](#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`). | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[POST] /datasets/{dataset_id}/document/create_by_file~~
***DEPRECATED***
**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](/api-reference/documents/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](#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, unsupported file type, missing required fields, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`). | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)
[NoFileUploadedError](#nofileuploadederror)
[ProviderNotInitializeError](#providernotinitializeerror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#documentlistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#documentbatchdownloadzippayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ZIP archive containing the requested documents. | **application/zip**: binary
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Insufficient permissions. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Document or dataset not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#documentstatuspayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document status updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)
|
| 400 | `invalid_action` : Invalid action. | **application/json**: [InvalidActionError](#invalidactionerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Insufficient permissions. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#documentstatuslistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. / Documents not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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 | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `archived_document_immutable` : The archived document is not editable. | **application/json**: [ArchivedDocumentImmutableError](#archiveddocumentimmutableerror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Document Not Exists. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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_type` and `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](#documentdetailresponse)
|
| 400 | `invalid_metadata` : Invalid metadata value for the specified key. | **application/json**: [InvalidMetadataError](#invalidmetadataerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : No permission. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Document not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}
**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](/api-reference/documents/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](#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, unsupported file type, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`). | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)
[ProviderNotInitializeError](#providernotinitializeerror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 415 | Unsupported file type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)
[ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#urlresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : No permission to access this document. | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Document not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[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](/api-reference/documents/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](#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, unsupported file type, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`). | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)
[ProviderNotInitializeError](#providernotinitializeerror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 415 | Unsupported file type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)
[ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](/api-reference/documents/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](#documenttextupdate)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document updated successfully. | **application/json**: [DocumentAndBatchResponse](#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`). | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### ~~[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](/api-reference/documents/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](#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, unsupported file type, or invalid doc_form (must be `text_model`, `hierarchical_model`, or `qa_model`). | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)
[ProviderNotInitializeError](#providernotinitializeerror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 415 | Unsupported file type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)
[ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#metadataoperationdata)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Document metadata updated successfully. | **application/json**: [DatasetMetadataActionResponse](#datasetmetadataactionresponse)
|
| 400 | Bad request - invalid or conflicting document metadata operation | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, or metadata not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasetmetadatalistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#metadataargs)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 201 | Metadata field created successfully. | **application/json**: [DatasetMetadataResponse](#datasetmetadataresponse)
|
| 400 | Bad request - invalid or duplicate metadata name | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasetmetadatabuiltinfieldsresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Knowledge base not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#datasetmetadataactionresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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 | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset or metadata not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#metadataupdatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Metadata field updated successfully. | **application/json**: [DatasetMetadataResponse](#datasetmetadataresponse)
|
| 400 | Bad request - invalid or duplicate metadata name | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset or metadata not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#segmentlistresponse)
|
| 400 | Bad request - embedding model is not configured | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset or document not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#segmentcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Chunks created successfully. | **application/json**: [SegmentCreateListResponse](#segmentcreatelistresponse)
|
| 400 | Bad request - segments data is missing | **application/json**: [ErrorMessageResponse](#errormessageresponse)
[ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Document is not completed or is disabled. | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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 | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 400 | Bad request - invalid dataset model state or concurrent deletion | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, or segment not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#segmentdetailresponse)
|
| 400 | Bad request - invalid dataset model configuration | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, or segment not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#segmentupdatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Chunk updated successfully. | **application/json**: [SegmentDetailResponse](#segmentdetailresponse)
|
| 400 | Bad request - invalid segment or embedding model configuration | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, or segment not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#childchunklistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, or segment not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#childchunkcreatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunk created successfully. | **application/json**: [ChildChunkDetailResponse](#childchunkdetailresponse)
|
| 400 | `invalid_param` : Create child chunk index failed. | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, or segment not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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 | Schema |
| ---- | ----------- | ------ |
| 204 | Success. | |
| 400 | `invalid_param` : Delete child chunk index failed. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, segment, or child chunk not found | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#childchunkupdatepayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Child chunk updated successfully. | **application/json**: [ChildChunkDetailResponse](#childchunkdetailresponse)
|
| 400 | `invalid_param` : Update child chunk index failed. | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - dataset API access or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | Dataset, document, segment, or child chunk not found | **application/json**: [ErrorResponse](#errorresponse)
|
| 503 | `service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](/api-reference/files/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](#enduserdetail)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `end_user_not_found` : End user not found. | **application/json**: [EndUserNotFoundError](#endusernotfounderror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#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. - `file_extension_blocked` : The file extension is blocked for security reasons. | **application/json**: [FileExtensionBlockedError](#fileextensionblockederror)
[FilenameNotExistsError](#filenamenotexistserror)
[NoFileUploadedError](#nofileuploadederror)
[TooManyFilesError](#toomanyfileserror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 413 | `file_too_large` : File size exceeded. | **application/json**: [FileTooLargeError](#filetoolargeerror)
[ErrorResponse](#errorresponse)
|
| 415 | `unsupported_file_type` : File type not allowed. | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [GET] /files/{file_id}/preview
**Download File**
Preview or download uploaded files previously uploaded via the [Upload File](/api-reference/files/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-reference/files/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 | Schema |
| ---- | ----------- | ------ |
| 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`. | `*/*`: binary
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `file_access_denied` : Access to the requested file is denied. | **application/json**: [FileAccessDeniedError](#fileaccessdeniederror)
[ErrorResponse](#errorresponse)
|
| 404 | `file_not_found` : The requested file was not found. | **application/json**: [FileNotFoundError](#filenotfounderror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#humaninputformdefinitionresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Form not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 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. | **application/json**: [HumanInputFormExpiredError](#humaninputformexpirederror)
[HumanInputFormSubmittedError](#humaninputformsubmittederror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](/api-reference/chatflows/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](#humaninputformsubmitpayloadwithuser)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Form submitted successfully. The response body is an empty object. | **application/json**: [HumanInputFormSubmitResponse](#humaninputformsubmitresponse)
|
| 400 | - `bad_request` : Form recipient type is invalid. - `invalid_form_data` : Submission failed validation against the form definition. | **application/json**: [InvalidFormDataError](#invalidformdataerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Form not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 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. | **application/json**: [HumanInputFormExpiredError](#humaninputformexpirederror)
[HumanInputFormSubmittedError](#humaninputformsubmittederror)
[ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#appinforesponse)
|
| 400 | `app_unavailable` : App unavailable or misconfigured. | **application/json**: [AppUnavailableError](#appunavailableerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#appmetaresponse)
|
| 400 | `app_unavailable` : App unavailable or misconfigured. | **application/json**: [AppUnavailableError](#appunavailableerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#parameters)
|
| 400 | `app_unavailable` : App unavailable or misconfigured. | **application/json**: [AgentNotPublishedError](#agentnotpublishederror)
[AppUnavailableError](#appunavailableerror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#site)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | `forbidden` : Site not found for this application or the workspace has been archived. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## default
### [GET] /workflow/{workflow_run_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 |
| ---- | ---------- | ----------- | -------- | ------ |
| workflow_run_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**: string
|
| 400 | `not_workflow_app` : Please check if your app mode matches the right API route. | **application/json**: [NotWorkflowAppError](#notworkflowapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Workflow run not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#workflowapplogpaginationresponse)
|
| 400 | Bad request - invalid query parameters | **application/json**: [ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [POST] /workflows/run
**Run Workflow**
Execute a workflow. Cannot be executed without a published workflow.
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: [WorkflowRunPayloadWithUser](#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**: [WorkflowBlockingResponse](#workflowblockingresponse)
**text/event-stream**: string
|
| 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. | **application/json**: [CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NotWorkflowAppError](#notworkflowapperror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | - `forbidden` : Token scope, app, or workspace access denied. - `trigger_workflow_service_mode_unavailable` : Trigger-entry workflows cannot be invoked through Web App, Service API, OpenAPI, or MCP. | **application/json**: [TriggerWorkflowServiceModeUnavailableError](#triggerworkflowservicemodeunavailableerror)
[ErrorResponse](#errorresponse)
|
| 429 | - `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The Dify Cloud workflow execution quota for this workspace has been reached. | **application/json**: [RateLimitError](#ratelimiterror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#workflowrunresponse)
|
| 400 | `not_workflow_app` : App mode does not match the API route. | **application/json**: [NotWorkflowAppError](#notworkflowapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Workflow run not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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**: [WorkflowTaskStopPayload](#workflowtaskstoppayload)
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)
|
| 400 | - `not_workflow_app` : App mode does not match the API route. - `invalid_param` : Required parameter missing or invalid. | **application/json**: [NotWorkflowAppError](#notworkflowapperror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | Forbidden - token scope, app, dataset, or workspace access denied | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
### [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](#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**: [WorkflowBlockingResponse](#workflowblockingresponse)
**text/event-stream**: string
|
| 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. | **application/json**: [CompletionRequestError](#completionrequesterror)
[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)
[NotWorkflowAppError](#notworkflowapperror)
[ProviderNotInitializeError](#providernotinitializeerror)
[ProviderQuotaExceededError](#providerquotaexceedederror)
[ErrorResponse](#errorresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| 403 | - `forbidden` : Token scope, app, or workspace access denied. - `workflow_version_execution_not_allowed` : Workflow version execution is unavailable on the current plan. Upgrade to a paid plan. - `trigger_workflow_service_mode_unavailable` : The selected workflow version uses a trigger entry and cannot be invoked through Web App, Service API, OpenAPI, or MCP. | **application/json**: [TriggerWorkflowServiceModeUnavailableError](#triggerworkflowservicemodeunavailableerror)
[WorkflowVersionExecutionNotAllowedError](#workflowversionexecutionnotallowederror)
[ErrorResponse](#errorresponse)
|
| 404 | `not_found` : Workflow not found. | **application/json**: [ErrorResponse](#errorresponse)
|
| 429 | - `too_many_requests` : Too many concurrent requests for this app. - `rate_limit_error` : The Dify Cloud workflow execution quota for this workspace has been reached. | **application/json**: [RateLimitError](#ratelimiterror)
[ErrorResponse](#errorresponse)
|
| 500 | `internal_server_error` : Internal server error. | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
## 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](#providerwithmodelslistresponse)
|
| 401 | Unauthorized - invalid API token | **application/json**: [ErrorResponse](#errorresponse)
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)
|
---
### Schemas
#### AgentNotPublishedError
Agent has not been published. Please publish the Agent before using the API.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentNotPublishedError | | Agent has not been published. Please publish the Agent before using the API. | |
#### AgentThought
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | No |
| chain_id | string | | No |
| created_at | integer | | No |
| files | [ string ] | | Yes |
| id | string | | Yes |
| message_id | string | | Yes |
| observation | string | | No |
| position | integer | | Yes |
| thought | string | | No |
| tool | string | | No |
| tool_input | string | | No |
| tool_labels | [AnyJSONValue](#anyjsonvalue) | Labels for tools used. | Yes |
#### AgentVersionNotFoundError
Agent config version not found.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgentVersionNotFoundError | | Agent config version not found. | |
#### Annotation
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | No |
| created_at | integer | | No |
| hit_count | integer | | No |
| id | string (uuid) | | Yes |
| question | string | | No |
#### AnnotationCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | Annotation answer. | Yes |
| question | string | Annotation question. | Yes |
#### AnnotationJobStatusDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| error_msg | string | | No |
| job_id | string (uuid) | | Yes |
| job_status | string | | Yes |
#### AnnotationJobStatusResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| job_id | string (uuid) | | Yes |
| job_status | string | | Yes |
#### AnnotationList
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [Annotation](#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 |
#### AnyJSONValue
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AnyJSONValue | | | |
#### AppAbnormalStatusError
The app's status is abnormal.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AppAbnormalStatusError | | The app's status is abnormal. | |
#### AppApiDisabledError
The app's API service has been disabled.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AppApiDisabledError | | The app's API service has been disabled. | |
#### AppFeedbackListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [AppFeedbackResponse](#appfeedbackresponse) ] | | Yes |
#### AppFeedbackResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string (uuid) | | Yes |
| content | string | | No |
| conversation_id | string (uuid) | | Yes |
| created_at | string | | Yes |
| from_account_id | string | | No |
| from_end_user_id | string | | No |
| from_source | string | | Yes |
| id | string (uuid) | | Yes |
| message_id | string (uuid) | | Yes |
| rating | string | | Yes |
| updated_at | string | | Yes |
#### AppInfoResponse
| Name | Type | Description | 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 |
#### AppNotFoundError
The app no longer exists.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AppNotFoundError | | The app no longer exists. | |
#### AppSuggestedQuestionsAfterAnswerDisabledError
The 'Suggested Questions After Answer' feature is disabled.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AppSuggestedQuestionsAfterAnswerDisabledError | | The 'Suggested Questions After Answer' feature is disabled. | |
#### AppUnavailableError
App unavailable, please check your app configurations.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AppUnavailableError | | App unavailable, please check your app configurations. | |
#### ArchivedDocumentImmutableError
The archived document is not editable.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ArchivedDocumentImmutableError | | The archived document is not editable. | |
#### AudioBinaryResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AudioBinaryResponse | string | | |
#### AudioTooLargeError
Audio size exceeded. {message}
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AudioTooLargeError | | Audio size exceeded. {message} | |
#### AudioTranscriptResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| text | string | Transcribed text from audio | Yes |
#### BinaryFileResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BinaryFileResponse | string | | |
#### BlockingMetadataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| retriever_resources | [ [BlockingRetrieverResourceResponse](#blockingretrieverresourceresponse) ] | | No |
| usage | [BlockingUsageResponse](#blockingusageresponse) | | No |
#### BlockingRetrieverResourceResponse
| Name | Type | Description | 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 |
| knowledge_fs_citation | [KnowledgeFsCitation](#knowledgefscitation) | | 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 |
#### BlockingUsageResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| completion_price | string | | No |
| completion_price_unit | string | | No |
| completion_tokens | integer | | No |
| completion_unit_price | string | | No |
| currency | string | | No |
| latency | number | | No |
| prompt_price | string | | No |
| prompt_price_unit | string | | No |
| prompt_tokens | integer | | No |
| prompt_unit_price | string | | No |
| total_price | string | | No |
| total_tokens | integer | | No |
#### ButtonStyle
Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ButtonStyle | string | Button styles for user actions. | |
#### ChatBlockingResponse
Blocking chat response for a completed message or paused Chatflow.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ChatBlockingResponse | [ChatMessageBlockingResponse](#chatmessageblockingresponse)
[ChatPausedBlockingResponse](#chatpausedblockingresponse) | Blocking chat response for a completed message or paused Chatflow. | |
#### ChatMessageBlockingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | Yes |
| conversation_id | string | | Yes |
| created_at | integer | | Yes |
| event | string | | Yes |
| id | string | | Yes |
| message_id | string | | Yes |
| metadata | [BlockingMetadataResponse](#blockingmetadataresponse) | Metadata including usage and retriever resources. | Yes |
| mode | string | | Yes |
| task_id | string | | Yes |
#### ChatPauseReasonResponse
Public pause reason emitted by a blocking Chatflow execution.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TYPE | string | | Yes |
| actions | [ [JSONObject](#jsonobject) ] | | No |
| approval_channels | [ string ] | | No |
| display_in_ui | boolean | | No |
| expiration_time | integer | | No |
| form_content | string | | No |
| form_id | string | | No |
| form_token | string | | No |
| inputs | [ [JSONObject](#jsonobject) ] | | No |
| message | string | | No |
| node_id | string | | No |
| node_title | string | | No |
| resolved_default_values | object | | No |
#### ChatPausedBlockingDataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | Yes |
| conversation_id | string (uuid) | | Yes |
| created_at | long | | Yes |
| elapsed_time | float | | Yes |
| id | string (uuid) | | Yes |
| message_id | string (uuid) | | Yes |
| metadata | [BlockingMetadataResponse](#blockingmetadataresponse) | Metadata including usage and retriever resources. | Yes |
| mode | string | | Yes |
| paused_nodes | [ string ] | | Yes |
| reasons | [ [ChatPauseReasonResponse](#chatpausereasonresponse) ] | | Yes |
| status | string | | Yes |
| total_steps | integer | | Yes |
| total_tokens | integer | | Yes |
| workflow_run_id | string (uuid) | | Yes |
#### ChatPausedBlockingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | Yes |
| conversation_id | string | | Yes |
| created_at | integer | | Yes |
| data | [ChatPausedBlockingDataResponse](#chatpausedblockingdataresponse) | | Yes |
| event | string | | Yes |
| id | string | | Yes |
| message_id | string | | Yes |
| metadata | [BlockingMetadataResponse](#blockingmetadataresponse) | Metadata including usage and retriever resources. | Yes |
| mode | string | | Yes |
| task_id | string | | Yes |
| workflow_run_id | string | | Yes |
#### 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
object
object
object ] | File list for multimodal understanding, including images, documents, audio, and video. To attach a local file, first upload it via [Upload File](/api-reference/files/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](/api-reference/applications/get-app-parameters) response to discover expected variable names and types. | Yes |
| query | string | User input or question content. | Yes |
| response_mode | string,
**Available values:** "blocking", "streaming" | 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
object
object
object ] | File list for multimodal understanding, including images, documents, audio, and video. To attach a local file, first upload it via [Upload File](/api-reference/files/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](/api-reference/applications/get-app-parameters) response to discover expected variable names and types. | Yes |
| query | string | User input or question content. | Yes |
| response_mode | string,
**Available values:** "blocking", "streaming" | 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 | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | 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](#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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ChildChunkResponse](#childchunkresponse) ] | | Yes |
| limit | integer | | Yes |
| page | integer | | Yes |
| total | integer | | Yes |
| total_pages | integer | | Yes |
#### ChildChunkResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
| created_at | integer | | Yes |
| id | string | | Yes |
| position | integer | | Yes |
| segment_id | string | | Yes |
| type | string,
**Available values:** "automatic", "customized" | *Enum:* `"automatic"`, `"customized"` | Yes |
| updated_at | integer | | Yes |
| word_count | integer | | Yes |
#### ChildChunkUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | Child chunk text content. | Yes |
#### CompletionBlockingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | Yes |
| created_at | long | | Yes |
| event | string | | Yes |
| id | string (uuid) | | Yes |
| message_id | string (uuid) | | Yes |
| metadata | [BlockingMetadataResponse](#blockingmetadataresponse) | Metadata including usage and retriever resources. | Yes |
| mode | string | | Yes |
| task_id | string (uuid) | | Yes |
#### CompletionRequestError
Completion request failed.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CompletionRequestError | | Completion request failed. | |
#### CompletionRequestPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ object
object
object
object ] | File list for multimodal understanding, including images, documents, audio, and video. To attach a local file, first upload it via [Upload File](/api-reference/files/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](/api-reference/applications/get-app-parameters) response to discover expected variable names and types. | Yes |
| query | string | User input or prompt content. | No |
| response_mode | string,
**Available values:** "blocking", "streaming" | 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
object
object
object ] | File list for multimodal understanding, including images, documents, audio, and video. To attach a local file, first upload it via [Upload File](/api-reference/files/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](/api-reference/applications/get-app-parameters) response to discover expected variable names and types. | Yes |
| query | string | User input or prompt content. | No |
| response_mode | string,
**Available values:** "blocking", "streaming" | Response mode. `streaming` uses Server-Sent Events; `blocking` returns after completion. When omitted, the request runs in blocking mode. | No |
| user | string | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | 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 |
#### ConversationCursorNotFoundError
The conversation cursor is not in the current list. Refresh the list and try again.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ConversationCursorNotFoundError | | The conversation cursor is not in the current list. Refresh the list and try again. | |
#### ConversationFirstMessageNotFoundError
The conversation has no message from which to generate a name.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ConversationFirstMessageNotFoundError | | The conversation has no message from which to generate a name. | |
#### ConversationInfiniteScrollPagination
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [SimpleConversation](#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 |
#### ConversationNotFoundError
The conversation was not found for this user and app.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ConversationNotFoundError | | The conversation was not found for this user and app. | |
#### 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 | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | No |
#### ConversationVariableInfiniteScrollPaginationResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ConversationVariableResponse](#conversationvariableresponse) ] | | Yes |
| has_more | boolean | | Yes |
| limit | integer | | Yes |
#### ConversationVariableNotFoundError
The conversation variable was not found for this conversation.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ConversationVariableNotFoundError | | The conversation variable was not found for this conversation. | |
#### ConversationVariableResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer | | No |
| description | string | | No |
| id | string (uuid) | | Yes |
| name | string | | Yes |
| updated_at | integer | | No |
| value | string | | No |
| value_type | string | | Yes |
#### ConversationVariableTypeMismatchError
The new value does not match the conversation variable's type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ConversationVariableTypeMismatchError | | The new value does not match the conversation variable's type. | |
#### ConversationVariableUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| value | [JsonValue](#jsonvalue) | The new value for the variable. Must match the variable's expected type. | Yes |
#### ConversationVariableUpdatePayloadWithUser
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| user | string | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | No |
| value | [JsonValue](#jsonvalue) | 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](#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](/api-reference/models/get-available-models) with `model_type=text-embedding`. | No |
| embedding_model_provider | string | Embedding model provider. Use the `provider` field from [Get Available Models](/api-reference/models/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,
**Available values:** "economy", "high_quality" | `high_quality` uses embedding models for precise search; `economy` uses keyword-based indexing. | No |
| name | string | Name of the knowledge base. | Yes |
| permission | [PermissionEnum](#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](#retrievalmodel) | Retrieval model configuration. Controls how chunks are searched and ranked when querying this knowledge base. | No |
| summary_index_setting | object | Summary index configuration. | No |
#### DatasetDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_count | integer | | Yes |
| author_name | string | | Yes |
| built_in_field_enabled | boolean | | Yes |
| chunk_structure | string | | Yes |
| created_at | integer | | Yes |
| created_by | string | | Yes |
| data_source_type | string,
**Available values:** "local_file", "notion_import", "online_document", "online_drive", "upload_file", "website_crawl" | | Yes |
| description | string | | Yes |
| doc_form | string | | Yes |
| doc_metadata | [ [DatasetDocMetadataResponse](#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](#datasetexternalknowledgeinforesponse) | Connection details for external knowledge bases. Populated when `provider` is `external`; otherwise its properties are `null`. | No |
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | Icon display configuration for the knowledge base. | No |
| id | string | | Yes |
| indexing_technique | [IndexTechniqueType](#indextechniquetype) | | Yes |
| is_multimodal | boolean | | Yes |
| is_published | boolean | | Yes |
| maintainer | string | | No |
| name | string | | Yes |
| permission | string,
**Available values:** "all_team_members", "only_me", "partial_members" | *Enum:* `"all_team_members"`, `"only_me"`, `"partial_members"` | Yes |
| pipeline_id | string | | Yes |
| provider | string | | Yes |
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | Retrieval configuration for the knowledge base. | Yes |
| runtime_mode | string,
**Available values:** "general", "rag_pipeline" | | Yes |
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | Summary index configuration. | No |
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
| total_available_documents | integer | | Yes |
| total_documents | integer | | Yes |
| updated_at | integer | | Yes |
| updated_by | string | | Yes |
| word_count | integer | | Yes |
#### DatasetDetailWithPartialMembersResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_count | integer | | Yes |
| author_name | string | | Yes |
| built_in_field_enabled | boolean | | Yes |
| chunk_structure | string | | Yes |
| created_at | integer | | Yes |
| created_by | string | | Yes |
| data_source_type | string,
**Available values:** "local_file", "notion_import", "online_document", "online_drive", "upload_file", "website_crawl" | | Yes |
| description | string | | Yes |
| doc_form | string | | Yes |
| doc_metadata | [ [DatasetDocMetadataResponse](#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](#datasetexternalknowledgeinforesponse) | Connection details for external knowledge bases. Populated when `provider` is `external`; otherwise its properties are `null`. | No |
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | Icon display configuration for the knowledge base. | No |
| id | string | | Yes |
| indexing_technique | [IndexTechniqueType](#indextechniquetype) | | Yes |
| is_multimodal | boolean | | Yes |
| is_published | boolean | | Yes |
| maintainer | string | | No |
| name | string | | Yes |
| partial_member_list | [ string ] | | No |
| permission | string,
**Available values:** "all_team_members", "only_me", "partial_members" | *Enum:* `"all_team_members"`, `"only_me"`, `"partial_members"` | Yes |
| pipeline_id | string | | Yes |
| provider | string | | Yes |
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | Retrieval configuration for the knowledge base. | Yes |
| runtime_mode | string,
**Available values:** "general", "rag_pipeline" | | Yes |
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | Summary index configuration. | No |
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
| total_available_documents | integer | | Yes |
| total_documents | integer | | Yes |
| updated_at | integer | | Yes |
| updated_by | string | | Yes |
| word_count | integer | | Yes |
#### DatasetDocMetadataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| name | string | | Yes |
| type | string,
**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
#### DatasetExternalKnowledgeInfoResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| external_knowledge_api_endpoint | string | | No |
| external_knowledge_api_id | string | | No |
| external_knowledge_api_name | string | | No |
| external_knowledge_id | string | | No |
#### DatasetExternalRetrievalModelResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| score_threshold | number | | No |
| score_threshold_enabled | boolean | | No |
| top_k | integer | | Yes |
#### DatasetIconInfoResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon | string | | No |
| icon_background | string | | No |
| icon_type | string | | No |
| icon_url | string | | No |
#### DatasetKeywordSettingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_weight | number | | No |
#### 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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DatasetDetailResponse](#datasetdetailresponse) ] | | Yes |
| has_more | boolean | | Yes |
| limit | integer | | Yes |
| page | integer | | Yes |
| total | integer | | Yes |
#### DatasetMetadataActionResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result. | Yes |
#### DatasetMetadataBuiltInFieldResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | | Yes |
| type | string,
**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
#### DatasetMetadataBuiltInFieldsResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fields | [ [DatasetMetadataBuiltInFieldResponse](#datasetmetadatabuiltinfieldresponse) ] | | Yes |
#### DatasetMetadataListItemResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| count | integer | | No |
| id | string | | Yes |
| name | string | | Yes |
| type | string,
**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
#### DatasetMetadataListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| built_in_field_enabled | boolean | | Yes |
| doc_metadata | [ [DatasetMetadataListItemResponse](#datasetmetadatalistitemresponse) ] | | Yes |
#### DatasetMetadataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| name | string | | Yes |
| type | string,
**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
#### DatasetNameDuplicateError
The dataset name already exists. Please modify your dataset name.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DatasetNameDuplicateError | | The dataset name already exists. Please modify your dataset name. | |
#### DatasetRerankingModelResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_model_name | string | | No |
| reranking_provider_name | string | | No |
#### DatasetRetrievalModelResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reranking_enable | boolean | | Yes |
| reranking_mode | string | | No |
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | Reranking model configuration. | No |
| score_threshold | number | | No |
| score_threshold_enabled | boolean | | Yes |
| search_method | [RetrievalMethod](#retrievalmethod) | | Yes |
| top_k | integer | | Yes |
| weights | [DatasetWeightedScoreResponse](#datasetweightedscoreresponse) | | No |
#### DatasetSummaryIndexSettingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enable | boolean | | No |
| model_name | string | | No |
| model_provider_name | string | | No |
| summary_prompt | string | | No |
#### DatasetTagResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| name | string | | Yes |
| type | string | | Yes |
#### DatasetUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Description of the knowledge base. | No |
| embedding_model | string | Embedding model name. Use the `model` field from [Get Available Models](/api-reference/models/get-available-models) with `model_type=text-embedding`. | No |
| embedding_model_provider | string | Embedding model provider. Use the `provider` field from [Get Available Models](/api-reference/models/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,
**Available values:** "economy", "high_quality" | `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](#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](#retrievalmodel) | Retrieval model configuration. Controls how chunks are searched and ranked when querying this knowledge base. | No |
#### DatasetVectorSettingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model_name | string | | No |
| embedding_provider_name | string | | No |
| vector_weight | number | | No |
#### DatasetWeightedScoreResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | Keyword search weight settings. | No |
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | Semantic search weight settings. | No |
| weight_type | string | | No |
#### DatasourceCredentialInfoResponse
| Name | Type | Description | 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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | [ [DatasourceCredentialInfoResponse](#datasourcecredentialinforesponse) ] | | No |
| 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](#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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| archived | boolean | | No |
| average_segment_length | integer
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](#documentmetadataresponse) ]
object | | 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_type` and `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,
**Available values:** "archived", "available", "disabled", "error", "indexing", "paused", "queuing" | Filter by display status. | No |
#### DocumentListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DocumentResponse](#documentresponse) ] | | Yes |
| has_more | boolean | | Yes |
| limit | integer | | Yes |
| page | integer | | Yes |
| total | integer | | Yes |
#### DocumentMetadataOperation
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string (uuid) | Document ID whose metadata should be updated. | Yes |
| metadata_list | [ [MetadataDetail](#metadatadetail) ] | Metadata fields to update. | Yes |
| partial_update | boolean | Whether to partially update metadata, keeping existing values for unspecified fields. | No |
#### DocumentMetadataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| name | string | | Yes |
| type | string,
**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
| value | string
integer
number | | Yes |
#### DocumentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| archived | boolean | | No |
| created_at | integer | | No |
| created_by | string | | No |
| created_from | string | | No |
| data_source_detail_dict | [DocumentSourceDetailResponse](#documentsourcedetailresponse) | | Yes |
| data_source_info | object | | No |
| data_source_type | string | | No |
| dataset_process_rule_id | string | | No |
| disabled_at | integer | | No |
| disabled_by | string | | No |
| display_status | string | | No |
| doc_form | string | | No |
| doc_metadata | [ [DocumentMetadataResponse](#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 |
#### DocumentSourceDetailResponse
The uploaded file for file documents; Notion and website documents repeat their source info.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| upload_file | [DocumentUploadFileDetailResponse](#documentuploadfiledetailresponse) | | No |
#### DocumentStatusListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] | | Yes |
#### DocumentStatusPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_ids | [ string ] | List of document IDs to update. | No |
#### DocumentStatusResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cleaning_completed_at | integer | | Yes |
| completed_at | integer | | Yes |
| completed_segments | integer | | No |
| error | string | | Yes |
| error_code | string | | No |
| estimated_vector_space_mb | integer | | No |
| id | string | | Yes |
| indexing_status | string,
**Available values:** "cleaning", "completed", "error", "indexing", "parsing", "paused", "splitting", "waiting" | *Enum:* `"cleaning"`, `"completed"`, `"error"`, `"indexing"`, `"parsing"`, `"paused"`, `"splitting"`, `"waiting"` | 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 |
| vector_space_limit_mb | 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](/api-reference/models/get-available-models) with `model_type=text-embedding`. | No |
| embedding_model_provider | string | Embedding model provider. Use the `provider` field from [Get Available Models](/api-reference/models/get-available-models) with `model_type=text-embedding`. | No |
| indexing_technique | string,
**Available values:** "economy", "high_quality" | `high_quality` uses embedding models for precise search; `economy` uses keyword-based indexing. Required when adding the first document to a knowledge base; subsequent documents inherit the knowledge base's indexing technique if omitted. | No |
| name | string | Document name. | Yes |
| original_document_id | string | Original document ID for replacement. | No |
| process_rule | [ProcessRule](#processrule) | Processing rules for chunking. | No |
| retrieval_model | [RetrievalModel](#retrievalmodel) | Controls how chunks are searched and ranked when querying this knowledge base. | 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](#processrule) | Processing rules for chunking. | No |
| retrieval_model | [RetrievalModel](#retrievalmodel) | Controls how chunks are searched and ranked when querying this knowledge base. | No |
| text | string | Document text content. | No |
#### DocumentUploadFileDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | number | | Yes |
| created_by | string | | Yes |
| extension | string | | Yes |
| id | string | | Yes |
| mime_type | string | | No |
| name | string | | Yes |
| size | integer | | Yes |
#### EndUserDetail
Full end-user detail returned by the Service API.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string | | No |
| created_at | dateTime | | Yes |
| external_user_id | string | | No |
| id | string (uuid) | | Yes |
| is_anonymous | boolean | | Yes |
| name | string | | No |
| session_id | string | | Yes |
| tenant_id | string (uuid) | | Yes |
| type | string | | Yes |
| updated_at | dateTime | | Yes |
#### EndUserNotFoundError
End user not found.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| EndUserNotFoundError | | End user not found. | |
#### ErrorMessageResponse
Legacy ``{"error": message}`` body a few endpoints return instead of the standard error body.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| error | string | | Yes |
#### ErrorResponse
Documented non-2xx body emitted by ``register_external_error_handlers``.
``params`` and ``details`` appear only on the errors that set them. The schema
stays open because ``HTTPException.data`` may carry extra keys.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string | | Yes |
| details | object | | No |
| message | string | | Yes |
| params | string | | No |
| status | integer | | Yes |
#### 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. | |
#### FileAccessDeniedError
Access to the requested file is denied.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileAccessDeniedError | | Access to the requested file is denied. | |
#### FileExtensionBlockedError
The file extension is blocked for security reasons.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileExtensionBlockedError | | The file extension is blocked for security reasons. | |
#### FileInputConfig
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_file_extensions | [ string ] | | No |
| allowed_file_types | [ [FileType](#filetype) ] | | No |
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
| output_variable_name | string | | Yes |
| type | string | | No |
#### FileListInputConfig
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| allowed_file_extensions | [ string ] | | No |
| allowed_file_types | [ [FileType](#filetype) ] | | No |
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
| number_limits | integer | | No |
| output_variable_name | string | | Yes |
| type | string | | No |
#### FileNotFoundError
The requested file was not found.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileNotFoundError | | The requested file was not found. | |
#### 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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | | No |
| created_at | integer | | No |
| created_by | string | | No |
| extension | string | | No |
| file_key | string | | No |
| id | string (uuid) | | Yes |
| mime_type | string | | No |
| name | string | | Yes |
| original_url | string | | No |
| preview_url | string | | No |
| reference | string | | No |
| size | integer | | Yes |
| source_url | string | | No |
| tenant_id | string | | No |
| user_id | string | | No |
#### FileTooLargeError
File size exceeded. {message}
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileTooLargeError | | File size exceeded. {message} | |
#### FileTransferMethod
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileTransferMethod | string | | |
#### FileType
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FileType | string | | |
#### FilenameNotExistsError
The specified filename does not exist.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FilenameNotExistsError | | The specified filename does not exist. | |
#### ForbiddenError
You don't have the permission to access the requested resource.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ForbiddenError | | You don't have the permission to access the requested resource. | |
#### FormInputConfig
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FormInputConfig | [ParagraphInputConfig](#paragraphinputconfig)
[SelectInputConfig](#selectinputconfig)
[FileInputConfig](#fileinputconfig)
[FileListInputConfig](#filelistinputconfig) | | |
#### HitTestingChildChunk
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
| id | string | | Yes |
| position | integer | | Yes |
| score | number | | Yes |
#### HitTestingDocument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data_source_type | string | | Yes |
| doc_metadata | | | Yes |
| doc_type | string | | Yes |
| id | string | | Yes |
| name | string | | Yes |
#### HitTestingFile
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| extension | string | | Yes |
| id | string | | Yes |
| mime_type | string | | Yes |
| name | string | | Yes |
| size | integer | | Yes |
| source_url | string | | Yes |
#### HitTestingPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| attachment_ids | [ string ] | Upload file UUIDs to include in the retrieval context. Omit or use an empty list when there are no attachments. | No |
| external_retrieval_model | object | Retrieval settings for external knowledge bases. | No |
| query | string | Search query text. | Yes |
| retrieval_model | [RetrievalModel](#retrievalmodel) | Retrieval model configuration. Controls how chunks are searched and ranked when querying this knowledge base. | No |
#### HitTestingQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
#### HitTestingRecord
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| child_chunks | [ [HitTestingChildChunk](#hittestingchildchunk) ] | | Yes |
| files | [ [HitTestingFile](#hittestingfile) ] | | Yes |
| score | number | | Yes |
| segment | [HitTestingSegment](#hittestingsegment) | Matched chunk from the knowledge base. | Yes |
| summary | string | | Yes |
| tsne_position | | | Yes |
#### HitTestingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| query | [HitTestingQuery](#hittestingquery) | The original query object. | Yes |
| records | [ [HitTestingRecord](#hittestingrecord) ] | | Yes |
#### HitTestingSegment
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | Yes |
| completed_at | integer | | Yes |
| content | string | | Yes |
| created_at | integer | | Yes |
| created_by | string | | Yes |
| disabled_at | integer | | Yes |
| disabled_by | string | | Yes |
| document | [HitTestingDocument](#hittestingdocument) | Parent document information for the matched chunk. | Yes |
| document_id | string | | Yes |
| enabled | boolean | | Yes |
| error | string | | Yes |
| hit_count | integer | | Yes |
| id | string | | Yes |
| index_node_hash | string | | Yes |
| index_node_id | string | | Yes |
| indexing_at | integer | | Yes |
| keywords | [ string ] | | Yes |
| position | integer | | Yes |
| sign_content | string | | Yes |
| status | string | | Yes |
| stopped_at | integer | | Yes |
| tokens | integer | | Yes |
| word_count | integer | | Yes |
#### HumanInputContent
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| form_definition | [HumanInputFormDefinition](#humaninputformdefinition) | | No |
| form_submission_data | [HumanInputFormSubmissionData](#humaninputformsubmissiondata) | | No |
| submitted | boolean | | Yes |
| type | [ExecutionContentType](#executioncontenttype) | | No |
| workflow_run_id | string | | Yes |
#### HumanInputFormDefinition
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| actions | [ [UserActionConfig](#useractionconfig) ] | | No |
| display_in_ui | boolean | | No |
| expiration_time | integer | | Yes |
| form_content | string | | Yes |
| form_id | string | | Yes |
| form_token | string | | No |
| form_version | string,
**Available values:** "1", "2",
**Default:** 1 | *Enum:* `"1"`, `"2"` | No |
| inputs | [ [FormInputConfig](#forminputconfig) ] | | No |
| node_id | string | | Yes |
| node_title | string | | Yes |
| resolved_default_values | object | | No |
#### HumanInputFormDefinitionResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expiration_time | integer | | No |
| form_content | string | | Yes |
| inputs | [ [FormInputConfig](#forminputconfig) ] | | Yes |
| resolved_default_values | object | | Yes |
| user_actions | [ [UserActionConfig](#useractionconfig) ] | | Yes |
#### HumanInputFormExpiredError
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| HumanInputFormExpiredError | | | |
#### HumanInputFormSubmissionData
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action_id | string | | Yes |
| action_text | string | | Yes |
| node_id | string | | Yes |
| node_title | string | | Yes |
| rendered_content | string | | Yes |
| submitted_data | object | | No |
#### HumanInputFormSubmitPayload
Legacy Human Input v1 submit payload shared by existing runtime surfaces.
| 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
Legacy Human Input v1 submit payload shared by existing runtime surfaces.
| 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 | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | Yes |
#### HumanInputFormSubmitResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
#### HumanInputFormSubmittedError
This form has already been submitted by another user, form_id={form_id}
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| HumanInputFormSubmittedError | | This form has already been submitted by another user, form_id={form_id} | |
#### IndexInfoResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| api_version | string | | Yes |
| server_version | string | | Yes |
| welcome | string | | Yes |
#### IndexTechniqueType
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IndexTechniqueType | string | | |
#### InvalidActionError
Invalid action.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InvalidActionError | | Invalid action. | |
#### InvalidFormDataError
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InvalidFormDataError | | | |
#### InvalidMetadataError
The metadata content is incorrect. Please check and verify.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InvalidMetadataError | | The metadata content is incorrect. Please check and verify. | |
#### JSONObject
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| JSONObject | object | | |
#### JSONValueType
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| JSONValueType | | | |
#### JsonValue
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| JsonValue | | | |
#### KnowledgeFSActiveProfileRevisions
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding | integer | | No |
| retrieval | integer | | No |
#### KnowledgeFSAdmittedQueryRequest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| activeDocumentIds | [ string ] | | No |
| activeEntityIds | [ string ] | | No |
| knowledgeSpaceId | string | | Yes |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | | No |
| query | string | | No |
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
| sessionId | string | | No |
#### KnowledgeFSAnswerTraceResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | dateTime | | Yes |
| evidence_bundle_id | string | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | *Enum:* `"auto"`, `"deep"`, `"fast"`, `"research"` | Yes |
| query | string | | Yes |
| query_images | [ [KnowledgeFSQueryImageResponse](#knowledgefsqueryimageresponse) ] | | No |
| source | [KnowledgeFSTraceSource](#knowledgefstracesource) | | No |
| steps | [ [KnowledgeFSAnswerTraceStepResponse](#knowledgefsanswertracestepresponse) ] | | Yes |
#### KnowledgeFSAnswerTraceStepResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ended_at | string | | No |
| metadata | object | | Yes |
| name | string | | Yes |
| started_at | dateTime | | Yes |
| status | string,
**Available values:** "error", "ok", "skipped" | *Enum:* `"error"`, `"ok"`, `"skipped"` | Yes |
#### KnowledgeFSBackgroundTaskFailureResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string | | Yes |
| document_title | string | | No |
| error_code | string | | Yes |
| error_message | string | | Yes |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | Yes |
| job_id | string | | No |
#### KnowledgeFSBackgroundTaskListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
| task_ids | string | Comma-separated document or document_bulk task IDs for an exact lookup | No |
#### KnowledgeFSBackgroundTaskListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSBackgroundTaskResponse](#knowledgefsbackgroundtaskresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSBackgroundTaskResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| can_cancel | boolean | | Yes |
| can_retry | boolean | | Yes |
| completed_at | string | | No |
| created_at | dateTime | | Yes |
| document_id | string | | No |
| document_revision | integer | | No |
| document_title | string | | No |
| error_code | string | | No |
| error_message | string | | No |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| failures | [ [KnowledgeFSBackgroundTaskFailureResponse](#knowledgefsbackgroundtaskfailureresponse) ] | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| operation | string,
**Available values:** "document_delete", "document_processing", "document_reindex", "document_upload", "source_bulk", "source_crawl_import", "source_crawl_preview", "source_online_document_import", "source_online_drive_import", "source_sync" | *Enum:* `"document_delete"`, `"document_processing"`, `"document_reindex"`, `"document_upload"`, `"source_bulk"`, `"source_crawl_import"`, `"source_crawl_preview"`, `"source_online_document_import"`, `"source_online_drive_import"`, `"source_sync"` | Yes |
| progress_completed | integer | | Yes |
| progress_failed | integer | | Yes |
| progress_percent | integer | | Yes |
| progress_total | integer | | Yes |
| semantic_enrichment | [KnowledgeFSSemanticEnrichmentResponse](#knowledgefssemanticenrichmentresponse) | | No |
| source_id | string | | No |
| source_title | string | | No |
| state | string,
**Available values:** "canceled", "completed", "failed", "queued", "running" | *Enum:* `"canceled"`, `"completed"`, `"failed"`, `"queued"`, `"running"` | Yes |
| task_kind | string,
**Available values:** "document", "document_bulk", "source" | *Enum:* `"document"`, `"document_bulk"`, `"source"` | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSBulkDeletionAcceptedItemResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string | | Yes |
| document_title | string | | No |
| job | [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse) | | Yes |
| status_url | string | | Yes |
#### KnowledgeFSBulkDeletionAcceptedResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| batch_id | string | | No |
| items | [ [KnowledgeFSBulkDeletionAcceptedItemResponse](#knowledgefsbulkdeletionaccepteditemresponse) ] | | Yes |
| results | [ [KnowledgeFSBulkDeletionResultResponse](#knowledgefsbulkdeletionresultresponse) ] | | No |
| status_url | string | | No |
| total | integer | | Yes |
#### KnowledgeFSBulkDeletionResultResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string | | Yes |
| error | [KnowledgeFSDurableDeletionErrorResponse](#knowledgefsdurabledeletionerrorresponse) | | No |
| job | [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse) | | No |
| status | string,
**Available values:** "accepted", "pending", "rejected" | *Enum:* `"accepted"`, `"pending"`, `"rejected"` | Yes |
| status_url | string | | No |
#### KnowledgeFSBulkDocumentDeleteItemPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentId | string | | Yes |
| expectedRevision | integer | | Yes |
#### KnowledgeFSBulkDocumentDeletePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documents | [ [KnowledgeFSBulkDocumentDeleteItemPayload](#knowledgefsbulkdocumentdeleteitempayload) ] | | Yes |
#### KnowledgeFSBulkJobFailureResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string | | Yes |
| document_title | string | | No |
| error_code | string | | Yes |
| error_message | string | | Yes |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| job_id | string | | No |
#### KnowledgeFSBulkJobResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| canceled_items | integer | | Yes |
| completed_items | integer | | Yes |
| created_at | dateTime | | Yes |
| failed_item_ids | [ string ] | | Yes |
| failed_items | integer | | Yes |
| failures | [ [KnowledgeFSBulkJobFailureResponse](#knowledgefsbulkjobfailureresponse) ] | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| status | string,
**Available values:** "canceled", "completed", "failed", "running" | *Enum:* `"canceled"`, `"completed"`, `"failed"`, `"running"` | Yes |
| total_items | integer | | Yes |
| type | string,
**Available values:** "document_delete", "document_reindex", "document_upload" | *Enum:* `"document_delete"`, `"document_reindex"`, `"document_upload"` | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSCrawlImportPagePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
| description | string | | No |
| sourceUrl | string | | Yes |
| title | string | | No |
#### KnowledgeFSCrawlImportPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| desiredSyncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
| pages | [ [KnowledgeFSCrawlImportPagePayload](#knowledgefscrawlimportpagepayload) ] | | No |
| replaceExistingSelection | boolean | | No |
| sourceUpdate | [KnowledgeFSSourceImportConfigurationPayload](#knowledgefssourceimportconfigurationpayload) | | No |
| sourceUrls | [ string ] | | Yes |
#### KnowledgeFSCrawlPreviewPageListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
#### KnowledgeFSCrawlPreviewPageListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSCrawlPreviewPageResponse](#knowledgefscrawlpreviewpageresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSCrawlPreviewPageResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | No |
| etag | string | | No |
| page_id | string | | Yes |
| source_url | string | | Yes |
| title | string | | No |
#### KnowledgeFSCrawlPreviewSelectionPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pageIds | [ string ] | | Yes |
#### KnowledgeFSCrawledPageResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
| description | string | | No |
| source_url | string | | Yes |
| title | string | | No |
#### KnowledgeFSCursorQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
#### KnowledgeFSDocumentChunkListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
| query | string | | No |
#### KnowledgeFSDocumentChunkListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSDocumentChunkResponse](#knowledgefsdocumentchunkresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSDocumentChunkResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | dateTime | | Yes |
| document_id | string | | Yes |
| document_revision | integer | | Yes |
| enabled | boolean | | Yes |
| end_offset | integer | | No |
| id | string | | Yes |
| kind | string,
**Available values:** "chunk", "image", "section", "summary", "table",
**Default:** chunk | *Enum:* `"chunk"`, `"image"`, `"section"`, `"summary"`, `"table"` | No |
| knowledge_space_id | string | | Yes |
| ordinal | integer | | Yes |
| parent_chunk_id | string | | No |
| parse_element_ids | [ string ] | | Yes |
| section_path | [ string ] | | No |
| start_offset | integer | | No |
| text | string | | Yes |
| token_count | integer | | Yes |
| user_metadata | object | | Yes |
#### KnowledgeFSDocumentCompilationJobResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| base_head_revision | integer | | No |
| candidate_fingerprint | string | | No |
| candidate_publication_id | string | | No |
| completed_at | number | | No |
| created_at | number | | Yes |
| document_asset_id | string | | Yes |
| error | string | | No |
| execution_attempts | integer | | No |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| max_execution_attempts | integer | | No |
| run_state | string | | No |
| stage | string,
**Available values:** "canceled", "failed", "nodes_generated", "outline_built", "parsed", "projection_built", "published", "queued", "smoke_eval_passed" | *Enum:* `"canceled"`, `"failed"`, `"nodes_generated"`, `"outline_built"`, `"parsed"`, `"projection_built"`, `"published"`, `"queued"`, `"smoke_eval_passed"` | Yes |
| updated_at | number | | Yes |
| version | integer | | Yes |
#### KnowledgeFSDocumentDeletePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedRevision | integer | | Yes |
#### KnowledgeFSDocumentListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSDocumentMetadataPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedRowVersion | integer | | Yes |
| patch | object | | Yes |
#### KnowledgeFSDocumentOutlineNodeResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| child_node_ids | [ string ] | | No |
| children | [ [KnowledgeFSDocumentOutlineNodeResponse](#knowledgefsdocumentoutlinenoderesponse) ] | | No |
| end_offset | integer | | No |
| end_page | integer | | No |
| id | string | | Yes |
| level | integer | | Yes |
| metadata | object | | Yes |
| section_path | [ string ] | | No |
| source_element_ids | [ string ] | | No |
| source_node_ids | [ string ] | | No |
| start_offset | integer | | No |
| start_page | integer | | No |
| summary | string | | No |
| title | string | | Yes |
| title_location | object | | No |
| toc_source | string | | Yes |
#### KnowledgeFSDocumentOutlineResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| artifact_hash | string | | Yes |
| created_at | dateTime | | Yes |
| document_asset_id | string | | Yes |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| metadata | object | | Yes |
| nodes | [ [KnowledgeFSDocumentOutlineNodeResponse](#knowledgefsdocumentoutlinenoderesponse) ] | | Yes |
| outline_version | string | | Yes |
| parse_artifact_id | string | | Yes |
| updated_at | string | | No |
| version | integer | | Yes |
#### KnowledgeFSDocumentProcessingTaskListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSDocumentProcessingTaskResponse](#knowledgefsdocumentprocessingtaskresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSDocumentProcessingTaskResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_operations | [ string ] | | No |
| completed_at | string | | No |
| created_at | dateTime | | Yes |
| document_id | string | | Yes |
| document_revision | integer | | Yes |
| error_code | string,
**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | | No |
| error_message | string | | No |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| phase | string | | No |
| progress_percent | integer | | Yes |
| retry_at | string | | No |
| semantic_enrichment | [KnowledgeFSSemanticEnrichmentResponse](#knowledgefssemanticenrichmentresponse) | | No |
| stage | string,
**Available values:** "nodes_generated", "outline_built", "parsed", "projection_built", "published", "queued", "smoke_eval_passed" | *Enum:* `"nodes_generated"`, `"outline_built"`, `"parsed"`, `"projection_built"`, `"published"`, `"queued"`, `"smoke_eval_passed"` | Yes |
| state | string,
**Available values:** "canceled", "dispatch_pending", "failed", "queued", "retry_wait", "running", "succeeded", "superseded" | *Enum:* `"canceled"`, `"dispatch_pending"`, `"failed"`, `"queued"`, `"retry_wait"`, `"running"`, `"succeeded"`, `"superseded"` | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSDocumentReferenceQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_asset_id | string | | Yes |
| document_asset_version | integer | | Yes |
#### KnowledgeFSDocumentReindexItemResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| asset | [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse) | | No |
| code | string | | No |
| compilation_job | object | | No |
| document_id | string | | No |
| error | string | | No |
| status | string,
**Available values:** "disabled", "failed", "not_found", "pending", "queued" | *Enum:* `"disabled"`, `"failed"`, `"not_found"`, `"pending"`, `"queued"` | Yes |
| status_url | string | | No |
#### KnowledgeFSDocumentReindexPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| all | boolean | | No |
| documentIds | [ string ] | | No |
#### KnowledgeFSDocumentReindexResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| bulk_job_id | string | | Yes |
| items | [ [KnowledgeFSDocumentReindexItemResponse](#knowledgefsdocumentreindexitemresponse) ] | | Yes |
| total | integer | | Yes |
#### KnowledgeFSDocumentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | dateTime | | Yes |
| filename | string | | Yes |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| metadata | object | | Yes |
| mime_type | string | | Yes |
| object_key | string | | Yes |
| parser_status | string,
**Available values:** "failed", "parsed", "pending" | *Enum:* `"failed"`, `"parsed"`, `"pending"` | Yes |
| sha256 | string | | Yes |
| size_bytes | integer | | Yes |
| source_id | string | | No |
| updated_at | string | | No |
| version | integer | | Yes |
#### KnowledgeFSDocumentRevisionListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSDocumentRevisionResponse](#knowledgefsdocumentrevisionresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSDocumentRevisionResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| activated_at | string | | No |
| content_hash | string | | Yes |
| created_at | dateTime | | Yes |
| document_asset_id | string | | Yes |
| document_asset_version | integer | | Yes |
| document_id | string | | Yes |
| knowledge_space_id | string | | Yes |
| mime_type | string | | Yes |
| revision | integer | | Yes |
| size_bytes | integer | | Yes |
| state | string,
**Available values:** "active", "candidate", "failed", "superseded" | *Enum:* `"active"`, `"candidate"`, `"failed"`, `"superseded"` | Yes |
#### KnowledgeFSDurableDeletionAcceptedResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_title | string | | No |
| job | [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse) | | Yes |
| status_url | string | | Yes |
#### KnowledgeFSDurableDeletionErrorResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string | | Yes |
| message | string | | Yes |
| retryable | boolean | | Yes |
#### KnowledgeFSDurableDeletionJobResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| checkpoint | string,
**Available values:** "completed", "deleting_derived_data", "deleting_objects", "deleting_primary_data", "quiescing", "requested" | *Enum:* `"completed"`, `"deleting_derived_data"`, `"deleting_objects"`, `"deleting_primary_data"`, `"quiescing"`, `"requested"` | Yes |
| completed_at | string | | No |
| created_at | dateTime | | Yes |
| error | [KnowledgeFSDurableDeletionErrorResponse](#knowledgefsdurabledeletionerrorresponse) | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| mode | string,
**Available values:** "cascade", "keep" | | No |
| progress | [KnowledgeFSDurableDeletionProgressResponse](#knowledgefsdurabledeletionprogressresponse) | | No |
| retry_at | string | | No |
| run_state | string,
**Available values:** "canceled", "completed", "dispatch_pending", "failed", "queued", "retry_wait", "running" | *Enum:* `"canceled"`, `"completed"`, `"dispatch_pending"`, `"failed"`, `"queued"`, `"retry_wait"`, `"running"` | Yes |
| target_id | string | | Yes |
| target_type | string,
**Available values:** "document", "knowledge_space", "logical_document", "source" | *Enum:* `"document"`, `"knowledge_space"`, `"logical_document"`, `"source"` | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSDurableDeletionProgressResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| completed_items | integer | | Yes |
| current_item_kind | string | | No |
| total_items | integer | | No |
#### KnowledgeFSEmbeddingSettingsResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dimension | integer | | No |
| model | string | | Yes |
| plugin_id | string | | Yes |
| provider | string | | Yes |
| revision | integer | | No |
| vector_space_id | string | | No |
#### KnowledgeFSLogicalDocumentDeletePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedRevision | integer | | Yes |
#### KnowledgeFSLogicalDocumentListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSLogicalDocumentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active | [KnowledgeFSDocumentRevisionResponse](#knowledgefsdocumentrevisionresponse) | | Yes |
| active_revision | integer | | No |
| created_at | dateTime | | Yes |
| disabled_at | string | | No |
| disabled_by_subject_id | string | | No |
| enabled | boolean,
**Default:** true | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| latest_task | [KnowledgeFSBackgroundTaskResponse](#knowledgefsbackgroundtaskresponse) | | No |
| provider_item_id | string | | No |
| row_version | integer | | Yes |
| source_id | string | | No |
| status | string,
**Available values:** "deleting", "failed", "pending", "ready" | *Enum:* `"deleting"`, `"failed"`, `"pending"`, `"ready"` | Yes |
| title | string | | Yes |
| updated_at | dateTime | | Yes |
| user_metadata | object | | Yes |
#### KnowledgeFSOnlineDocumentWorkflowImportItemPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| etag | string | | No |
| lastEditedTime | string | | No |
| name | string | | No |
| pageId | string | | Yes |
| providerItemId | string | | Yes |
| type | string | | Yes |
| workspaceId | string | | Yes |
#### KnowledgeFSOnlineDocumentWorkflowImportPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| desiredSyncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
| items | [ [KnowledgeFSOnlineDocumentWorkflowImportItemPayload](#knowledgefsonlinedocumentworkflowimportitempayload) ] | | Yes |
| kind | string | | Yes |
| sourceUpdate | [KnowledgeFSSourceImportConfigurationPayload](#knowledgefssourceimportconfigurationpayload) | | No |
#### KnowledgeFSOnlineDriveWorkflowImportItemPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| bucket | string | | No |
| etag | string | | No |
| id | string | | Yes |
| mimeType | string | | No |
| name | string | | Yes |
| providerItemId | string | | Yes |
#### KnowledgeFSOnlineDriveWorkflowImportPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| desiredSyncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
| items | [ [KnowledgeFSOnlineDriveWorkflowImportItemPayload](#knowledgefsonlinedriveworkflowimportitempayload) ] | | Yes |
| kind | string | | Yes |
| sourceUpdate | [KnowledgeFSSourceImportConfigurationPayload](#knowledgefssourceimportconfigurationpayload) | | No |
#### KnowledgeFSProductRerankProfile
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean | | Yes |
| model | [KnowledgeFSProfileModelSelection](#knowledgefsprofilemodelselection) | | No |
#### KnowledgeFSProductRetrievalProfile
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| defaultMode | string,
**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
| reasoningModel | [KnowledgeFSProfileModelSelection](#knowledgefsprofilemodelselection) | | Yes |
| rerank | [KnowledgeFSProductRerankProfile](#knowledgefsproductrerankprofile) | | Yes |
| scoreThreshold | [KnowledgeFSProductScoreThreshold](#knowledgefsproductscorethreshold) | | Yes |
| topK | integer | | Yes |
#### KnowledgeFSProductScoreThreshold
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean | | Yes |
| stage | string,
**Available values:** "mode-final", "rerank",
**Default:** mode-final | *Enum:* `"mode-final"`, `"rerank"` | No |
| value | number | | No |
#### KnowledgeFSProfileMigrationResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| candidate_publication_fingerprint | string | | No |
| changed_kind | string,
**Available values:** "embedding", "retrieval" | *Enum:* `"embedding"`, `"retrieval"` | Yes |
| checkpoint | string,
**Available values:** "activated", "candidate-built", "evaluated", "queued" | *Enum:* `"activated"`, `"candidate-built"`, `"evaluated"`, `"queued"` | Yes |
| completed_at | string | | No |
| created_at | dateTime | | Yes |
| error_code | string | | No |
| evaluation_summary | object | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| rebuild_scope | string,
**Available values:** "clone-publication", "full-page-index-summary-outline", "full-vector-space" | *Enum:* `"clone-publication"`, `"full-page-index-summary-outline"`, `"full-vector-space"` | Yes |
| run_state | string,
**Available values:** "canceled", "failed", "queued", "running", "succeeded" | *Enum:* `"canceled"`, `"failed"`, `"queued"`, `"running"`, `"succeeded"` | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSProfileModelSelection
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| model | string | | Yes |
| pluginId | string | | Yes |
| provider | string | | Yes |
#### KnowledgeFSPublicFailureResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string,
**Available values:** "configure_model", "configure_parser", "configure_source", "contact_admin", "retry", "reupload" | | No |
| category | string,
**Available values:** "authorization", "canceled", "configuration", "conflict", "dependency", "internal", "not_found", "rate_limit", "timeout", "validation" | *Enum:* `"authorization"`, `"canceled"`, `"configuration"`, `"conflict"`, `"dependency"`, `"internal"`, `"not_found"`, `"rate_limit"`, `"timeout"`, `"validation"` | Yes |
| code | string,
**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | *Enum:* `"DOCUMENT_COMPILATION_FAILED"`, `"DOCUMENT_COMPILATION_LEASE_LOST"`, `"DOCUMENT_COMPILATION_PROFILE_CHANGED"`, `"DOCUMENT_COMPILATION_RETRYABLE"`, `"DOCUMENT_COUNT_QUOTA_EXCEEDED"`, `"DOCUMENT_COUNT_QUOTA_UNAVAILABLE"`, `"DOCUMENT_DISABLED"`, `"DOCUMENT_PARSER_INPUT_INVALID"`, `"DOCUMENT_PARSER_NOT_CONFIGURED"`, `"DOCUMENT_PARSER_RATE_LIMITED"`, `"DOCUMENT_PARSER_RESPONSE_INVALID"`, `"DOCUMENT_PARSER_TIMEOUT"`, `"DOCUMENT_PARSER_UNAVAILABLE"`, `"DOCUMENT_PARSER_UNSUPPORTED_TYPE"`, `"DOCUMENT_PDF_RENDER_FAILED"`, `"DURABLE_DELETION_IDEMPOTENCY_CONFLICT"`, `"EMBEDDING_DIMENSION_INVALID"`, `"EMBEDDING_DIMENSION_UNSUPPORTED"`, `"EXECUTION_ATTEMPTS_EXHAUSTED"`, `"KNOWLEDGE_FS_ACCESS_DENIED"`, `"KNOWLEDGE_FS_CONFLICT"`, `"KNOWLEDGE_FS_INTERNAL_ERROR"`, `"KNOWLEDGE_FS_INVALID_REQUEST"`, `"KNOWLEDGE_FS_NOT_FOUND"`, `"KNOWLEDGE_FS_RATE_LIMITED"`, `"KNOWLEDGE_FS_TIMEOUT"`, `"KNOWLEDGE_FS_UNAVAILABLE"`, `"KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND"`, `"KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS"`, `"KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT"`, `"LOGICAL_DOCUMENT_CAS_CONFLICT"`, `"MODEL_CAPABILITY_MISMATCH"`, `"MODEL_CONFIGURATION_STALE"`, `"MODEL_CREDENTIAL_INVALID"`, `"MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE"`, `"MODEL_IDENTITY_MISMATCH"`, `"MODEL_PREFLIGHT_CANCELED"`, `"MODEL_PREFLIGHT_FAILED"`, `"MODEL_PREFLIGHT_TIMEOUT"`, `"MODEL_PREFLIGHT_UNAVAILABLE"`, `"MODEL_PROFILE_ACTIVATION_INCOMPLETE"`, `"MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED"`, `"MODEL_RUNTIME_CONTEXT_LIMIT"`, `"MODEL_RUNTIME_FAILED"`, `"MODEL_RUNTIME_OUTPUT_LIMIT"`, `"MODEL_RUNTIME_RESPONSE_INVALID"`, `"MODEL_RUNTIME_TIMEOUT"`, `"MODEL_RUNTIME_UNAVAILABLE"`, `"MODEL_SELECTION_NOT_FOUND"`, `"RESEARCH_TASK_CAPABILITY_REVOKED"`, `"RESEARCH_TASK_DISPATCH_DEAD"`, `"RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED"`, `"RESEARCH_TASK_FAILED"`, `"RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID"`, `"RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID"`, `"RETRIEVAL_DELETION_IN_PROGRESS"`, `"RETRIEVAL_EXECUTION_LEASE_LOST"`, `"SOURCE_BULK_ACTION_FAILED"`, `"SOURCE_CONNECTION_UNAVAILABLE"`, `"SOURCE_CRAWL_PAGE_NOT_FOUND"`, `"SOURCE_CRAWL_PROVIDER_UNAVAILABLE"`, `"SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED"`, `"SOURCE_CREDENTIAL_CONFIG_INVALID"`, `"SOURCE_CREDENTIAL_MUTATION_FAILED"`, `"SOURCE_CREDENTIAL_TEST_FAILED"`, `"SOURCE_CREDENTIAL_UNAVAILABLE"`, `"SOURCE_DOCUMENT_COMPILATION_FAILED"`, `"SOURCE_DOCUMENT_MATERIALIZATION_FAILED"`, `"SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED"`, `"SOURCE_IMPORT_PARTIAL_FAILURE"`, `"SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID"`, `"SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_UNAVAILABLE"`, `"SOURCE_ONLINE_DRIVE_CONFIG_INVALID"`, `"SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED"`, `"SOURCE_ONLINE_DRIVE_IMPORT_FAILED"`, `"SOURCE_ONLINE_DRIVE_REQUEST_FAILED"`, `"SOURCE_ONLINE_DRIVE_UNAVAILABLE"`, `"SOURCE_OPERATION_FAILED"`, `"SOURCE_PROVIDER_REJECTED"`, `"SOURCE_PROVIDER_TIMEOUT"`, `"SOURCE_PROVIDER_UNAVAILABLE"`, `"SOURCE_SECRET_INTEGRITY_FAILED"`, `"SOURCE_SECRET_REF_CONFLICT"`, `"SOURCE_SYNC_FAILED"`, `"SOURCE_SYNC_SELECTION_MISMATCH"`, `"SOURCE_VERSION_CONFLICT"`, `"SOURCE_WEBSITE_CRAWL_CONFIG_INVALID"`, `"SOURCE_WEBSITE_CRAWL_FAILED"`, `"SOURCE_WORKFLOW_CONTENT_MISSING"`, `"SOURCE_WORKFLOW_CONTENT_TOO_LARGE"`, `"SOURCE_WORKFLOW_EXTERNAL_TIMEOUT"`, `"SOURCE_WORKFLOW_FAILED"`, `"UPLOAD_INITIALIZATION_FAILED"`, `"UPLOAD_INTEGRITY_MISMATCH"`, `"VECTOR_SPACE_QUOTA_EXCEEDED"`, `"VECTOR_SPACE_QUOTA_UNAVAILABLE"` | Yes |
| message | string | | Yes |
| parameters | object | | No |
| retryPolicy | string,
**Available values:** "after_configuration", "automatic", "manual", "never" | *Enum:* `"after_configuration"`, `"automatic"`, `"manual"`, `"never"` | Yes |
| stage | string | | No |
| traceId | string | | No |
#### KnowledgeFSQueryAdmissionResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expires_at | dateTime | | Yes |
| operation_id | string | | Yes |
| request | [KnowledgeFSAdmittedQueryRequest](#knowledgefsadmittedqueryrequest) | | Yes |
| token | string | | Yes |
| trace_id | string | | Yes |
| url | string | | Yes |
#### KnowledgeFSQueryCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| activeDocumentIds | [ string ] | | No |
| activeEntityIds | [ string ] | | No |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | | No |
| query | string | | No |
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
| sessionId | string | | No |
#### KnowledgeFSQueryImageReference
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| uploadFileId | string | | Yes |
#### KnowledgeFSQueryImageResponse
One query image a retrieval run was asked with, enriched for console display.
The gateway persists only the UploadFile reference and static metadata; the console fills in
the file name and a short-lived signed preview URL for files the caller still owns.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| byte_size | integer | | No |
| mime_type | string | | No |
| name | string | | No |
| preview_url | string | | No |
| upload_file_id | string | | Yes |
#### KnowledgeFSReadinessCapabilities
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| deep | boolean | | Yes |
| index | boolean | | Yes |
| ingest | boolean | | Yes |
| query | boolean | | Yes |
| research | boolean | | Yes |
| source_sync | boolean | | Yes |
#### KnowledgeFSReadinessIssue
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string,
**Available values:** "binding_missing", "incompatible", "missing", "unavailable", "validation_failed" | *Enum:* `"binding_missing"`, `"incompatible"`, `"missing"`, `"unavailable"`, `"validation_failed"` | Yes |
| field | string,
**Available values:** "embedding", "publication", "reasoning", "rerank" | *Enum:* `"embedding"`, `"publication"`, `"reasoning"`, `"rerank"` | Yes |
| retryable | boolean | | Yes |
#### KnowledgeFSResearchTaskCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| budgetUsd | number | | No |
| limits | [KnowledgeFSResearchTaskLimits](#knowledgefsresearchtasklimits) | | No |
| metadata | object | | No |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | | No |
| query | string | | No |
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
| topK | integer | | No |
#### KnowledgeFSResearchTaskLimits
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| maxRetrievalSteps | integer | | No |
| maxScannedResources | integer | | No |
| maxToolCalls | integer | | No |
| timeoutMs | integer | | No |
#### KnowledgeFSResearchTaskListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSResearchTaskPartialListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSResearchTaskPartialResponse](#knowledgefsresearchtaskpartialresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSResearchTaskPartialResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | No |
| evidence_bundle | object | | Yes |
| knowledge_space_id | string | | Yes |
| research_task_job_id | string | | Yes |
| sequence | integer | | Yes |
#### KnowledgeFSResearchTaskPartialsQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 25 | | No |
#### KnowledgeFSResearchTaskPlanBudgetResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| budget_usd | number | | No |
| exceeds_budget | boolean | | Yes |
| remaining_budget_usd | number | | No |
#### KnowledgeFSResearchTaskPlanPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| budgetUsd | number | | No |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | | No |
| query | string | | No |
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
| topK | integer | | No |
#### KnowledgeFSResearchTaskPlanResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| budget | [KnowledgeFSResearchTaskPlanBudgetResponse](#knowledgefsresearchtaskplanbudgetresponse) | | Yes |
| estimates | object | | Yes |
| knowledge_space_id | string | | Yes |
| query | string | | Yes |
| query_images | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
| retrieval_plan | [KnowledgeFSResearchTaskRetrievalPlanResponse](#knowledgefsresearchtaskretrievalplanresponse) | | Yes |
| steps | [ object ] | | Yes |
| strategy_version | string | | Yes |
#### KnowledgeFSResearchTaskResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| budget_usd | number | | No |
| completed_at | number | | No |
| cost | object | | Yes |
| created_at | number | | Yes |
| error | string | | No |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| limits | [KnowledgeFSResearchTaskLimits](#knowledgefsresearchtasklimits) | | No |
| metadata | object | | Yes |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | | No |
| query | string | | Yes |
| query_images | [ [KnowledgeFSQueryImageResponse](#knowledgefsqueryimageresponse) ] | | No |
| stage | string,
**Available values:** "analyzing", "canceled", "completed", "failed", "generating", "paused", "planning", "queued", "retrieving" | *Enum:* `"analyzing"`, `"canceled"`, `"completed"`, `"failed"`, `"generating"`, `"paused"`, `"planning"`, `"queued"`, `"retrieving"` | Yes |
| top_k | integer | | No |
| updated_at | number | | Yes |
#### KnowledgeFSResearchTaskRetrievalPlanResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dense_top_k | integer | | Yes |
| fts_top_k | integer | | Yes |
| fusion_limit | integer | | Yes |
| query_language | string,
**Available values:** "cjk", "latin", "mixed-cjk-latin", "other" | *Enum:* `"cjk"`, `"latin"`, `"mixed-cjk-latin"`, `"other"` | Yes |
| requested_mode | string,
**Available values:** "auto", "deep", "fast", "research" | *Enum:* `"auto"`, `"deep"`, `"fast"`, `"research"` | Yes |
| rerank_candidate_limit | integer | | Yes |
| resolved_mode | string,
**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
| strategy_version | string | | Yes |
| top_k | integer | | Yes |
#### KnowledgeFSResolvedDocumentReferenceResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_id | string | | Yes |
| revision | integer | | Yes |
#### KnowledgeFSRetrievalSettingsResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default_mode | string,
**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
| reasoning_model | [KnowledgeFSEmbeddingSettingsResponse](#knowledgefsembeddingsettingsresponse) | | Yes |
| rerank | [KnowledgeFSProductRerankProfile](#knowledgefsproductrerankprofile) | | Yes |
| revision | integer | | No |
| score_threshold | [KnowledgeFSProductScoreThreshold](#knowledgefsproductscorethreshold) | | Yes |
| top_k | integer | | Yes |
#### KnowledgeFSSemanticEnrichmentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| error_code | string | | No |
| error_message | string | | No |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| nodes_completed | integer | | Yes |
| nodes_total | integer | | No |
| provider_calls | integer | | No |
| provider_calls_maximum | integer | | No |
| state | string,
**Available values:** "disabled", "failed", "not_scheduled", "pending", "ready", "running" | *Enum:* `"disabled"`, `"failed"`, `"not_scheduled"`, `"pending"`, `"ready"`, `"running"` | Yes |
| updated_at | string | | No |
#### KnowledgeFSServiceQueryImageUploadResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| byte_size | integer | | Yes |
| mime_type | string | | Yes |
| upload_file_id | string | | Yes |
#### KnowledgeFSServiceSourceConnectionCreatePayload
Dify owns datasource secrets; clients supply an opaque binding in configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authKind | string,
**Default:** endpoint | | No |
| configuration | object | | No |
| credentials | object | | No |
| name | string | | Yes |
| providerId | string | | Yes |
#### KnowledgeFSServiceSourceCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| connectionId | string | | No |
| metadata | object | | No |
| name | string | | Yes |
| permissionScope | [ string ] | | No |
| status | string,
**Available values:** "active", "disabled", "error", "syncing" | | No |
| type | string,
**Available values:** "connector", "object-storage", "upload", "web" | *Enum:* `"connector"`, `"object-storage"`, `"upload"`, `"web"` | Yes |
| uri | string | | Yes |
#### KnowledgeFSServiceSourceUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedVersion | integer | | No |
| metadata | object | | No |
| name | string | | No |
| providerParameters | object | | No |
| status | string,
**Available values:** "active", "disabled", "error", "syncing" | | No |
| syncAfterUpdate | boolean | | No |
| uri | string | | No |
#### KnowledgeFSSettingsPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding | [KnowledgeFSProfileModelSelection](#knowledgefsprofilemodelselection) | | No |
| expectedRevision | integer | | Yes |
| retrieval | [KnowledgeFSProductRetrievalProfile](#knowledgefsproductretrievalprofile) | | No |
#### KnowledgeFSSettingsResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| active_profile_available | boolean | | Yes |
| active_profile_revisions | [KnowledgeFSActiveProfileRevisions](#knowledgefsactiveprofilerevisions) | | Yes |
| capabilities | [KnowledgeFSReadinessCapabilities](#knowledgefsreadinesscapabilities) | | Yes |
| configuration_state | string,
**Available values:** "active", "pending-validation", "setup-required", "validation-failed" | *Enum:* `"active"`, `"pending-validation"`, `"setup-required"`, `"validation-failed"` | Yes |
| embedding | [KnowledgeFSEmbeddingSettingsResponse](#knowledgefsembeddingsettingsresponse) | | Yes |
| issues | [ [KnowledgeFSReadinessIssue](#knowledgefsreadinessissue) ] | | Yes |
| retrieval | [KnowledgeFSRetrievalSettingsResponse](#knowledgefsretrievalsettingsresponse) | | Yes |
| revision | integer | | Yes |
#### KnowledgeFSSettingsUpdateResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| migration | [KnowledgeFSProfileMigrationResponse](#knowledgefsprofilemigrationresponse) | | No |
| settings | [KnowledgeFSSettingsResponse](#knowledgefssettingsresponse) | | Yes |
#### KnowledgeFSSourceConnectionListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
#### KnowledgeFSSourceConnectionListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSSourceConnectionResponse](#knowledgefssourceconnectionresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSSourceConnectionRefreshPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedVersion | integer | | Yes |
#### KnowledgeFSSourceConnectionResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auth_kind | string,
**Available values:** "api-key", "endpoint", "oauth2" | *Enum:* `"api-key"`, `"endpoint"`, `"oauth2"` | Yes |
| configuration | object | | Yes |
| created_at | dateTime | | Yes |
| error_code | string | | No |
| expires_at | string | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| name | string | | Yes |
| provider_id | string | | Yes |
| scopes | [ string ] | | Yes |
| status | string,
**Available values:** "active", "error", "expired", "provisioning", "revoked" | *Enum:* `"active"`, `"error"`, `"expired"`, `"provisioning"`, `"revoked"` | Yes |
| updated_at | dateTime | | Yes |
| version | integer | | Yes |
#### KnowledgeFSSourceCrawlResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| completed | integer | | No |
| failed | integer | | No |
| imported | integer | | No |
| pages | [ [KnowledgeFSCrawledPageResponse](#knowledgefscrawledpageresponse) ] | | Yes |
| replaced | integer | | No |
| skipped | integer | | No |
| status | string | | No |
| total | integer | | No |
#### KnowledgeFSSourceCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| connectionId | string | | No |
| credentials | object | | No |
| metadata | object | | No |
| name | string | | Yes |
| permissionScope | [ string ] | | No |
| status | string,
**Available values:** "active", "disabled", "error", "syncing" | | No |
| type | string,
**Available values:** "connector", "object-storage", "upload", "web" | *Enum:* `"connector"`, `"object-storage"`, `"upload"`, `"web"` | Yes |
| uri | string | | Yes |
#### KnowledgeFSSourceCredentialTestResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string,
**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | | No |
| error | string | | No |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| valid | boolean | | Yes |
#### KnowledgeFSSourceDeletePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedRevision | integer | | Yes |
#### KnowledgeFSSourceDeleteQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documents | string,
**Available values:** "cascade", "keep",
**Default:** cascade | *Enum:* `"cascade"`, `"keep"` | No |
#### KnowledgeFSSourceEditOnlineDocumentSelectionPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| items | [ [KnowledgeFSOnlineDocumentWorkflowImportItemPayload](#knowledgefsonlinedocumentworkflowimportitempayload) ] | | Yes |
| kind | string | | Yes |
#### KnowledgeFSSourceEditOnlineDriveSelectionPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| items | [ [KnowledgeFSOnlineDriveWorkflowImportItemPayload](#knowledgefsonlinedriveworkflowimportitempayload) ] | | Yes |
| kind | string | | Yes |
#### KnowledgeFSSourceEditSyncPolicyPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customIntervalSeconds | integer | | No |
| enabled | boolean | | Yes |
| mode | string,
**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
#### KnowledgeFSSourceEditWebsiteSelectionPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| kind | string | | Yes |
| sourceUrls | [ string ] | | Yes |
#### KnowledgeFSSourceFileBucketResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| bucket | string | | No |
| continuation_token | string | | No |
| files | [ [KnowledgeFSSourceFileResponse](#knowledgefssourcefileresponse) ] | | Yes |
| is_truncated | boolean | | No |
#### KnowledgeFSSourceFileResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| name | string | | Yes |
| size | number | | No |
| type | string | | Yes |
#### KnowledgeFSSourceFilesQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| bucket | string | | No |
| continuationToken | string | | No |
| maxKeys | integer | | No |
| prefix | string | | No |
#### KnowledgeFSSourceFilesResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| buckets | [ [KnowledgeFSSourceFileBucketResponse](#knowledgefssourcefilebucketresponse) ] | | Yes |
#### KnowledgeFSSourceImportConfigurationPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedVersion | integer | | Yes |
| metadata | object | | No |
| name | string | | No |
| providerParameters | object | | No |
| status | string,
**Available values:** "active", "disabled", "error", "syncing" | | No |
| uri | string | | No |
#### KnowledgeFSSourceImportFailureResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string,
**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | *Enum:* `"DOCUMENT_COMPILATION_FAILED"`, `"DOCUMENT_COMPILATION_LEASE_LOST"`, `"DOCUMENT_COMPILATION_PROFILE_CHANGED"`, `"DOCUMENT_COMPILATION_RETRYABLE"`, `"DOCUMENT_COUNT_QUOTA_EXCEEDED"`, `"DOCUMENT_COUNT_QUOTA_UNAVAILABLE"`, `"DOCUMENT_DISABLED"`, `"DOCUMENT_PARSER_INPUT_INVALID"`, `"DOCUMENT_PARSER_NOT_CONFIGURED"`, `"DOCUMENT_PARSER_RATE_LIMITED"`, `"DOCUMENT_PARSER_RESPONSE_INVALID"`, `"DOCUMENT_PARSER_TIMEOUT"`, `"DOCUMENT_PARSER_UNAVAILABLE"`, `"DOCUMENT_PARSER_UNSUPPORTED_TYPE"`, `"DOCUMENT_PDF_RENDER_FAILED"`, `"DURABLE_DELETION_IDEMPOTENCY_CONFLICT"`, `"EMBEDDING_DIMENSION_INVALID"`, `"EMBEDDING_DIMENSION_UNSUPPORTED"`, `"EXECUTION_ATTEMPTS_EXHAUSTED"`, `"KNOWLEDGE_FS_ACCESS_DENIED"`, `"KNOWLEDGE_FS_CONFLICT"`, `"KNOWLEDGE_FS_INTERNAL_ERROR"`, `"KNOWLEDGE_FS_INVALID_REQUEST"`, `"KNOWLEDGE_FS_NOT_FOUND"`, `"KNOWLEDGE_FS_RATE_LIMITED"`, `"KNOWLEDGE_FS_TIMEOUT"`, `"KNOWLEDGE_FS_UNAVAILABLE"`, `"KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND"`, `"KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS"`, `"KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT"`, `"LOGICAL_DOCUMENT_CAS_CONFLICT"`, `"MODEL_CAPABILITY_MISMATCH"`, `"MODEL_CONFIGURATION_STALE"`, `"MODEL_CREDENTIAL_INVALID"`, `"MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE"`, `"MODEL_IDENTITY_MISMATCH"`, `"MODEL_PREFLIGHT_CANCELED"`, `"MODEL_PREFLIGHT_FAILED"`, `"MODEL_PREFLIGHT_TIMEOUT"`, `"MODEL_PREFLIGHT_UNAVAILABLE"`, `"MODEL_PROFILE_ACTIVATION_INCOMPLETE"`, `"MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED"`, `"MODEL_RUNTIME_CONTEXT_LIMIT"`, `"MODEL_RUNTIME_FAILED"`, `"MODEL_RUNTIME_OUTPUT_LIMIT"`, `"MODEL_RUNTIME_RESPONSE_INVALID"`, `"MODEL_RUNTIME_TIMEOUT"`, `"MODEL_RUNTIME_UNAVAILABLE"`, `"MODEL_SELECTION_NOT_FOUND"`, `"RESEARCH_TASK_CAPABILITY_REVOKED"`, `"RESEARCH_TASK_DISPATCH_DEAD"`, `"RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED"`, `"RESEARCH_TASK_FAILED"`, `"RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID"`, `"RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID"`, `"RETRIEVAL_DELETION_IN_PROGRESS"`, `"RETRIEVAL_EXECUTION_LEASE_LOST"`, `"SOURCE_BULK_ACTION_FAILED"`, `"SOURCE_CONNECTION_UNAVAILABLE"`, `"SOURCE_CRAWL_PAGE_NOT_FOUND"`, `"SOURCE_CRAWL_PROVIDER_UNAVAILABLE"`, `"SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED"`, `"SOURCE_CREDENTIAL_CONFIG_INVALID"`, `"SOURCE_CREDENTIAL_MUTATION_FAILED"`, `"SOURCE_CREDENTIAL_TEST_FAILED"`, `"SOURCE_CREDENTIAL_UNAVAILABLE"`, `"SOURCE_DOCUMENT_COMPILATION_FAILED"`, `"SOURCE_DOCUMENT_MATERIALIZATION_FAILED"`, `"SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED"`, `"SOURCE_IMPORT_PARTIAL_FAILURE"`, `"SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID"`, `"SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_UNAVAILABLE"`, `"SOURCE_ONLINE_DRIVE_CONFIG_INVALID"`, `"SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED"`, `"SOURCE_ONLINE_DRIVE_IMPORT_FAILED"`, `"SOURCE_ONLINE_DRIVE_REQUEST_FAILED"`, `"SOURCE_ONLINE_DRIVE_UNAVAILABLE"`, `"SOURCE_OPERATION_FAILED"`, `"SOURCE_PROVIDER_REJECTED"`, `"SOURCE_PROVIDER_TIMEOUT"`, `"SOURCE_PROVIDER_UNAVAILABLE"`, `"SOURCE_SECRET_INTEGRITY_FAILED"`, `"SOURCE_SECRET_REF_CONFLICT"`, `"SOURCE_SYNC_FAILED"`, `"SOURCE_SYNC_SELECTION_MISMATCH"`, `"SOURCE_VERSION_CONFLICT"`, `"SOURCE_WEBSITE_CRAWL_CONFIG_INVALID"`, `"SOURCE_WEBSITE_CRAWL_FAILED"`, `"SOURCE_WORKFLOW_CONTENT_MISSING"`, `"SOURCE_WORKFLOW_CONTENT_TOO_LARGE"`, `"SOURCE_WORKFLOW_EXTERNAL_TIMEOUT"`, `"SOURCE_WORKFLOW_FAILED"`, `"UPLOAD_INITIALIZATION_FAILED"`, `"UPLOAD_INTEGRITY_MISMATCH"`, `"VECTOR_SPACE_QUOTA_EXCEEDED"`, `"VECTOR_SPACE_QUOTA_UNAVAILABLE"` | Yes |
| error | string | | Yes |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| filename | string | | Yes |
#### KnowledgeFSSourceImportFilePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| bucket | string | | No |
| id | string | | Yes |
| mimeType | string | | No |
| name | string | | Yes |
#### KnowledgeFSSourceImportFilesPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| files | [ [KnowledgeFSSourceImportFilePayload](#knowledgefssourceimportfilepayload) ] | | Yes |
#### KnowledgeFSSourceImportPagePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastEditedTime | string | | No |
| name | string | | No |
| pageId | string | | Yes |
| type | string | | Yes |
| workspaceId | string | | Yes |
#### KnowledgeFSSourceImportPagesPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pages | [ [KnowledgeFSSourceImportPagePayload](#knowledgefssourceimportpagepayload) ] | | Yes |
#### KnowledgeFSSourceImportResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documents | [ [KnowledgeFSSourceImportedDocumentResponse](#knowledgefssourceimporteddocumentresponse) ] | | Yes |
| failed | [ [KnowledgeFSSourceImportFailureResponse](#knowledgefssourceimportfailureresponse) ] | | Yes |
| skipped | [ string ] | | Yes |
#### KnowledgeFSSourceImportedDocumentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| document_asset_id | string | | Yes |
| filename | string | | Yes |
#### KnowledgeFSSourceListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSSourceResponse](#knowledgefssourceresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSSourcePageResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| has_children | boolean | | No |
| last_edited_time | string | | No |
| page_id | string | | Yes |
| page_name | string | | Yes |
| parent_id | string | | No |
| type | string | | Yes |
#### KnowledgeFSSourcePagesQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
| parentId | string | | No |
| view | string | | No |
#### KnowledgeFSSourcePagesResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| next_cursor | string | | No |
| workspaces | [ [KnowledgeFSSourceWorkspacePagesResponse](#knowledgefssourceworkspacepagesresponse) ] | | Yes |
#### KnowledgeFSSourceProviderFieldResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | No |
| format | string,
**Available values:** "password", "uri" | | No |
| name | string | | Yes |
| required | boolean | | Yes |
| secret | boolean | | Yes |
| type | string,
**Available values:** "boolean", "integer", "string" | *Enum:* `"boolean"`, `"integer"`, `"string"` | Yes |
#### KnowledgeFSSourceProviderListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSSourceProviderResponse](#knowledgefssourceproviderresponse) ] | | Yes |
#### KnowledgeFSSourceProviderResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auth_kinds | [ string,
**Available values:** "api-key", "endpoint", "oauth2" ] | | Yes |
| available | boolean | | Yes |
| capabilities | [ string,
**Available values:** "online-document", "online-drive", "website-crawl" ] | | Yes |
| configuration | [ [KnowledgeFSSourceProviderFieldResponse](#knowledgefssourceproviderfieldresponse) ] | | Yes |
| display_name | string | | Yes |
| id | string | | Yes |
| unavailable_reason | string | | No |
#### KnowledgeFSSourceResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| connection_id | string | | No |
| created_at | dateTime | | Yes |
| credential_configured | boolean | | No |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| last_synced_at | string | | No |
| metadata | object | | Yes |
| name | string | | Yes |
| permission_scope | [ string ] | | Yes |
| status | string,
**Available values:** "active", "disabled", "error", "syncing" | *Enum:* `"active"`, `"disabled"`, `"error"`, `"syncing"` | Yes |
| sync_policy | [KnowledgeFSSourceSyncPolicyResponse](#knowledgefssourcesyncpolicyresponse) | | No |
| sync_workflow | [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse) | | No |
| type | string,
**Available values:** "connector", "object-storage", "upload", "web" | *Enum:* `"connector"`, `"object-storage"`, `"upload"`, `"web"` | Yes |
| updated_at | dateTime | | Yes |
| uri | string | | Yes |
| version | integer | | Yes |
#### KnowledgeFSSourceSyncPolicyPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customIntervalSeconds | integer | | No |
| enabled | boolean | | Yes |
| expectedRevision | integer | | Yes |
| expectedSourceVersion | integer | | Yes |
| mode | string,
**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
#### KnowledgeFSSourceSyncPolicyResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | dateTime | | Yes |
| custom_interval_seconds | integer | | No |
| enabled | boolean | | Yes |
| expected_source_version | integer | | Yes |
| id | string | | Yes |
| knowledge_space_id | string | | Yes |
| mode | string,
**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
| next_run_at | string | | No |
| revision | integer | | Yes |
| source_id | string | | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSSourceUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expectedVersion | integer | | No |
| metadata | object | | No |
| name | string | | No |
| providerParameters | object | | No |
| selection | [KnowledgeFSSourceEditWebsiteSelectionPayload](#knowledgefssourceeditwebsiteselectionpayload)
[KnowledgeFSSourceEditOnlineDocumentSelectionPayload](#knowledgefssourceeditonlinedocumentselectionpayload)
[KnowledgeFSSourceEditOnlineDriveSelectionPayload](#knowledgefssourceeditonlinedriveselectionpayload) | | No |
| status | string,
**Available values:** "active", "disabled", "error", "syncing" | | No |
| syncAfterUpdate | boolean | | No |
| syncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
| uri | string | | No |
#### KnowledgeFSSourceWorkflowCancelPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reason | string | | No |
#### KnowledgeFSSourceWorkflowImportPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFSSourceWorkflowImportPayload | [KnowledgeFSOnlineDocumentWorkflowImportPayload](#knowledgefsonlinedocumentworkflowimportpayload)
[KnowledgeFSOnlineDriveWorkflowImportPayload](#knowledgefsonlinedriveworkflowimportpayload) | | |
#### KnowledgeFSSourceWorkflowListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 50 | | No |
| sourceId | string | | No |
#### KnowledgeFSSourceWorkflowListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSSourceWorkflowResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| canceled_at | string | | No |
| checkpoint | string | | Yes |
| completed_at | string | | No |
| created_at | dateTime | | Yes |
| cursor | string | | No |
| execution_attempts | integer | | Yes |
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
| id | string | | Yes |
| kind | string | | Yes |
| knowledge_space_id | string | | Yes |
| last_error_code | string,
**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | | No |
| max_execution_attempts | integer | | Yes |
| progress_completed | integer | | Yes |
| progress_failed | integer | | Yes |
| progress_skipped | integer | | Yes |
| progress_total | integer | | No |
| source_id | string | | No |
| state | string | | Yes |
| updated_at | dateTime | | Yes |
#### KnowledgeFSSourceWorkspacePagesResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pages | [ [KnowledgeFSSourcePageResponse](#knowledgefssourcepageresponse) ] | | Yes |
| total | integer | | No |
| workspace_id | string | | No |
| workspace_name | string | | No |
#### KnowledgeFSTraceEntriesQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cursor | string | | No |
| limit | integer,
**Default:** 100 | | No |
#### KnowledgeFSTraceEntryListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| consistency_class | string | | No |
| data | [ [KnowledgeFSTraceEntryResponse](#knowledgefstraceentryresponse) ] | | Yes |
| next_cursor | string | | No |
| path | string | | Yes |
| preview | boolean | | No |
| truncated | boolean | | Yes |
#### KnowledgeFSTraceEntryResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| kind | string,
**Available values:** "directory", "resource" | *Enum:* `"directory"`, `"resource"` | Yes |
| metadata | object | | Yes |
| name | string | | Yes |
| path | string | | Yes |
| resource_type | string | | No |
| target_id | string | | No |
| version | integer | | No |
#### KnowledgeFSTraceListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [KnowledgeFSTraceResponse](#knowledgefstraceresponse) ] | | Yes |
| next_cursor | string | | No |
#### KnowledgeFSTraceProfileResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model | string | | No |
| embedding_vector_space_id | string | | No |
| projection_publication_id | string | | No |
| projection_version | integer | | No |
| reasoning_model | string | | No |
| rerank_model | string | | No |
| retrieval_profile_revision | integer | | No |
#### KnowledgeFSTraceResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| completed | boolean | | Yes |
| created_at | dateTime | | Yes |
| duration_ms | integer | | No |
| evidence_bundle_id | string | | No |
| evidence_state | string | | No |
| final_score | number | | No |
| id | string | | Yes |
| mode | string,
**Available values:** "auto", "deep", "fast", "research" | *Enum:* `"auto"`, `"deep"`, `"fast"`, `"research"` | Yes |
| open_bad_case_id | string | | No |
| profile | [KnowledgeFSTraceProfileResponse](#knowledgefstraceprofileresponse) | | Yes |
| query | string | | Yes |
| query_images | [ [KnowledgeFSQueryImageResponse](#knowledgefsqueryimageresponse) ] | | No |
| result_count | integer | | Yes |
| scores | [KnowledgeFSTraceScoresResponse](#knowledgefstracescoresresponse) | | Yes |
| source | [KnowledgeFSTraceSource](#knowledgefstracesource) | | No |
| stages | [ [KnowledgeFSTraceStageResponse](#knowledgefstracestageresponse) ] | | Yes |
#### KnowledgeFSTraceScoresResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| final | number | | No |
| rerank | number | | No |
| retrieval | number | | No |
#### KnowledgeFSTraceSource
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFSTraceSource | string | | |
#### KnowledgeFSTraceStageResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| candidate_count | integer | | No |
| name | string | | Yes |
| status | string,
**Available values:** "error", "ok", "skipped" | *Enum:* `"error"`, `"ok"`, `"skipped"` | Yes |
#### KnowledgeFsAccessDeniedError
Agent Knowledge Base operation is not allowed.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsAccessDeniedError | | Agent Knowledge Base operation is not allowed. | |
#### KnowledgeFsCitation
Immutable evidence identity; no signed URLs, tokens or storage keys.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| artifact_hash | string | | Yes |
| control_space_id | string | | Yes |
| document_asset_id | string | | Yes |
| document_title | string | | No |
| document_version | integer | | No |
| end_offset | integer | | No |
| id | string | | Yes |
| node_id | string | | Yes |
| page_number | integer | | No |
| parse_artifact_id | string | | No |
| section_path | [ string ] | | No |
| space_name | string | | Yes |
| start_offset | integer | | No |
#### KnowledgeFsConflictError
Agent Knowledge Base operation conflicts with the current resource state.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsConflictError | | Agent Knowledge Base operation conflicts with the current resource state. | |
#### KnowledgeFsInvalidCredentialError
Invalid Agent Knowledge Base service credential.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsInvalidCredentialError | | Invalid Agent Knowledge Base service credential. | |
#### KnowledgeFsInvalidRequestError
Agent Knowledge Base request is invalid.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsInvalidRequestError | | Agent Knowledge Base request is invalid. | |
#### KnowledgeFsOperationUnavailableError
Agent Knowledge Base operation is not available.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsOperationUnavailableError | | Agent Knowledge Base operation is not available. | |
#### KnowledgeFsRateLimitExceededError
Agent Knowledge Base request rate limit exceeded.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsRateLimitExceededError | | Agent Knowledge Base request rate limit exceeded. | |
#### KnowledgeFsRequestRejectedError
Agent Knowledge Base request was rejected.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsRequestRejectedError | | Agent Knowledge Base request was rejected. | |
#### KnowledgeFsRequestTooLargeError
Agent Knowledge Base request is too large.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsRequestTooLargeError | | Agent Knowledge Base request is too large. | |
#### KnowledgeFsResourceNotFoundError
Agent Knowledge Base resource was not found.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsResourceNotFoundError | | Agent Knowledge Base resource was not found. | |
#### KnowledgeFsUpstreamUnavailableError
Agent Knowledge Base is unavailable.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeFsUpstreamUnavailableError | | Agent Knowledge Base is unavailable. | |
#### KnowledgeTagListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| KnowledgeTagListResponse | array | | |
#### KnowledgeTagResponse
| Name | Type | Description | 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,
**Available values:** "dislike", "like" | 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,
**Available values:** "dislike", "like" | Feedback rating. Set to `null` to revoke previously submitted feedback. | No |
| user | string | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | Yes |
#### MessageFeedbackRatingRequiredError
A rating is required when there is no existing feedback to remove.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MessageFeedbackRatingRequiredError | | A rating is required when there is no existing feedback to remove. | |
#### MessageFile
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| belongs_to | string | | No |
| filename | string | | Yes |
| id | string (uuid) | | Yes |
| mime_type | string | | No |
| size | integer | | No |
| transfer_method | string | | Yes |
| type | string | | Yes |
| upload_file_id | string | | No |
| url | string | | No |
#### MessageInfiniteScrollPagination
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [MessageListItem](#messagelistitem) ] | | Yes |
| has_more | boolean | | Yes |
| limit | integer | | Yes |
#### MessageListItem
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_thoughts | [ [AgentThought](#agentthought) ] | | Yes |
| answer | string | | Yes |
| answer_tokens | integer | | No |
| conversation_id | string (uuid) | | Yes |
| created_at | integer | | No |
| currency | string | | No |
| error | string | | No |
| extra_contents | [ [HumanInputContent](#humaninputcontent) ] | | Yes |
| feedback | [SimpleFeedback](#simplefeedback) | | No |
| id | string (uuid) | | Yes |
| inputs | object | | Yes |
| message_files | [ [MessageFile](#messagefile) ] | | Yes |
| message_tokens | integer | | No |
| parent_message_id | string | | No |
| provider_response_latency | float | | No |
| query | string | | Yes |
| retriever_resources | [ [RetrieverResource](#retrieverresource) ] | | Yes |
| status | string | | Yes |
| total_price | string | | No |
| total_tokens | integer | | 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 (uuid) | Metadata field ID. | Yes |
| name | string | Metadata field name. | Yes |
| value | string
integer
number | Metadata value. Can be a string, number, or `null`. | No |
#### MetadataFilteringCondition
Metadata Filtering Condition.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conditions | [ [Condition](#condition) ] | List of metadata conditions to evaluate. | No |
| logical_operator | string,
**Available values:** "and", "or" | How to combine multiple conditions. | No |
#### MetadataOperationData
Metadata operation data
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| operation_data | [ [DocumentMetadataOperation](#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 |
#### ModelCurrentlyNotSupportError
Dify Hosted OpenAI trial currently not support the GPT-4 model.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ModelCurrentlyNotSupportError | | Dify Hosted OpenAI trial currently not support the GPT-4 model. | |
#### ModelFeature
Enum class for llm feature.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ModelFeature | string | Enum class for llm feature. | |
#### ModelPropertyKey
Enum class for model property key.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ModelPropertyKey | string | Enum class for model property key. | |
#### ModelRuntimeI18nObject
Model class for i18n object.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| en_US | string | | Yes |
| zh_Hans | string | | No |
#### 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. | |
#### NoAudioUploadedError
Please upload your audio.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NoAudioUploadedError | | Please upload your audio. | |
#### NoFileUploadedError
Please upload your file.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NoFileUploadedError | | Please upload your file. | |
#### NotChatAppError
Please check if your app mode matches the right API route.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NotChatAppError | | Please check if your app mode matches the right API route. | |
#### NotWorkflowAppError
Please check if your app mode matches the right API route.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NotWorkflowAppError | | Please check if your app mode matches the right API route. | |
#### OptionalServiceApiUserPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| user | string | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | No |
#### ParagraphInputConfig
Form input definition.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| default | [StringSource](#stringsource) | Raw default-value configuration for the paragraph input. Runtime-resolved values are exposed in the surrounding `resolved_default_values` mapping. | No |
| output_variable_name | string | | Yes |
| type | string | | No |
#### Parameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_reply | { **"enabled"**: boolean } | | Yes |
| file_upload | { **"allowed_file_extensions"**: [ string ], **"allowed_file_types"**: [ string,
**Available values:** "audio", "custom", "document", "image", "video" ], **"allowed_file_upload_methods"**: [ string,
**Available values:** "local_file", "remote_url" ], **"enabled"**: boolean, **"image"**: { **"detail"**: string, **"enabled"**: boolean, **"number_limits"**: integer, **"transfer_methods"**: [ string ] }, **"number_limits"**: integer } | | Yes |
| more_like_this | { **"enabled"**: boolean } | | Yes |
| opening_statement | | | No |
| retriever_resource | { **"enabled"**: boolean } | | Yes |
| sensitive_word_avoidance | { **"enabled"**: boolean } | | Yes |
| show_thoughts | { **"enabled"**: boolean } | | No |
| speech_to_text | { **"enabled"**: boolean } | | Yes |
| suggested_questions | [ string ] | | Yes |
| suggested_questions_after_answer | { **"enabled"**: boolean } | | Yes |
| system_parameters | [SystemParameters](#systemparameters) | System-level parameter limits. | Yes |
| text_to_speech | { **"autoPlay"**: string, **"enabled"**: boolean, **"language"**: string, **"voice"**: string } | | Yes |
| user_input_form | [ object ] | | Yes |
#### PermissionEnum
Shared permission levels for resources (datasets, credentials, etc.)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PermissionEnum | string | Shared permission levels for resources (datasets, credentials, etc.) | |
#### PipelineDataset
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chunk_structure | string | | Yes |
| description | string | knowledge dataset description | No |
| id | string | | Yes |
| name | string | | Yes |
#### PipelineDocument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data_source_info | object | | No |
| data_source_type | string | | Yes |
| enabled | boolean | | Yes |
| error | string | | No |
| id | string | | Yes |
| indexing_status | string | | Yes |
| name | string | | Yes |
| position | integer | | Yes |
#### PipelineRunApiEntity
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| datasource_info_list | [ object
object
object
object ] | 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 for draft runs. Use `streaming` for SSE or `blocking` for JSON. Published runs are queued and always return batch metadata as JSON.
*Enum:* `"blocking"`, `"streaming"` | Yes |
| start_node_id | string | ID of the datasource node where the run starts. | Yes |
#### PipelineRunError
An error occurred while running the pipeline.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PipelineRunError | | An error occurred while running the pipeline. | |
#### PipelineRunJsonResponse
JSON result for published runs and draft runs using `response_mode: blocking`.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PipelineRunJsonResponse | [PublishedPipelineRunResponse](#publishedpipelinerunresponse)
[WorkflowBlockingResponse](#workflowblockingresponse) | JSON result for published runs and draft runs using `response_mode: blocking`. | |
#### PipelineUploadFileResponse
| Name | Type | Description | 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 | [PreProcessingRuleKey](#preprocessingrulekey) | Rule identifier. | Yes |
#### PreProcessingRuleKey
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PreProcessingRuleKey | string | | |
#### ProcessRule
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mode | [ProcessRuleMode](#processrulemode) | `automatic` uses built-in rules, `custom` allows manual configuration, `hierarchical` enables parent-child chunk structure (use with `doc_form: hierarchical_model`). | Yes |
| rules | [Rule](#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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| deprecated | boolean | | No |
| features | [ [ModelFeature](#modelfeature) ] | | No |
| fetch_from | [FetchFrom](#fetchfrom) | Where the model definition comes from. `predefined-model` for built-in models, `customizable-model` for user-configured models. | Yes |
| has_invalid_load_balancing_configs | boolean | | No |
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | Localized display name of the model. | Yes |
| load_balancing_enabled | boolean | | No |
| model | string | | Yes |
| model_properties | object | | Yes |
| model_type | [ModelType](#modeltype) | Type of the model, matching the `model_type` path parameter. | Yes |
| status | [ModelStatus](#modelstatus) | Model availability status. `active` when ready to use. | Yes |
#### ProviderNotInitializeError
No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProviderNotInitializeError | | No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. | |
#### ProviderNotSupportSpeechToTextError
Provider not support speech to text.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProviderNotSupportSpeechToTextError | | Provider not support speech to text. | |
#### ProviderQuotaExceededError
Your quota for Dify Hosted OpenAI has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProviderQuotaExceededError | | Your quota for Dify Hosted OpenAI has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials. | |
#### ProviderWithModelsListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [ProviderWithModelsResponse](#providerwithmodelsresponse) ] | | Yes |
#### ProviderWithModelsResponse
Model class for provider with models response.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | Localized display name of the provider. | Yes |
| models | [ [ProviderModelWithStatusEntity](#providermodelwithstatusentity) ] | | Yes |
| provider | string | | Yes |
| status | [CustomConfigurationStatus](#customconfigurationstatus) | Provider status. `active` when credentials are configured and valid. | Yes |
| tenant_id | string | | Yes |
#### PublishedPipelineRunResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| batch | string | | Yes |
| dataset | [PipelineDataset](#pipelinedataset) | | Yes |
| documents | [ [PipelineDocument](#pipelinedocument) ] | | Yes |
#### RateLimitError
Rate Limit Error
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RateLimitError | | Rate Limit Error | |
#### 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](#metadatafilteringcondition) | Restrict retrieval to chunks whose document metadata matches the given conditions. Conditions are evaluated server-side against document metadata fields. | No |
| reranking_enable | boolean | Whether reranking is enabled. | Yes |
| reranking_mode | string,
**Available values:** "reranking_model", "weighted_score" | Reranking mode. Required when `reranking_enable` is `true`. | No |
| reranking_model | [RerankingModel](#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](#retrievalmethod) | Search method used for retrieval. | Yes |
| top_k | integer | Maximum number of results to return. | Yes |
| weights | [WeightModel](#weightmodel) | Weight configuration for hybrid search. | No |
#### RetrieverResource
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | No |
| created_at | integer | | No |
| data_source_type | string | | No |
| dataset_id | string | | No |
| dataset_name | string | | No |
| doc_metadata | object | | No |
| document_asset_id | string | | No |
| document_id | string | | No |
| document_name | string | | No |
| document_revision | integer | | No |
| document_version | integer | | No |
| files | [ object ] | | No |
| hit_count | integer | | No |
| id | string (uuid) | | No |
| index_node_hash | string | | No |
| knowledge_fs_citation | [KnowledgeFsCitation](#knowledgefscitation) | | No |
| message_id | string (uuid) | | No |
| page | integer | | No |
| position | integer | | Yes |
| retriever_from | string | | No |
| score | number | | No |
| segment_id | string | | No |
| segment_position | integer | | No |
| summary | string | | No |
| title | string | | No |
| word_count | integer | | No |
#### Rule
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| parent_mode | string,
**Available values:** "full-doc", "paragraph" | Parent-child segmentation mode. | No |
| pre_processing_rules | [ [PreProcessingRule](#preprocessingrule) ] | Pre-processing rules to apply before segmentation. | No |
| segmentation | [Segmentation](#segmentation) | Parent chunk segmentation settings. | No |
| subchunk_segmentation | [Segmentation](#segmentation) | Child chunk segmentation settings. | No |
#### ScopedTaskStopPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| user | string | End-user identifier, defined by your app and unique within it. Send the same `user` value used for the original generation request. See [End User Identity](/api-reference/guides/end-user-identity). | Yes |
#### SegmentAttachmentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| extension | string | | Yes |
| id | string | | Yes |
| mime_type | string | | Yes |
| name | string | | Yes |
| size | integer | | Yes |
| source_url | string | | Yes |
#### 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](#segmentresponse) ] | | Yes |
| doc_form | string | | Yes |
#### SegmentCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| segments | [ [SegmentCreateItemPayload](#segmentcreateitempayload) ] | Array of chunk objects to create. | Yes |
#### SegmentDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [SegmentResponse](#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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [SegmentResponse](#segmentresponse) ] | | Yes |
| doc_form | string | | Yes |
| has_more | boolean | | Yes |
| limit | integer | | Yes |
| page | integer | | Yes |
| total | integer | | Yes |
#### SegmentResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| answer | string | | Yes |
| attachments | [ [SegmentAttachmentResponse](#segmentattachmentresponse) ] | | Yes |
| child_chunks | [ [ChildChunkResponse](#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,
**Available values:** "completed", "error", "indexing", "paused", "re_segment", "waiting" | *Enum:* `"completed"`, `"error"`, `"indexing"`, `"paused"`, `"re_segment"`, `"waiting"` | 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](#segmentupdateargs) | Chunk data to update. | 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 | Description | Required |
| ---- | ---- | ----------- | -------- |
| option_source | [StringListSource](#stringlistsource) | Source of options for `select` inputs. Present only when `type` is `select`. | Yes |
| output_variable_name | string | | Yes |
| type | string | | No |
#### SimpleAccountResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
| id | string | | Yes |
| name | string | | Yes |
#### SimpleConversation
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer | | No |
| id | string (uuid) | | Yes |
| inputs | object | | Yes |
| introduction | string | | No |
| name | string | | Yes |
| status | string | | Yes |
| updated_at | integer | | No |
#### SimpleEndUser
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| is_anonymous | boolean | | Yes |
| session_id | string | | No |
| type | string | | Yes |
#### SimpleFeedback
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| rating | string | | No |
#### SimpleResultResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| result | string | Operation result. | Yes |
#### SimpleResultStringListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ string ] | | Yes |
| result | string | | Yes |
#### Site
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| chat_color_theme | string | | No |
| chat_color_theme_inverted | boolean | | Yes |
| copyright | string | | No |
| custom_disclaimer | string | | No |
| default_language | string | | Yes |
| description | string | | No |
| icon | string | | No |
| icon_background | string | | No |
| icon_type | string | | No |
| icon_url | string | | Yes |
| input_placeholder | string | | No |
| privacy_policy | string | | No |
| show_workflow_steps | boolean | | Yes |
| title | string | | Yes |
| use_icon_as_answer_icon | boolean | | Yes |
#### SpeechToTextDisabledError
Speech to text is disabled.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SpeechToTextDisabledError | | Speech to text is disabled. | |
#### StringListSource
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| selector | [ string ] | Variable reference path when `type` is `variable`. | No |
| type | [ValueSourceType](#valuesourcetype) | Origin of the options. `constant` means `value` lists the options literally; `variable` means `selector` points to an `array[string]` workflow variable that provides them. | Yes |
| value | [ string ] | Literal option list when `type` is `constant`. | No |
#### StringSource
Default configuration for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| selector | [ string ] | | No |
| type | [ValueSourceType](#valuesourcetype) | | Yes |
| value | string | | No |
#### SystemParameters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| audio_file_size_limit | integer | | Yes |
| file_size_limit | integer | | Yes |
| image_file_size_limit | integer | | Yes |
| video_file_size_limit | integer | | Yes |
| workflow_file_upload_limit | integer | | Yes |
#### 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](/api-reference/applications/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 | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | 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](/api-reference/applications/get-app-parameters) as `text_to_speech.voice`. | No |
#### TooManyFilesError
Only one file is allowed.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TooManyFilesError | | Only one file is allowed. | |
#### ToolIcon
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| background | string | | Yes |
| content | string | | Yes |
#### TriggerWorkflowServiceModeUnavailableError
This workflow uses a trigger entry and cannot be invoked through Web App, Service API, OpenAPI, or MCP.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TriggerWorkflowServiceModeUnavailableError | | This workflow uses a trigger entry and cannot be invoked through Web App, Service API, OpenAPI, or MCP. | |
#### UnsupportedAudioTypeError
Audio type not allowed.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| UnsupportedAudioTypeError | | Audio type not allowed. | |
#### UnsupportedFileTypeError
File type not allowed.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| UnsupportedFileTypeError | | File type not allowed. | |
#### UrlResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| url | string | | Yes |
#### UserActionConfig
User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| button_style | [ButtonStyle](#buttonstyle) | | No |
| id | string | | Yes |
| title | string | | Yes |
#### ValueSourceType
ValueSourceType records whether the value comes from a static setting
in form definition, or a variable while the workflow is running.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ValueSourceType | string | ValueSourceType records whether the value comes from a static setting in form definition, or a variable while the workflow is running. | |
#### WeightKeywordSetting
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_weight | number | Weight assigned to keyword search results. | Yes |
#### WeightModel
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| keyword_setting | [WeightKeywordSetting](#weightkeywordsetting) | Keyword search weight settings. | No |
| vector_setting | [WeightVectorSetting](#weightvectorsetting) | Semantic search weight settings. | No |
| weight_type | string,
**Available values:** "customized", "keyword_first", "semantic_first" | Strategy for balancing semantic and keyword search weights. | No |
#### WeightVectorSetting
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embedding_model_name | string | Name of the embedding model used for vector search. | Yes |
| embedding_provider_name | string | Provider of the embedding model used for vector search. | Yes |
| vector_weight | number | Weight assigned to semantic vector search results. | Yes |
#### WorkflowAppLogPaginationResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [ [WorkflowAppLogPartialResponse](#workflowapplogpartialresponse) ] | | Yes |
| has_more | boolean | | Yes |
| limit | integer | | Yes |
| page | integer | | Yes |
| total | integer | | Yes |
#### WorkflowAppLogPartialResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer | | No |
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
| created_by_role | string | | No |
| created_from | string | | No |
| details | object
[ object ]
string
integer
number
boolean | | No |
| id | string (uuid) | | Yes |
| workflow_run | [WorkflowRunForLogResponse](#workflowrunforlogresponse) | | No |
#### WorkflowBlockingResponse
Blocking workflow response for a finished or paused execution.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkflowBlockingResponse | [WorkflowFinishedBlockingResponse](#workflowfinishedblockingresponse)
[WorkflowPausedBlockingResponse](#workflowpausedblockingresponse) | Blocking workflow response for a finished or paused execution. | |
#### 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 |
#### WorkflowFinishedBlockingDataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | long | | Yes |
| elapsed_time | float | | Yes |
| error | string | | Yes |
| finished_at | integer | | Yes |
| id | string (uuid) | | Yes |
| outputs | object | | Yes |
| status | string,
**Available values:** "failed", "partial-succeeded", "stopped", "succeeded" | *Enum:* `"failed"`, `"partial-succeeded"`, `"stopped"`, `"succeeded"` | Yes |
| total_steps | integer | | Yes |
| total_tokens | integer | | Yes |
| workflow_id | string (uuid) | | Yes |
#### WorkflowFinishedBlockingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [WorkflowFinishedBlockingDataResponse](#workflowfinishedblockingdataresponse) | | Yes |
| task_id | string | | Yes |
| workflow_run_id | string | | 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,
**Available values:** "failed", "stopped", "succeeded" | Filter by execution status. | No |
#### WorkflowPauseReasonResponse
Public pause reason emitted by a blocking Workflow execution.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TYPE | string | | Yes |
| actions | [ [JSONObject](#jsonobject) ] | | No |
| approval_channels | [ string ] | | No |
| display_in_ui | boolean | | No |
| expiration_time | integer | | No |
| form_content | string | | No |
| form_id | string | | No |
| form_token | string | | No |
| inputs | [ [JSONObject](#jsonobject) ] | | No |
| message | string | | No |
| node_id | string | | No |
| node_title | string | | No |
| resolved_default_values | object | | No |
#### WorkflowPausedBlockingDataResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | long | | Yes |
| elapsed_time | float | | Yes |
| error | string | | Yes |
| finished_at | integer | | Yes |
| id | string (uuid) | | Yes |
| outputs | object | | Yes |
| paused_nodes | [ string ] | | Yes |
| reasons | [ [WorkflowPauseReasonResponse](#workflowpausereasonresponse) ] | | Yes |
| status | string | | Yes |
| total_steps | integer | | Yes |
| total_tokens | integer | | Yes |
| workflow_id | string (uuid) | | Yes |
#### WorkflowPausedBlockingResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data | [WorkflowPausedBlockingDataResponse](#workflowpausedblockingdataresponse) | | Yes |
| task_id | string | | Yes |
| workflow_run_id | string | | Yes |
#### WorkflowRunForLogResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer | | No |
| elapsed_time | number
integer | | No |
| error | string | | No |
| exceptions_count | integer | | No |
| finished_at | integer | | No |
| id | string (uuid) | | 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
object
object
object ] | File list for workflow system file inputs. Available when file upload is enabled for the workflow. To attach a local file, first upload it via [Upload File](/api-reference/files/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](/api-reference/applications/get-app-parameters) response to discover the variable names and types expected by your app. | Yes |
| response_mode | string,
**Available values:** "blocking", "streaming" | 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
object
object
object ] | File list for workflow system file inputs. Available when file upload is enabled for the workflow. To attach a local file, first upload it via [Upload File](/api-reference/files/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](/api-reference/applications/get-app-parameters) response to discover the variable names and types expected by your app. | Yes |
| response_mode | string,
**Available values:** "blocking", "streaming" | Response mode. Use `blocking` for synchronous responses or `streaming` for Server-Sent Events. When omitted, the request runs in blocking mode. | No |
| user | string | End-user identifier, defined by your app and unique within it. Identifies the end user for this request. See [End User Identity](/api-reference/guides/end-user-identity) for endpoint-specific access rules. | Yes |
#### WorkflowRunResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| created_at | integer | | No |
| elapsed_time | number
integer | | No |
| error | string | | No |
| finished_at | integer | | No |
| id | string (uuid) | | 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 (uuid) | | Yes |
#### WorkflowTaskStopPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| user | string | End-user identifier, defined by your app and unique within it. It does not need to match the `user` that started the run; the stop applies to the task regardless of `user`. See [End User Identity](/api-reference/guides/end-user-identity). | Yes |
#### WorkflowVersionExecutionNotAllowedError
Workflow version execution is not available on your current plan. Please upgrade to a paid plan.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkflowVersionExecutionNotAllowedError | | Workflow version execution is not available on your current plan. Please upgrade to a paid plan. | |
#### WorkspaceArchivedError
The workspace's status is archived.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkspaceArchivedError | | The workspace's status is archived. | |
#### WorkspaceNotFoundError
Tenant does not exist.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| WorkspaceNotFoundError | | Tenant does not exist. | |