List Datasource Plugins - Dify Enterprise Docs

List Datasource Plugins

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "node_id": "1719288585006",
    "plugin_id": "langgenius/notion_datasource",
    "provider_name": "notion",
    "datasource_type": "online_document",
    "title": "Notion Documents",
    "user_input_variables": [],
    "credentials": [
      {
        "id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
        "name": "Production Notion",
        "type": "api-key",
        "is_default": true
      }
    ]
  }
]

GET

/

datasets

/

{dataset_id}

/

pipeline

/

datasource-plugins

List Datasource Plugins

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}/pipeline/datasource-plugins")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "node_id": "1719288585006",
    "plugin_id": "langgenius/notion_datasource",
    "provider_name": "notion",
    "datasource_type": "online_document",
    "title": "Notion Documents",
    "user_input_variables": [],
    "credentials": [
      {
        "id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
        "name": "Production Notion",
        "type": "api-key",
        "is_default": true
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

dataset_id

string<uuid>

required

Knowledge base ID, from List Knowledge Bases. For a scoped key, copy the ID from the Dify URL.

Query Parameters

is_published

boolean

default:true

Whether to read nodes from the published pipeline version rather than the draft.

Response

List of datasource nodes configured in the pipeline.

node_id

string

ID of the datasource node in the pipeline workflow. Pass this as node_id to Run Datasource Node, or as start_node_id to Run Pipeline.

plugin_id

string

ID of the datasource plugin providing this node.

provider_name

string

Provider name registered by the datasource plugin.

datasource_type

string

Type of datasource. One of local_file, online_document, online_drive, website_crawl.

title

string

Display title configured for the node.

user_input_variables

object[]

Pipeline input variables the caller must supply for this datasource, derived from {{#...#}} references in the node's datasource parameters. Each item follows the pipeline variable schema used by the workflow.

credentials

object[]

Credentials available for authenticating with this datasource.

Show child attributes