Create a crawl source
Register a website as a crawl source for a knowledge base. The crawler fetches pages under root_url (same host only, static HTML — no JavaScript rendering, max 2 MB per page), indexes them as documents and charges credits per crawled page. Trigger a crawl with POST /knowledge-bases/{id}/crawl-sources/{sourceId}/run, or enable auto_sync for periodic re-crawls. Required scope: knowledge:write (keys without scope restrictions have full access).
Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.
Path Parameters
Knowledge base ID.
Body
Root URL to crawl (http/https).
Optional path prefixes to restrict crawling (e.g. ["/docs"]). Empty = whole host.
Optional path prefixes to skip (e.g. ["/admin"]). Max 200 per source, 500 per knowledge base.
Maximum pages per run. Default 50.
1 <= x <= 500Re-crawl automatically on a schedule. Default false.
Hours between auto-sync crawls. Default 24.
x >= 1Response
The created crawl source.