---
title: "List sources"
method: GET
path: "/api/v2/projects/{slug}/sources/"
tags: ["Sources"]
---

# List sources

`GET /api/v2/projects/{slug}/sources/`

## Request

- Base URL: `https://app.biel.ai`
- URL: `https://app.biel.ai/api/v2/projects/{slug}/sources/`
- Auth: API key in header `Authorization`

List all sources associated with a project. Results are paginated.

**Required permission:** `sources_read`

## Path parameters

- `slug` string, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Sources listed successfully

- SourceList: Paginated list of sources.
  - `count` integer, required: Total number of sources matching the query.
  - `next` string, uri, nullable: URL of the next page, or `null` if this is the last page.
  - `previous` string, uri, nullable: URL of the previous page, or `null` if this is the first page.
  - `results` Source[], required
    - union: A single project source. The `type` field determines the concrete shape.
      - FileSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
      - UrlSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `url` string, uri: The crawled URL.
      - SitemapSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `url` string, uri: The sitemap URL.
      - SitePageSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `url` string, uri: Original URL the page maps to.
      - HostedSiteSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `base_url` string, uri: Original base URL of the site.
        - `hosted_url` string, uri: URL where Biel.ai serves the uploaded site.
        - `page_count` integer: Number of indexed pages.
      - RepositorySource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `url` string, uri: Repository URL.
      - OpenApiSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `url` string, uri: Specification URL (JSON or YAML).
      - ConfluenceSource: Properties shared by every source type.
        - `uuid` string, uuid, required: Source UUID.
        - `type` 'file' | 'url' | 'sitemap' | 'site' | 'hosted_site' | 'repository' | 'openapi' | 'confluence', required: Source type.
        - `name` string, required: Display name (file name, URL, repository name, etc.).
        - `created_at` string, date-time: ISO-8601 timestamp of when the source was added.
        - `space_key` string: Confluence space key.
        - `base_url` string, uri: Confluence base URL.

## Other responses

- `403`: Forbidden. Missing permissions.
- `404`: Resource not found.

---

[API](https://skmtc.dev/biel/apis/biel-ai-api.md) · [All operations](https://skmtc.dev/biel/apis/biel-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/biel/apis/biel-ai-api/revisions/ac7034d82696?raw)