List or read knowledge sources

curl --request POST \
  --url https://api.example.com/api/v1/business/knowledge/sources \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tag_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "q": "<string>",
  "cursor": "<string>",
  "limit": 123
}
'

import requests

url = "https://api.example.com/api/v1/business/knowledge/sources"

payload = {
    "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tag_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "q": "<string>",
    "cursor": "<string>",
    "limit": 123
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tag_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    q: '<string>',
    cursor: '<string>',
    limit: 123
  })
};

fetch('https://api.example.com/api/v1/business/knowledge/sources', 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.example.com/api/v1/business/knowledge/sources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tag_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'q' => '<string>',
    'cursor' => '<string>',
    'limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/business/knowledge/sources"

	payload := strings.NewReader("{\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tag_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"q\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/knowledge/sources")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tag_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"q\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/knowledge/sources")

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

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tag_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"q\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 123\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Knowledge & Brand

List or read knowledge sources

List the project’s knowledge sources, list its folders, or fetch one source’s content (kih-hub). Does NOT cover the Brand Kit — that is a separate resource, fetched with get_brand_kit, not a knowledge source you list/read here.

view=list enumerates sources (filter with folder_id/type/status/q, paginate with cursor/limit); view=folders lists the project’s knowledge folders (id + name) — use it to resolve a folder NAME to its folder_id before filtering or ingesting into that folder; view=content returns the parsed text of one source (needs source_id).

POST

api

business

knowledge

sources

List or read knowledge sources

curl --request POST \
  --url https://api.example.com/api/v1/business/knowledge/sources \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tag_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "q": "<string>",
  "cursor": "<string>",
  "limit": 123
}
'

import requests

url = "https://api.example.com/api/v1/business/knowledge/sources"

payload = {
    "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tag_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "q": "<string>",
    "cursor": "<string>",
    "limit": 123
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tag_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    q: '<string>',
    cursor: '<string>',
    limit: 123
  })
};

fetch('https://api.example.com/api/v1/business/knowledge/sources', 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.example.com/api/v1/business/knowledge/sources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tag_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'q' => '<string>',
    'cursor' => '<string>',
    'limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/business/knowledge/sources"

	payload := strings.NewReader("{\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tag_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"q\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/knowledge/sources")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tag_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"q\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/knowledge/sources")

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

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tag_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"q\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 123\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-project-id

string<uuid>

required

Project ID for tenant scoping

X-Workspace-Id

string<uuid> | null

Overrides the key's workspace

X-API-Key

string | null

User API key

Body

application/json

view

enum<string>

required

list enumerates sources; content fetches one source's text

Available options:

list,

content,

folders

source_id

string<uuid> | null

Source id; required for the content view

folder_id

string<uuid> | null

Filter the list to a folder; resolve a folder name to its id via view='folders'

type

enum<string> | null

Filter the list by source origin (WEB_URL, WEBSITE, FILE, DOCUMENT) — not a file format like pdf/txt; there is no file-format filter, use q for a filename substring instead.

Available options:

WEB_URL,

WEBSITE,

FILE,

DOCUMENT

status

enum<string> | null

Filter the list by sync status (QUEUED, SYNCING, SYNCED, SYNC_FAILED).

Available options:

QUEUED,

SYNCING,

SYNCED,

SYNC_FAILED

workflow_status

enum<string> | null

Filter the list by workflow status (DRAFT, IN_REVIEW, APPROVED, ARCHIVED).

Available options:

DRAFT,

IN_REVIEW,

APPROVED,

ARCHIVED

tag_id

string<uuid> | null

Filter the list to a tag

string | null

Substring filter for the list view, matched against source title/filename — a single call already returns the definitive match set, no follow-up full listing needed.

cursor

string | null

Pagination cursor for the list view

limit

integer | null

Max sources to return in the list view

Response

Successful Response

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge & Brand

Content Intelligence

Integrations & Attachments

List or read knowledge sources

Headers

Body

Response