List or read knowledge sources

List the project’s knowledge sources or the folders that organize them, or read the full content of one source. This does not cover the brand kit, which is a separate resource.

Example: “What knowledge sources have I uploaded?”

Usage: pick what you want with view: list for the sources, folders for the folders (id and name, handy for turning a folder name into its id), or content for one source’s parsed text (needs the source id). When listing you can narrow by folder, by origin (web url, website, file, or document), by sync status, by workflow status, by tag, or by a text search over the title or filename, and page through the results with a cursor and a limit.

Response: for list, the matching sources with their status and details. For folders, each folder’s id and name. For content, the parsed text of the source.

POST /api/v1/business/knowledge/sources

List or read knowledge sources

cURL

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
}
'

422

{
  "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

q · 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

200

application/json

Successful Response