---
title: "Create a website datasource"
method: POST
path: "/crawl"
tags: ["Crawl"]
---

# Create a website datasource

`POST /crawl`

Create a new website datasource and optionally start an initial crawl. Crawled content is automatically indexed into your knowledge base.

## Request body

- CreateWebsiteDatasourceDto
  - `url` string, uri, required
  - `display_name` string
  - `page_limit` integer, nullable
  - `exclude_paths` string[]
  - `include_paths` string[]
  - `crawl_interval_hours` integer, nullable
  - `auto_start_crawl` boolean
  - `restricted_to_channels` SessionChannel[]
  - `auth` union
    - object
      - `type` 'basic', required
      - `username` string, required
      - `password` string, required
    - object
      - `type` 'bearer', required
      - `token` string, required
    - object
      - `type` 'cookie', required
      - `value` string, required
    - object
      - `type` 'headers', required
      - `headers` object, required

## Response `201`

Default Response

- CrawlDatasource
  - `id` string, uuid, required
  - `url` string, required
  - `display_name` string, required
  - `status` string, required
  - `page_limit` number, nullable, required
  - `exclude_paths` string[], required
  - `include_paths` string[], required
  - `crawl_interval_hours` number, nullable, required
  - `restricted_to_channels` SessionChannel[], required — Channels this datasource is restricted to. Empty = available on all channels.
  - `last_crawl_started_at` string, date-time, nullable, required
  - `last_crawl_completed_at` string, date-time, nullable, required
  - `error_message` string, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `auth_configured` boolean, required — Whether optional Firecrawl site auth is configured. Secrets are never returned.
  - `auth_type` 'basic' | 'bearer' | 'cookie' | 'headers', nullable, required — Configured auth type, or null when auth is not set.

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.net/open/apis/opencx-api.md) · [All operations](https://skmtc.net/open/apis/opencx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open/opencx-api/revisions/57b06b52302d/schema)
