Get Knowledge Base - Dify Docs

GET

/

datasets

/

{dataset_id}

Error

A valid request URL is required to generate request examples

{
  "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
  "name": "Product Documentation",
  "description": "Technical documentation for the product API",
  "provider": "vendor",
  "permission": "only_me",
  "data_source_type": null,
  "indexing_technique": "high_quality",
  "app_count": 0,
  "document_count": 0,
  "word_count": 0,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "author_name": "admin",
  "created_at": 1741267200,
  "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "updated_at": 1741267200,
  "embedding_model": "text-embedding-3-small",
  "embedding_model_provider": "openai",
  "embedding_available": true,
  "retrieval_model_dict": {
    "search_method": "semantic_search",
    "reranking_enable": false,
    "reranking_mode": null,
    "reranking_model": {
      "reranking_provider_name": "",
      "reranking_model_name": ""
    },
    "weights": null,
    "top_k": 3,
    "score_threshold_enabled": false,
    "score_threshold": null
  },
  "tags": [],
  "doc_form": "text_model",
  "external_knowledge_info": null,
  "external_retrieval_model": null,
  "doc_metadata": [],
  "built_in_field_enabled": true,
  "pipeline_id": null,
  "runtime_mode": null,
  "chunk_structure": null,
  "icon_info": null,
  "summary_index_setting": null,
  "is_published": false,
  "total_documents": 0,
  "total_available_documents": 0,
  "enable_api": true,
  "is_multimodal": false
}

Authorizations

Authorization

string

header

required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

dataset_id

string<uuid>

required

Knowledge base ID.

Response

Knowledge base details.

id

string

Unique identifier of the knowledge base.

name

string

Display name of the knowledge base. Unique within the workspace.

description

string

Optional text describing the purpose or contents of the knowledge base.

provider

string

Provider type. vendor for internally managed, external for external knowledge base connections.

permission

string

Controls who can access this knowledge base. Possible values: only_me, all_team_members, partial_members.

data_source_type

string

Data source type of the documents, null if not yet configured.

indexing_technique

string

high_quality uses embedding models for precise search; economy uses keyword-based indexing.

app_count

integer

Number of applications currently using this knowledge base.

document_count

integer

Total number of documents in the knowledge base.

word_count

integer

Total word count across all documents.

created_by

string

ID of the user who created the knowledge base.

author_name

string

Display name of the creator.

created_at

number

Creation timestamp (Unix epoch in seconds).

updated_by

string

ID of the user who last updated the knowledge base.

updated_at

number

Last update timestamp (Unix epoch in seconds).

embedding_model

string

Name of the embedding model used for indexing.

embedding_model_provider

string

Embedding model provider. Use the provider field from Get Available Models with model_type=text-embedding.

embedding_available

boolean

Whether the configured embedding model is currently available.

retrieval_model_dict

object

Retrieval configuration for the knowledge base.

Show child attributes

summary_index_setting

object

Summary index configuration.

Show child attributes

tags

object[]

Tags associated with this knowledge base.

Show child attributes

doc_form

string

Document chunking mode. text_model for standard text chunking, hierarchical_model for parent-child structure, qa_model for QA pair extraction.

external_knowledge_info

object

Connection details for external knowledge bases. Present when provider is external.

Show child attributes

external_retrieval_model

object

Retrieval settings for external knowledge bases. null for internal knowledge bases.

Show child attributes

doc_metadata

object[]

Metadata field definitions for the knowledge base.

Show child attributes

built_in_field_enabled

boolean

Whether built-in metadata fields (e.g., document_name, uploader) are enabled.

pipeline_id

string | null

Pipeline ID, if a custom processing pipeline is configured.

runtime_mode

string | null

Runtime processing mode.

chunk_structure

string | null

Chunk structure configuration.

icon_info

object

Icon display configuration for the knowledge base.

Show child attributes

is_published

boolean

Whether the knowledge base is published.

total_documents

integer

Total number of documents.

total_available_documents

integer

Number of documents that are enabled and available.

enable_api

boolean

Whether API access is enabled for this knowledge base.

is_multimodal

boolean

Whether multimodal content processing is enabled.

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

Error

A valid request URL is required to generate request examples

{
  "id": "c42e2a6e-40b3-4330-96f8-f1e4d768e8c9",
  "name": "Product Documentation",
  "description": "Technical documentation for the product API",
  "provider": "vendor",
  "permission": "only_me",
  "data_source_type": null,
  "indexing_technique": "high_quality",
  "app_count": 0,
  "document_count": 0,
  "word_count": 0,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "author_name": "admin",
  "created_at": 1741267200,
  "updated_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "updated_at": 1741267200,
  "embedding_model": "text-embedding-3-small",
  "embedding_model_provider": "openai",
  "embedding_available": true,
  "retrieval_model_dict": {
    "search_method": "semantic_search",
    "reranking_enable": false,
    "reranking_mode": null,
    "reranking_model": {
      "reranking_provider_name": "",
      "reranking_model_name": ""
    },
    "weights": null,
    "top_k": 3,
    "score_threshold_enabled": false,
    "score_threshold": null
  },
  "tags": [],
  "doc_form": "text_model",
  "external_knowledge_info": null,
  "external_retrieval_model": null,
  "doc_metadata": [],
  "built_in_field_enabled": true,
  "pipeline_id": null,
  "runtime_mode": null,
  "chunk_structure": null,
  "icon_info": null,
  "summary_index_setting": null,
  "is_published": false,
  "total_documents": 0,
  "total_available_documents": 0,
  "enable_api": true,
  "is_multimodal": false
}