Skip to main content
post/datasets/{dataset_id}/document/create-by-file
Request example
Response
post/datasets/{dataset_id}/document/create-by-file

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

Path parameters

dataset_idstringrequired#
知识库 ID,通过 获取知识库列表 获取。使用限定范围的密钥时,从 Dify 页面 URL 复制 ID。

Body

multipart/form-data
datastring#
包含配置信息的 JSON 字符串。接受与 从文本创建文档 相同的字段(indexing_technique、doc_form、doc_language、process_rule、retrieval_model、embedding_model、embedding_model_provider),但不包括 name 和 text。
filefilerequired#

要上传的文件,默认上限 15 MB。

自部署可通过 UPLOAD_FILE_SIZE_LIMIT 环境变量 调整。Dify Cloud 的 Professional 和 Team 套餐上限为 50 MB。

Responses

application/json
文档创建成功。
batchstring#
用于跟踪索引进度的批次 ID。
documentobject#