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.
Authorizations
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
Knowledge base ID.
Body
Name of the knowledge base.
1 - 40Description of the knowledge base.
400high_quality uses embedding models for precise search; economy uses keyword-based indexing.
high_quality, economy Controls who can access this knowledge base. only_me restricts to the creator, all_team_members grants access to the entire workspace, partial_members grants access to specified members.
only_me, all_team_members, partial_members Embedding model name. Use the model field from Get Available Models with model_type=text-embedding.
Embedding model provider. Use the provider field from Get Available Models with model_type=text-embedding.
Retrieval model configuration. Controls how chunks are searched and ranked when querying this knowledge base.
List of team members with access when permission is partial_members.
Retrieval settings for external knowledge bases.
ID of the external knowledge base.
ID of the external knowledge API connection.
Response
Knowledge base updated successfully.
Unique identifier of the knowledge base.
Display name of the knowledge base. Unique within the workspace.
Optional text describing the purpose or contents of the knowledge base.
Provider type. vendor for internally managed, external for external knowledge base connections.
Controls who can access this knowledge base. Possible values: only_me, all_team_members, partial_members.
Data source type of the documents, null if not yet configured.
high_quality uses embedding models for precise search; economy uses keyword-based indexing.
Number of applications currently using this knowledge base.
Total number of documents in the knowledge base.
Total word count across all documents.
ID of the user who created the knowledge base.
Display name of the creator.
Creation timestamp (Unix epoch in seconds).
ID of the user who last updated the knowledge base.
Last update timestamp (Unix epoch in seconds).
Name of the embedding model used for indexing.
Embedding model provider. Use the provider field from Get Available Models with model_type=text-embedding.
Whether the configured embedding model is currently available.
Retrieval configuration for the knowledge base.
Summary index configuration.
Tags associated with this knowledge base.
Document chunking mode. text_model for standard text chunking, hierarchical_model for parent-child structure, qa_model for QA pair extraction.
Connection details for external knowledge bases. Present when provider is external.
Retrieval settings for external knowledge bases. null for internal knowledge bases.
Metadata field definitions for the knowledge base.
Whether built-in metadata fields (e.g., document_name, uploader) are enabled.
Pipeline ID, if a custom processing pipeline is configured.
Runtime processing mode.
Chunk structure configuration.
Icon display configuration for the knowledge base.
Whether the knowledge base is published.
Total number of documents.
Number of documents that are enabled and available.
Whether API access is enabled for this knowledge base.
Whether multimodal content processing is enabled.