dify工作流接口
时间: 2025-04-08 07:34:02 浏览: 208
### Dify 工作流 API 使用说明
Dify 提供了一套强大的工作流 API,允许开发者通过编程的方式实现复杂的功能集成和自动化操作。以下是关于 Dify 工作流 API 的详细介绍:
#### 1. **基本概念**
Dify 中的工作流(Workflow)是一种可编程的任务流程管理工具,适用于多种场景,例如票据识别、自然语言生成以及数据处理等[^2]。它可以通过 API 调用来触发执行,并支持动态参数传递。
#### 2. **主要接口功能**
##### (1) 执行 Workflow
`POST /workflows/run`
此接口用于启动指定的工作流实例。需要注意的是,在调用该接口之前,必须确保目标 workflow 已经发布并处于可用状态;否则请求将会失败[^1]。
示例代码如下:
```bash
curl -X POST https://your-domain.com/api/v1/workflows/run \
-H "Content-Type: application/json" \
-d '{
"workflow_id": "unique_workflow_identifier",
"input_data": {
"param1": "value1",
"param2": "value2"
}
}'
```
##### (2) 停止正在运行的 Task
`POST /workflows/:task_id/stop`
如果某个 task 正在以流式模式运行,则可以使用上述 URL 来中断其进程。这里 `:task_id` 是具体任务的唯一标识符。
注意:只有当 worklow 支持流式输出时才适用此方法。
##### (3) 获取初始化参数列表
`GET /parameters`
开发人员通常会在构建界面或者调试阶段利用这一端点来检索当前系统的全局设置信息,包括但不限于各个模块的状态开关、预期接收的数据字段及其属性定义等等。
响应结构可能类似于这样:
```json
[
{"name":"temperature","type":"number","default_value":0.7},
{"name":"max_tokens","type":"integer","default_value":50}
]
```
#### 3. **高级特性配置**
除了基础的操作之外,Dify 还提供了丰富的组件选项以便满足更复杂的业务需求。比如 LLM 节点能够连接到第三方预训练模型完成定制化的内容创作服务;HTTP 请求单元则可以帮助抓取互联网上的公开资源作为输入源之一[^4]。
另外还有专门针对程序逻辑控制的部分——像循环迭代器可以让单次动作重复多次直至达到预定条件为止;而条件分支语句则是依据实际情境做出不同反应的关键所在。
#### 4. **实践指南**
对于初学者来说,建议先参考官方文档学习如何正确组装这些原子级单位形成完整的解决方案链路图谱[^3]。与此同时也要重视错误排查环节的学习过程因为即使是微小失误也可能导致整个项目无法正常运转下去。
---
### 示例代码片段展示
下面给出一段简单的 Python 脚本来演示怎样远程激活某项特定的服务:
```python
import requests
url = "https://example.dify.ai/api/v1/workflows/run"
headers = {'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type':'application/json'}
payload = {
"workflow_id": "sample_ticket_recognition_flow",
"input_data": {
"image_url": "http://path.to/image.jpg"
}
}
response = requests.post(url, headers=headers, json=payload)
if response.status_code == 200:
result = response.json()
print(f"Task started successfully! Result ID is {result['id']}.")
else:
error_message = response.text
raise Exception(f"Failed to start the task due to {error_message}")
```
---
阅读全文
相关推荐



















