Skip to content

fix: correct API reference server URL so request examples render #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RiskeyL merged 1 commit into from
Jun 1, 2026
Merged

fix: correct API reference server URL so request examples render #804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions en/api-reference/openapi_chat.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "The base URL for the Chat App API. Replace {api_base_url} with the actual API base URL provided for your application.",
"url": "https://{api_base_url}",
"description": "Base URL of the Chat App API. For self-hosted deployments, replace it with your own API base URL.",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "Actual base URL of the API"
"default": "api.dify.ai/v1",
"description": "Host and path of the API base URL, without the `https://` prefix."
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions en/api-reference/openapi_chatflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "The base URL for the Chatflow App API. Replace {api_base_url} with the actual API base URL provided for your application.",
"url": "https://{api_base_url}",
"description": "Base URL of the Chatflow App API. For self-hosted deployments, replace it with your own API base URL.",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "Actual base URL of the API"
"default": "api.dify.ai/v1",
"description": "Host and path of the API base URL, without the `https://` prefix."
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions en/api-reference/openapi_completion.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "The base URL for the Completion App API. Replace {api_base_url} with the actual API base URL provided for your application.",
"url": "https://{api_base_url}",
"description": "Base URL of the Completion App API. For self-hosted deployments, replace it with your own API base URL.",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "Actual base URL of the API"
"default": "api.dify.ai/v1",
"description": "Host and path of the API base URL, without the `https://` prefix."
}
}
}
Expand Down
10 changes: 5 additions & 5 deletions en/api-reference/openapi_knowledge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{apiBaseUrl}",
"description": "The base URL for the Knowledge API.",
"url": "https://{api_base_url}",
"description": "Base URL of the Knowledge API. For self-hosted deployments, replace it with your own API base URL.",
"variables": {
"apiBaseUrl": {
"default": "https://api.dify.ai/v1",
"description": "Actual base URL of the API"
"api_base_url": {
"default": "api.dify.ai/v1",
"description": "Host and path of the API base URL, without the `https://` prefix."
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions en/api-reference/openapi_workflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "The base URL for the Workflow App API. Replace {api_base_url} with the actual API base URL.",
"url": "https://{api_base_url}",
"description": "Base URL of the Workflow App API. For self-hosted deployments, replace it with your own API base URL.",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "Actual base URL of the API"
"default": "api.dify.ai/v1",
"description": "Host and path of the API base URL, without the `https://` prefix."
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions ja/api-reference/openapi_chat.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "チャットアプリ API のベース URL です。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。",
"url": "https://{api_base_url}",
"description": "チャットアプリ API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API の実際のベース URL"
"default": "api.dify.ai/v1",
"description": "API ベース URL のホストとパス（`https://` を除く）。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions ja/api-reference/openapi_chatflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "Chatflow アプリ API のベース URL です。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。",
"url": "https://{api_base_url}",
"description": "Chatflow アプリ API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API の実際のベース URL"
"default": "api.dify.ai/v1",
"description": "API ベース URL のホストとパス（`https://` を除く）。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions ja/api-reference/openapi_completion.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "テキスト生成アプリ API のベース URL です。{api_base_url} をアプリケーションに提供された実際の API ベース URL に置き換えてください。",
"url": "https://{api_base_url}",
"description": "テキスト生成アプリ API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API の実際のベース URL"
"default": "api.dify.ai/v1",
"description": "API ベース URL のホストとパス（`https://` を除く）。"
}
}
}
Expand Down
10 changes: 5 additions & 5 deletions ja/api-reference/openapi_knowledge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{apiBaseUrl}",
"description": "Knowledge API のベース URL です。",
"url": "https://{api_base_url}",
"description": "Knowledge API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。",
"variables": {
"apiBaseUrl": {
"default": "https://api.dify.ai/v1",
"description": "API の実際のベース URL"
"api_base_url": {
"default": "api.dify.ai/v1",
"description": "API ベース URL のホストとパス（`https://` を除く）。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions ja/api-reference/openapi_workflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "Workflow App API のベース URL です。{api_base_url} を実際の API ベース URL に置き換えてください。",
"url": "https://{api_base_url}",
"description": "Workflow App API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API の実際のベース URL"
"default": "api.dify.ai/v1",
"description": "API ベース URL のホストとパス（`https://` を除く）。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions zh/api-reference/openapi_chat.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "对话型应用 API 的基础 URL。请将 {api_base_url} 替换为你的应用实际提供的 API 基础 URL。",
"url": "https://{api_base_url}",
"description": "对话型应用 API 的基础 URL。自托管部署时，替换为你的 API 基础 URL。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API 的实际基础 URL"
"default": "api.dify.ai/v1",
"description": "API 基础 URL 的主机与路径，不含 `https://` 前缀。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions zh/api-reference/openapi_chatflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "工作流编排对话型应用 API 的基础 URL。请将 {api_base_url} 替换为你的应用实际提供的 API 基础 URL。",
"url": "https://{api_base_url}",
"description": "工作流编排对话型应用 API 的基础 URL。自托管部署时，替换为你的 API 基础 URL。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API 的实际基础 URL"
"default": "api.dify.ai/v1",
"description": "API 基础 URL 的主机与路径，不含 `https://` 前缀。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions zh/api-reference/openapi_completion.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "文本生成型应用 API 的基础 URL。请将 {api_base_url} 替换为你的应用实际提供的 API 基础 URL。",
"url": "https://{api_base_url}",
"description": "文本生成型应用 API 的基础 URL。自托管部署时，替换为你的 API 基础 URL。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API 的实际基础 URL"
"default": "api.dify.ai/v1",
"description": "API 基础 URL 的主机与路径，不含 `https://` 前缀。"
}
}
}
Expand Down
10 changes: 5 additions & 5 deletions zh/api-reference/openapi_knowledge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{apiBaseUrl}",
"description": "Knowledge API 的基础 URL。",
"url": "https://{api_base_url}",
"description": "Knowledge API 的基础 URL。自托管部署时，替换为你的 API 基础 URL。",
"variables": {
"apiBaseUrl": {
"default": "https://api.dify.ai/v1",
"description": "API 的实际基础 URL"
"api_base_url": {
"default": "api.dify.ai/v1",
"description": "API 基础 URL 的主机与路径，不含 `https://` 前缀。"
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions zh/api-reference/openapi_workflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
},
"servers": [
{
"url": "{api_base_url}",
"description": "工作流应用 API 的基础 URL。将 {api_base_url} 替换为实际的 API 基础 URL。",
"url": "https://{api_base_url}",
"description": "工作流应用 API 的基础 URL。自托管部署时，替换为你的 API 基础 URL。",
"variables": {
"api_base_url": {
"default": "https://api.dify.ai/v1",
"description": "API 的实际基础 URL"
"default": "api.dify.ai/v1",
"description": "API 基础 URL 的主机与路径，不含 `https://` 前缀。"
}
}
}
Expand Down
Loading