---
title: "List Sources Route"
method: GET
path: "/api/knowledge_bases/{knowledge_base_id}/sources/"
tags: ["source"]
---

# List Sources Route

`GET /api/knowledge_bases/{knowledge_base_id}/sources/`

Get all sources for a knowledge base.

## Path parameters

- `knowledge_base_id` string, uuid, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- Source[]
  - `name` string, required
  - `knowledge_base_id` string, uuid, required
  - `description` string, required
  - `source_params` union, required
    - WebV0Params — Parameters for web v0 sources.
      - `name` 'web_v0'
      - `urls` string[], required — List of URLs to crawl.
      - `include_regex` string, nullable — Regex pattern to include URLs that match the pattern.
      - `exclude_regex` string, nullable — Regex pattern to exclude URLs that match the pattern.
      - `max_depth` integer — Maximum depth of pages to crawl relative to the root URL.
      - `ignore_sitemap` boolean — Whether to ignore the website sitemap when crawling.
      - `limit` integer — Maximum number of pages to crawl per URL.
      - `allow_backward_links` boolean — Whether to allow the crawler to navigate backwards from the given URL.
      - `allow_external_links` boolean — Whether to allow the crawler to follow links to external websites.
      - `scrape_options` WebV0ScrapeOptions — Web v0 scrape options.
        - `headers` object — HTTP headers to send with each request. Can be used to send cookies, user-agent, etc.
        - `only_main_content` boolean — Whether to only scrape the main content of the page (excluding headers, navs, footers, etc.).
        - `wait_for` integer — Amount of time (in milliseconds) to wait for each page to load before scraping content.
    - NotionV0Params — Parameters for Notion sources.
      - `name` 'notion_v0'
      - `integration_id` string, uuid, required
      - `limit` integer, nullable
      - `max_age_days` integer
    - S3PublicV0Params — Parameters for S3 public sources.
      - `name` 's3_public_v0'
      - `bucket_name` string, required
      - `prefix` string, required
      - `limit` integer, required
    - S3PrivateV0Params — Parameters for S3 private sources.
      - `name` 's3_private_v0'
      - `integration_id` string, uuid, required
      - `bucket_name` string, required
      - `prefix` string, required
      - `limit` integer, required
  - `source_schedule` SourceSchedule, required — Source schedule model.
    - `cron` string, required
    - `utc_offset` integer, required
  - `id` string, uuid, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `deleted_at` string, date-time, nullable, required
  - `status` 'pending' | 'syncing' | 'synced' | 'failed', required — Source status enum.
  - `progress` SourceProgress — Source progress model.
    - `load` StepProgress — Step progress model.
      - `processed_documents` integer, nullable
      - `result_documents` integer, nullable
      - `processed_nodes` integer, nullable
      - `result_nodes` integer, nullable
    - `curate` object, nullable
    - `transform` object, nullable
    - `complete` StepProgress — Step progress model.
      - `processed_documents` integer, nullable
      - `result_documents` integer, nullable
      - `processed_nodes` integer, nullable
      - `result_nodes` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/cleanlab/apis/agility.md) · [All operations](https://skmtc.net/cleanlab/apis/agility/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cleanlab/agility/versions/9e6009a931b6/schema)