Dify Octri Demo
DELETE/datasets/{dataset_id}/metadata/{metadata_id}

Delete Metadata Field

Permanently delete a custom metadata field. Documents that used the field lose their values for it.

2 parameters
dataset_idstringrequired
Knowledge base ID, from [List Knowledge Bases](/en/api-reference/knowledge-bases/list-knowledge-bases). For a scoped key, [copy the ID from the Dify URL](/en/api-reference/guides/knowledge#knowledge-base-id).
metadata_idstringrequired
ID of the metadata field to delete. See [List Metadata Fields](/en/api-reference/metadata/list-metadata-fields).

3 status codes
204Success.
403- `forbidden` : Dataset api access is not enabled. - `forbidden` : Sorry, you have reached the knowledge base request rate limit of your subscription. - `forbidden` : The API key is scoped to specific knowledge bases, and this knowledge base is not one of them.

One documented failure

  • forbidden

    Dataset api access is not enabled.

    forbidden (api access)

404- `not_found` : Knowledge base not found. - `not_found` : The metadata field identified by `metadata_id` does not exist in this knowledge base.

One documented failure

  • not_found

    Dataset not found.

    not_found (knowledge base)

Error handling

A 403 is returned: - forbidden : Dataset api access is not enabled.

  • forbidden : Sorry, you have reached the knowledge base request rate limit of your subscription.
  • forbidden : The API key is scoped to specific knowledge bases, and this knowledge base is not one of them. A 404 is returned: - not_found : Knowledge base not found.
  • not_found : The metadata field identified by metadata_id does not exist in this knowledge base.