Created
Jul 23, 2024 06:33 AM
Favorite
Favorite
Priority
备注
推荐
🌟🌟🌟🌟
类型
Dify
一.对话型应用 API
对话应用支持会话持久化，可将之前的聊天记录作为上下进行回答，可适用于聊天/客服 AI 等。
接口 | 功能描述 | 请求示例 |
POST/chat-messages | 创建会话消息。 | ㅤ |
POST/files/upload | 上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。 支持 png, jpg, jpeg, webp, gif 格式。 上传的文件仅供当前终端用户使用。 | ㅤ |
POST/chat-messages/:task_id/stop | 仅支持流式模式。 | ㅤ |
POST/messages/:message_id/feedbacks | 消息终端用户反馈、点赞，方便应用开发者优化输出预期。 | ㅤ |
GET/messages/{message_id}/suggested | 获取下一轮建议问题列表。 | ㅤ |
GET/messages | 滚动加载形式返回历史聊天记录，第一页返回最新 limit 条，即：倒序返回。 | ㅤ |
GET/conversations | 获取当前用户的会话列表，默认返回最近的 20 条。 | ㅤ |
DELETE/conversations/:conversation_id | 删除会话。 | ㅤ |
POST/conversations/:conversation_id/name | 对会话进行重命名，会话名称用于显示在支持多会话的客户端上。 | ㅤ |
POST/audio-to-text | 该接口需使用 multipart/form-data 进行请求。 | ㅤ |
POST/text-to-audio | 文字转语音。 | ㅤ |
GET/parameters | 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 | ㅤ |
GET/meta | 用于获取工具icon | ㅤ |
二.文本生成型应用 API
文本生成应用无会话支持，适合用于翻译/文章写作/总结 AI 等。
接口 | 功能描述 | 请求示例 |
POST/completion-messages | 发送请求给文本生成型应用。 | ㅤ |
POST/files/upload | 上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。 支持 png, jpg, jpeg, webp, gif 格式。 上传的文件仅供当前终端用户使用。 | ㅤ |
POST/completion-messages/:task_id/stop | 仅支持流式模式。 | ㅤ |
POST/messages/:message_id/feedbacks | 消息终端用户反馈、点赞，方便应用开发者优化输出预期。 | ㅤ |
GET/parameters | 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 | ㅤ |
POST/text-to-audio | 文字转语音。 | ㅤ |
三.Workflow 应用 API
Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等。
接口 | 功能描述 | 请求示例 |
POST/workflows/run | 执行 workflow，没有已发布的 workflow，不可执行。 | ㅤ |
POST/workflows/:task_id/stop | 仅支持流式模式。 | ㅤ |
GET/parameters | 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 | ㅤ |
参考文献：
[1] Dify中的API接口：对话、生成和工作流：https://z0yrmerhgi8.feishu.cn/wiki/Y6qvwPpv3iUp2KkUc5Qck18pnMe
Dify项目44