Skip to main content
post/datasets/{dataset_id}/metadata
Request example
Response
post/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.

Body

application/json
namestringrequired#
Name for the metadata field. Must be unique among the knowledge base's fields and at most 255 characters.
typeenum<string>required#
string for text values, number for numeric values, time for date/time values.
Options:stringnumbertime

Responses

application/json
Metadata field created successfully.
idstring#
Metadata field identifier.
namestring#
Metadata field name.
typestring#
Metadata field type.