Get Source

GET

knowledge-fs

spaces

{knowledge_base_id}

sources

{source_id}

Get Source

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}"

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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}', 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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}",
  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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}"

	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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}")

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

{
  "connection_id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "created_at": "2026-09-01T08:00:00Z",
  "credential_configured": null,
  "id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "last_synced_at": null,
  "metadata": {
    "client_request_id": "source-20260907-0001",
    "providerKind": "website",
    "tenantId": "2f1e0d9c-8b7a-4695-8473-2a1b0c9d8e7f"
  },
  "name": "Docs site",
  "permission_scope": [],
  "status": "active",
  "sync_policy": null,
  "sync_workflow": null,
  "type": "web",
  "updated_at": "2026-09-05T10:12:00Z",
  "uri": "https://docs.example.com",
  "version": 7
}

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

knowledge_base_id

string<uuid>

required

Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's API Access dialog (…/knowledge-fs/spaces/<knowledge base ID>), and the segment after /datasets/new/ in the address bar.

source_id

string<uuid>

required

Source ID. From List Sources.

Response

The source.

connection_id

string | null

Connection the source uses for credentials. Pass it as connectionId when binding another source to the same connection. null when unbound.

created_at

string

Creation time, ISO 8601.

credential_configured

boolean | null

true when the source holds a credential reference of its own. null when it holds none, as with sources bound to a connection.

string

Source ID.

knowledge_space_id

string

Internal ID of the knowledge base. Not the knowledge base ID in the path.

last_synced_at

string | null

Completion time of the latest completed sync (completed or zero_results) or completed import. Set by List Sources only. null elsewhere and when the source has never synced.

metadata

object

Provider settings and server-managed sync or page-selection data. May include provider identifiers and parameters; connection-managed settings need not appear here. Credential-like keys are removed. Do not copy the entire object when creating another source.

name

string

Display name.

permission_scope

string[]

Content scopes required to read this source. An empty list adds no content restriction within the knowledge base. Knowledge base authorization still applies.

status

string

active, syncing, error, or disabled. Most operations return the stored value. List Sources derives it from the latest sync run:

failed or canceled run: error
completed or zero_results run: active
Any live run: syncing

disabled is never overridden.

sync_policy

object | null

The source's sync schedule. Set by List Sources only. null elsewhere and when no schedule exists. Read it on its own with Get Sync Policy and change it with Update Sync Policy.

Show child attributes

sync_workflow

object | null

The source's active sync or import run (crawl-import, online-document-import, or online-drive-import), or else its latest sync run. List Sources sets it when a run is active or newer than the source. Update Source sets it when the call started a sync. null otherwise. Crawl previews and imports from them never appear here.

To follow one run, call Get Source Run with its id.

Show child attributes

type

string

web (website crawl), connector (online document or online drive), upload, or object-storage.

For a connector source, metadata.providerKind is online-document or online-drive. For a web source it is website.

Dify fills upload and object-storage sources.

updated_at

string

Last change, ISO 8601.

uri

string

Crawl root URL for web sources. connector://<connection_id> for Dify-created connector sources.

version

integer

Source version, increased on every write. Send it as expectedVersion on Update Source, as expectedRevision on Delete Source, and as expectedSourceVersion on Update Sync Policy.

Get Source

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}"

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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}', 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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}",
  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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}"

	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}/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}")

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

{
  "connection_id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "created_at": "2026-09-01T08:00:00Z",
  "credential_configured": null,
  "id": "6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90",
  "knowledge_space_id": "0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d",
  "last_synced_at": null,
  "metadata": {
    "client_request_id": "source-20260907-0001",
    "providerKind": "website",
    "tenantId": "2f1e0d9c-8b7a-4695-8473-2a1b0c9d8e7f"
  },
  "name": "Docs site",
  "permission_scope": [],
  "status": "active",
  "sync_policy": null,
  "sync_workflow": null,
  "type": "web",
  "updated_at": "2026-09-05T10:12:00Z",
  "uri": "https://docs.example.com",
  "version": 7
}

Guides

App APIs

Knowledge APIs

Authorizations

Path Parameters

Response