Help

[Synchronzied]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:)
• Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

When uploading metadata via the API, is it necessary to enable metadata using
url = f"https://api.dify.ai/v1/datasets/{dataset_id}/metadata/built-in/{action}"?
If so, how should the action be set?

2. Additional context or comments

No response

[dosubot[bot]]

You do not need to enable built-in metadata fields before uploading custom metadata via the API. The endpoint /datasets/{dataset_id}/metadata/built-in/{action} is only for toggling built-in metadata fields (like document_name, uploader, upload_date, last_update_date, and source) for all documents in a dataset. If you want to enable these built-in fields, send a POST request to that endpoint with the action parameter set to enable; to disable them, set action to disable (source). Custom metadata upload works independently of this toggle.

Official documentation for this endpoint is currently missing, but the codebase confirms this behavior. If you only need custom metadata, you can skip the built-in fields toggle. If you want the built-in fields to appear in your dataset's documents, use the endpoint as described above.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}