---
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
      - `include_regex` string, nullable
      - `exclude_regex` string, nullable
      - `max_depth` integer
      - `limit` integer
      - `allow_backward_links` boolean
      - `allow_external_links` boolean
    - NotionParams — Parameters for Notion sources. TODO: Implement this.
      - `name` 'notion'
    - S3PublicV0Params — Parameters for S3 public sources.
      - `name` 's3_public_v0'
      - `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.

## Other responses

- `422` — Validation Error

## Changes

- **2024-10-16** `ef07edf2d4ac` — 1 breaking, 1 info
  - added `#/components/schemas/S3PublicV0Params` to the `items/source_params` response property `oneOf` list for the response status `200`
  - added `s3_public_v0` discriminator mapping keys to the `items/source_params` response property for the response status `200`

[Change history](https://skmtc.dev/cleanlab/apis/agility/changes/api/knowledge_bases/:knowledge_base_id/sources/get.md)

---

[API](https://skmtc.dev/cleanlab/apis/agility.md) · [All operations](https://skmtc.dev/cleanlab/apis/agility/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cleanlab/agility/revisions/36e7c2cdfead/schema)