Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dify x OpenAPI

[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.5.1-blue)](https://github.com/langgenius/dify)
[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.6.0-blue)](https://github.com/langgenius/dify)
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Package Manager: uv](https://img.shields.io/badge/package%20manager-uv-black)](https://github.com/astral-sh/uv)
Expand Down Expand Up @@ -39,7 +39,7 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic
> [!tip]
> This indicates that the API has passed at least one test case request. If you find any API errors, feel free to submit an issue or PR!

- Knowledge Base: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.5.1/web/app/(commonLayout)/datasets/template)
- Knowledge Base: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.6.0/web/app/(commonLayout)/datasets/template)
- [x] POST /datasets - Create empty knowledge base
- [x] POST /datasets/{dataset_id} - Update knowledge base
- [x] GET /datasets/{dataset_id}/documents - Get document list
Expand Down Expand Up @@ -71,7 +71,7 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic
- [x] POST /datasets/{dataset_id}/tags - Query dataset bound tags
- [x] POST /datasets/{dataset_id}/retrieval - Retrieve with metadata filtering conditions

- Chat Application: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- Chat Application: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /chat-messages - Send conversation message
- [x] POST /files/upload - Upload file
- [x] POST /messages/{message_id}/feedbacks - Message feedback
Expand All @@ -84,7 +84,7 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic
- [x] GET /info - Get application basic information
- [x] GET /parameters - Get application parameters

- Advanced Chat Application: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- Advanced Chat Application: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /audio-to-text - Speech to text
- [x] POST /text-to-audio - Text to speech
- [x] GET /apps/annotations - Get annotation list
Expand All @@ -100,10 +100,10 @@ Provides OpenAPI Schema for [Dify](https://github.com/langgenius/dify) API, whic
- [x] GET /parameters - Get application parameters


- Text Generation Application: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- Text Generation Application: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /completion-messages - Send message

- Workflow Application: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- Workflow Application: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [Official Documentation Source](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /workflows/run - Execute workflow
- [x] GET /workflows/run/{workflow_run_id} - Get workflow execution status
- [x] POST /workflows/tasks/{task_id}/stop - Stop response
Expand Down
12 changes: 6 additions & 6 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dify x OpenAPI

[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.5.1-blue)](https://github.com/langgenius/dify)
[![Dify Version Support](https://img.shields.io/badge/Support_Dify_Version-1.6.0-blue)](https://github.com/langgenius/dify)
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Package Manager: uv](https://img.shields.io/badge/package%20manager-uv-black)](https://github.com/astral-sh/uv)
Expand Down Expand Up @@ -41,7 +41,7 @@
> [!tip]
> 这里指至少可以通过一次测试用例请求, 如果你发现有哪些API错误, 欢迎提issue或者pr!

- 知识库: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.5.1/web/app/(commonLayout)/datasets/template)
- 知识库: [OpenAPI Schema(中文)](./schema/knowledge_base.zh.yaml) | [OpenAPI Schema(English)](./schema/knowledge_base.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.6.0/web/app/(commonLayout)/datasets/template)
- [x] POST /datasets - 创建空知识库
- [x] POST /datasets/{dataset_id} - 更新知识库
- [x] GET /datasets/{dataset_id}/documents - 获取文档列表
Expand Down Expand Up @@ -73,7 +73,7 @@
- [x] POST /datasets/{dataset_id}/tags - 查询知识库已绑定的标签
- [x] POST /datasets/{dataset_id}/retrieval - 带元数据过滤条件的检索

- 聊天应用: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- 聊天应用: [OpenAPI Schema(中文)](./schema/app_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /chat-messages - 发送对话消息
- [x] POST /files/upload - 上传文件
- [x] POST /messages/{message_id}/feedbacks - 消息反馈
Expand All @@ -86,7 +86,7 @@
- [x] GET /info - 获取应用基本信息
- [x] GET /parameters - 获取应用参数

- 高级聊天应用: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- 高级聊天应用: [OpenAPI Schema(中文)](./schema/app_advanced_chat.zh.yaml) | [OpenAPI Schema(English)](./schema/app_advanced_chat.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /audio-to-text - 语音转文字
- [x] POST /text-to-audio - 文字转语音
- [x] GET /apps/annotations - 获取标注列表
Expand All @@ -101,10 +101,10 @@
- [x] GET /info - 获取应用基本信息
- [x] GET /parameters - 获取应用参数(包含文字转语音设置)

- 文本生成应用: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- 文本生成应用: [OpenAPI Schema(中文)](./schema/app_generation.zh.yaml) | [OpenAPI Schema(English)](./schema/app_generation.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /completion-messages - 发送消息

- 工作流应用: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.5.1/web/app/components/develop/template)
- 工作流应用: [OpenAPI Schema(中文)](./schema/app_workflow.zh.yaml) | [OpenAPI Schema(English)](./schema/app_workflow.en.yaml) | [官方文档源码](https://github.com/langgenius/dify/tree/1.6.0/web/app/components/develop/template)
- [x] POST /workflows/run - 执行工作流
- [x] GET /workflows/run/{workflow_run_id} - 获取工作流执行状态
- [x] POST /workflows/tasks/{task_id}/stop - 停止响应
Expand Down
2 changes: 1 addition & 1 deletion libs/dify
Submodule dify updated 399 files
Empty file.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "dify-openapi"
version = "1.5.1"
version = "1.6.0"
description = "a client for testing and validating dify openapi schema"
readme = "README.md"
authors = [{ name = "straydragon", email = "straydragonl@foxmail.com" }]
Expand Down
2 changes: 1 addition & 1 deletion schema/app_advanced_chat.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ info:
All API requests require an application-level API-Key in the Authorization HTTP Header.
It is strongly recommended that developers store the API-Key on the backend rather than sharing or storing it on the client side to prevent API-Key leakage and financial loss.
official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_advanced_chat.en.mdx
version: 1.5.1
version: 1.6.0
servers:
- url: 'https://api.dify.ai/v1'
description: Dify API Server
Expand Down
4 changes: 2 additions & 2 deletions schema/app_advanced_chat.zh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ info:
对话应用支持会话持久化,可将之前的聊天记录作为上下文进行回答,可适用于聊天/客服 AI 等。
所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。
强烈建议开发者把 API-Key 放在后端存储,而非分享或者放在客户端存储,以免 API-Key 泄露,导致财产损失。
官方原始文档见: https://github.com/langgenius/dify/blob/1.5.1/web/app/components/develop/template/template_advanced_chat.zh.mdx
version: 1.5.1
官方原始文档见: https://github.com/langgenius/dify/blob/1.6.0/web/app/components/develop/template/template_advanced_chat.zh.mdx
version: 1.6.0

servers:
- url: https://api.dify.ai/v1
Expand Down
2 changes: 1 addition & 1 deletion schema/app_chat.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ info:
It supports conversational applications.
All API requests require an application-level API-Key in the Authorization HTTP Header.
official raw document: https://github.com/langgenius/dify/blob/1.4.3/web/app/components/develop/template/template_chat.en.mdx
version: 1.5.1
version: 1.6.0
servers:
- url: 'https://api.dify.ai/v1'
description: Dify API Server
Expand Down
4 changes: 2 additions & 2 deletions schema/app_chat.zh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ info:
Dify API 提供了一系列接口用于对话功能。
支持对话型应用。
所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。
官方原始文档见: https://github.com/langgenius/dify/blob/1.5.1/web/app/components/develop/template/template_chat.zh.mdx
version: 1.5.1
官方原始文档见: https://github.com/langgenius/dify/blob/1.6.0/web/app/components/develop/template/template_chat.zh.mdx
version: 1.6.0

servers:
- url: https://api.dify.ai/v1
Expand Down
2 changes: 1 addition & 1 deletion schema/app_generation.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ info:
It supports text generation applications.
All API requests require an application-level API-Key in the Authorization HTTP Header.
official raw document: https://github.com/langgenius/dify/blob/1.5.0/web/app/components/develop/template/template.en.mdx
version: 1.5.1
version: 1.6.0
servers:
- url: 'https://api.dify.ai/v1'
description: Dify API Server
Expand Down
4 changes: 2 additions & 2 deletions schema/app_generation.zh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ info:
Dify API 提供了一系列接口用于文本生成功能。
支持文本生成型应用。
所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。
官方原始文档见: https://github.com/langgenius/dify/blob/1.5.1/web/app/components/develop/template/template.zh.mdx
version: 1.5.1
官方原始文档见: https://github.com/langgenius/dify/blob/1.6.0/web/app/components/develop/template/template.zh.mdx
version: 1.6.0

servers:
- url: https://api.dify.ai/v1
Expand Down
2 changes: 1 addition & 1 deletion schema/app_workflow.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ info:
All API requests require an application-level API-Key in the Authorization HTTP Header.
It is strongly recommended that developers store the API-Key on the backend rather than sharing or storing it on the client to prevent API-Key leakage and financial loss.
official raw document: https://github.com/langgenius/dify/blob/1.5.0/web/app/components/develop/template/template_workflow.en.mdx
version: 1.5.1
version: 1.6.0
servers:
- url: 'https://api.dify.ai/v1'
description: Dify API Server
Expand Down
4 changes: 2 additions & 2 deletions schema/app_workflow.zh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ info:
Workflow 应用无会话支持,适合用于翻译/文章写作/总结 AI 等等。
所有 API 请求都需要在 Authorization HTTP Header 中包含应用级 API-Key。
强烈建议开发者把 API-Key 放在后端存储,而非分享或者放在客户端存储,以免 API-Key 泄露,导致财产损失。
官方原始文档见: https://github.com/langgenius/dify/blob/1.5.1/web/app/components/develop/template/template_workflow.zh.mdx
version: 1.5.1
官方原始文档见: https://github.com/langgenius/dify/blob/1.6.0/web/app/components/develop/template/template_workflow.zh.mdx
version: 1.6.0

servers:
- url: https://api.dify.ai/v1
Expand Down
2 changes: 1 addition & 1 deletion schema/knowledge_base.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
description: |
Dify Knowledge Base API provides a series of interfaces for managing knowledge bases, documents, and retrieval functions.
All API requests require a knowledge base level API-Key in the Authorization HTTP Header.
version: 1.5.1
version: 1.6.0
servers:
- url: 'https://api.dify.ai/v1'
description: Dify API Server
Expand Down
2 changes: 1 addition & 1 deletion schema/knowledge_base.zh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
description: |
Dify 知识库 API 提供了一系列接口用于管理知识库、文档和检索功能。
所有 API 请求都需要在 Authorization HTTP Header 中包含知识库级 API-Key。
version: 1.5.1
version: 1.6.0

servers:
- url: https://api.dify.ai/v1
Expand Down
Loading
Loading