Skip to main content
get/datasets/{dataset_id}/metadata
Request example
Response
get/datasets/{dataset_id}/metadata

Authorization

Authorizationstringheaderrequired#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path parameters

dataset_idstringrequired#
Knowledge base ID, from List Knowledge Bases. For a scoped key, copy the ID from the Dify URL.

Responses

application/json
Metadata fields for the knowledge base.
built_in_field_enabledboolean#
Whether built-in metadata fields are enabled for this knowledge base.
doc_metadataobject[]#
List of metadata field definitions.