---
title: "Add a website crawl source"
method: POST
path: "/public/v1/knowledge-bases/{knowledgeBaseId}/website-crawls"
tags: ["Knowledge Bases"]
---

# Add a website crawl source

`POST /public/v1/knowledge-bases/{knowledgeBaseId}/website-crawls`

Starts a website crawl that discovers and indexes pages under the given URL. Requires a USER API key.

## Path parameters

- `knowledgeBaseId` integer, required

## Request body

- PublicKnowledgeWebsiteCrawlInput
  - `description` string
  - `sourceUrl` string, uri, required
  - `websiteType` 'WEBSITE_CRAWL' | 'SITEMAP', required
  - `maxDepth` integer
  - `maxLinks` integer, required
  - `includePaths` string[]
  - `excludePaths` string[]
  - `scrapeOptions` object
    - `includeSelectors` string[]
    - `excludeSelectors` string[]
  - `autoSyncFrequency` 'NONE' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

## Response `201`

Created website crawl source

- PublicKnowledgeWebsiteCrawl
  - `id` number, required
  - `name` string, required
  - `description` string
  - `sourceUrl` string, uri, required
  - `websiteType` 'WEBSITE_CRAWL' | 'SITEMAP', required
  - `maxDepth` integer
  - `maxLinks` integer, required
  - `includePaths` string[]
  - `excludePaths` string[]
  - `scrapeOptions` object, nullable
    - `includeSelectors` string[]
    - `excludeSelectors` string[]
  - `autoSyncFrequency` 'NONE' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

## Other responses

- `404` — Not Found

---

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