dify创建知识库api
时间: 2025-06-01 12:19:29 浏览: 54
### 使用 Dify API 创建知识库
Dify 是一个强大的工具,支持通过 API 配置和管理外部知识库。以下是关于如何使用 Dify API 创建知识库的详细说明。
#### 1. 准备工作
在开始之前,确保已获取以下关键参数:
- **API 密钥**:用于身份验证[^1]。
- **外部知识库的连接信息**:包括 URL、端口、数据库凭据等[^1]。
#### 2. 配置 API 请求
创建知识库需要发送 POST 请求到 Dify 的 API 端点。以下是请求的基本结构:
```bash
POST https://api.dify.com/v1/knowledge_bases
```
#### 3. 请求头
请求头中需要包含 API 密钥以进行身份验证。示例如下:
```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```
#### 4. 请求体
请求体需要提供知识库的相关配置信息。以下是一个 JSON 格式的示例:
```json
{
"name": "My External Knowledge Base",
"type": "external",
"config": {
"url": "https://example.com/api/external_kb",
"auth_token": "your_auth_token_here",
"vector_field": "embedding_vector",
"weight": 0.8
}
}
```
- **name**:知识库的名称。
- **type**:指定为 `external` 表示这是一个外部知识库[^1]。
- **config**:包含外部知识库的具体配置参数,如 URL、认证令牌、向量字段及权重等[^2]。
#### 5. 响应处理
成功创建知识库后,API 将返回类似以下的响应:
```json
{
"status": "success",
"message": "Knowledge base created successfully",
"data": {
"id": "kb_1234567890abcdef",
"name": "My External Knowledge Base",
"type": "external"
}
}
```
如果请求失败,响应将包含错误信息,帮助排查问题。
#### 6. 注意事项
- 确保外部知识库的 API 接口与 Dify 的要求兼容[^1]。
- 如果使用混合搜索功能,需合理设置向量字段及其权重以优化搜索效果[^2]。
### 示例代码
以下是一个使用 Python 调用 Dify API 创建知识库的示例:
```python
import requests
import json
url = "https://api.dify.com/v1/knowledge_bases"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
}
payload = {
"name": "My External Knowledge Base",
"type": "external",
"config": {
"url": "https://example.com/api/external_kb",
"auth_token": "your_auth_token_here",
"vector_field": "embedding_vector",
"weight": 0.8
}
}
response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.json())
```
阅读全文
相关推荐


















