Skip to content

docs: document datasource_info_list schemas and improve Run Pipeline API #741

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 5 commits into from
Apr 10, 2026
Merged

docs: document datasource_info_list schemas and improve Run Pipeline API #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b415227
docs: document datasource_info_list per-type schemas for Run Pipeline…
RiskeyL Apr 10, 2026
7f8da39
docs: improve Run Pipeline parameter descriptions and SSE event docum…
RiskeyL Apr 10, 2026
0df1bde
translate: sync zh/ja pipeline API specs with English schema updates
RiskeyL Apr 10, 2026
bedc72a
fix: address Copilot's PR review feedback on pipeline API docs
RiskeyL Apr 10, 2026
0cf66eb
style: add punctuation spacing and API cross-link rules to translatio…
RiskeyL Apr 10, 2026
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
195 changes: 186 additions & 9 deletions en/api-reference/openapi_knowledge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5753,33 +5753,137 @@
"inputs": {
"type": "object",
"additionalProperties": true,
"description": "Input variables for the pipeline."
"description": "Key-value pairs for pipeline input variables defined in the workflow. Pass `{}` if the pipeline has no input variables."
},
"datasource_type": {
"type": "string",
"enum": [
"online_document",
"local_file",
"online_document",
"website_crawl",
"online_drive"
],
"description": "Type of the datasource."
"description": "Type of the datasource. Determines which fields are expected in `datasource_info_list` items."
},
"datasource_info_list": {
"type": "array",
"description": "List of datasource objects to process. The expected item structure depends on `datasource_type`.",
Comment thread
RiskeyL marked this conversation as resolved.
"items": {
"type": "object",
"additionalProperties": true
},
"description": "List of datasource information objects for the pipeline to process."
"oneOf": [
{
"title": "Local File",
"type": "object",
"required": [
"reference"
],
"properties": {
"reference": {
"type": "string",
"description": "Use the `id` returned by the [Upload Pipeline File](/api-reference/knowledge-pipeline/upload-pipeline-file) endpoint. `related_id` is accepted as an alias."
},
Comment thread
RiskeyL marked this conversation as resolved.
"name": {
"type": "string",
"description": "Document title. Defaults to `\"untitled\"`."
}
}
},
{
"title": "Online Document",
"type": "object",
"required": [
"workspace_id",
"page"
],
"properties": {
"workspace_id": {
"type": "string",
"description": "ID of the workspace or database in the external platform (e.g., a Notion workspace ID)."
},
"page": {
"type": "object",
"description": "Page details.",
"required": [
"page_id",
"type"
],
"properties": {
"page_id": {
"type": "string",
"description": "Page identifier."
},
"type": {
"type": "string",
"description": "Page type defined by the datasource plugin (e.g., `\"page\"`, `\"database\"`)."
},
"page_name": {
"type": "string",
"description": "Display name. Defaults to `\"untitled\"`."
}
}
},
"credential_id": {
"type": "string",
"description": "Credential for authenticating with the external platform. Managed via the Dify console. If omitted, the provider's default credential is used."
}
}
},
{
"title": "Website Crawl",
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "URL to crawl."
},
"title": {
"type": "string",
"description": "Used as the document name. Defaults to `\"untitled\"`."
}
}
},
{
"title": "Online Drive",
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "File or folder ID."
},
"type": {
"type": "string",
"enum": [
"file",
"folder"
],
"description": "Whether this entry is a single file or a folder to expand."
},
"bucket": {
"type": "string",
"description": "Storage bucket name. Required by some drive providers (e.g., S3-compatible stores); omit if the provider does not use buckets."
},
"name": {
"type": "string",
"description": "File name. Defaults to `\"untitled\"`."
}
}
}
]
}
},
"start_node_id": {
"type": "string",
"description": "ID of the node to start pipeline execution from."
},
"is_published": {
"type": "boolean",
"description": "Whether to run the published or draft version of the pipeline. `true` runs the published version, `false` runs the draft."
"description": "Whether to run the published or draft version of the pipeline. `true` runs the latest published version; `false` runs the current draft (useful for testing unpublished changes)."
},
"response_mode": {
"type": "string",
Expand All @@ -5790,6 +5894,79 @@
"description": "Response mode for the pipeline execution. `streaming` returns a Server-Sent Events stream, `blocking` waits and returns the complete result."
}
}
},
"examples": {
"local_file": {
"summary": "Request Example—Local file",
"value": {
"inputs": {},
"datasource_type": "local_file",
"datasource_info_list": [
{
"reference": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "quarterly-report.pdf"
}
],
"start_node_id": "1719288585006",
"is_published": true,
"response_mode": "blocking"
}
},
"online_document": {
"summary": "Request Example—Online document",
"value": {
"inputs": {},
"datasource_type": "online_document",
"datasource_info_list": [
{
"workspace_id": "ws-abc123",
"page": {
"page_id": "pg-def456",
"type": "page",
"page_name": "Product Roadmap"
},
"credential_id": "cred-789xyz"
}
],
"start_node_id": "1719288585006",
"is_published": true,
"response_mode": "streaming"
}
},
"website_crawl": {
"summary": "Request Example—Website crawl",
"value": {
"inputs": {},
"datasource_type": "website_crawl",
"datasource_info_list": [
{
"url": "https://example.com/docs/getting-started",
"title": "Getting Started Guide"
}
],
"start_node_id": "1719288585006",
"is_published": true,
"response_mode": "blocking"
}
},
"online_drive": {
"summary": "Request Example—Online drive",
"value": {
"inputs": {},
"datasource_type": "online_drive",
"datasource_info_list": [
{
"id": "file-abc123",
"type": "file",
"bucket": "my-bucket",
"name": "meeting-notes.docx"
}
],
"start_node_id": "1719288585006",
"is_published": true,
"response_mode": "blocking"
}
}
}
}
}
Expand All @@ -5801,7 +5978,7 @@
"text/event-stream": {
"schema": {
"type": "string",
"description": "Server-Sent Events stream containing pipeline execution progress and results. Returned when `response_mode` is `streaming`."
"description": "Server-Sent Events stream. Returned when `response_mode` is `streaming`.\n\nEach line is `data: {JSON}\\n\\n`. Key events: `workflow_started` (execution began), `node_started` / `node_finished` (per-node progress with `node_id`, `node_type`, `status`, `inputs`, `outputs`), `workflow_finished` (final result with `status`, `outputs`, `total_tokens`, `elapsed_time`), `ping` (keepalive)."
}
},
"application/json": {
Expand Down
Loading
Loading