Get Knowledge Base
Returns detailed information about a knowledge base, including its embedding model, retrieval configuration, and document statistics.
1 min read
get/datasets/{dataset_id}
Request example
Response
get/datasets/{dataset_id}
Authorization
Path parameters
Knowledge base ID, from List Knowledge Bases. For a scoped key, copy the ID from the Dify URL.
Responses
application/json
Knowledge base details.
Number of applications currently using this knowledge base.
Whether built-in metadata fields (e.g.,
document_name, uploader) are enabled.Chunk structure configuration.
Creation timestamp (Unix epoch in seconds).
ID of the user who created the knowledge base.
Data source type of the documents,
null if not yet configured.Optional text describing the purpose or contents of the knowledge base.
Document chunking mode.
text_model for standard text chunking, hierarchical_model for parent-child structure, qa_model for QA pair extraction.Total number of documents in the knowledge base.
Whether the configured embedding model is currently available.
Name of the embedding model used for indexing.
Embedding model provider identifier, formatted as
organization/plugin_name/provider_name (e.g. langgenius/openai/openai). Legacy knowledge bases may return the bare short form (e.g. openai).Whether API access is enabled for this knowledge base.
Connection details for external knowledge bases. Present when
provider is external.Retrieval settings for external knowledge bases.
null for internal knowledge bases.Unique identifier of the knowledge base.
high_quality uses embedding models for precise search; economy uses keyword-based indexing.Whether multimodal content processing is enabled.
Whether the knowledge base is published.
Display name of the knowledge base maintainer.
null if not set.Display name of the knowledge base. Unique within the workspace.
Account IDs of members granted access when
permission is partial_members. Always present on the update response; on the detail response, present only when permission is partial_members.Controls who can access this knowledge base. Possible values:
only_me, all_team_members, partial_members.Pipeline ID, if a custom processing pipeline is configured.
Provider type.
vendor for internally managed, external for external knowledge base connections.Runtime processing mode.
Number of documents that are enabled and available.
Total number of documents.
Last update timestamp (Unix epoch in seconds).
ID of the user who last updated the knowledge base.
Total word count across all documents.