Skip to main content
POST
Create a website datasource

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
display_name
string
page_limit
integer | null
default:100
Required range: 1 <= x <= 5000
exclude_paths
string[]
include_paths
string[]
crawl_interval_hours
integer | null
default:168
Required range: 24 <= x <= 9007199254740991
auto_start_crawl
boolean
default:true
restricted_to_channels
enum<string>[]
Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice,
twitter,
twitter_mentions,
app_review
auth
object

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
url
string
required
display_name
string
required
status
string
required
page_limit
number | null
required
exclude_paths
string[]
required
include_paths
string[]
required
crawl_interval_hours
number | null
required
restricted_to_channels
enum<string>[]
required

Channels this datasource is restricted to. Empty = available on all channels.

Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice,
twitter,
twitter_mentions,
app_review
last_crawl_started_at
string<date-time> | null
required
last_crawl_completed_at
string<date-time> | null
required
error_message
string | null
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
enum<string> | null
required

Configured auth type, or null when auth is not set.

Available options:
basic,
bearer,
cookie,
headers