Skip to main content

Discover a website without adding it (asynchronous; poll the preview)

POST 

/v1/knowledge_bases/:kb_id/sources:preview

Discovers a website without adding it: no source, page or run is stored, only the preview. Checked at once: URL rules (422 https_required, source_url_rejected), domain blocked by the platform (403 domain_blocked), website sources switched off (403 web_sources_disabled) and previews per hour (429 rate_limited, limit_name: web.previews_per_hour). The discovery itself runs asynchronously (at most 20 requests to the site, within the site's shared request budget): poll GET …/source_previews/{preview_id} until status is completed or failed, typically a few seconds. A preview is kept for 1 hour. Replaying the request with the same Idempotency-Key returns the original 202 body and counts once against the hourly limit.

Access: API key scope knowledge:write; portal users: organization admins and owners; the knowledge base in the path must be on the key's access list; refused with 403 module_disabled while knowledge bases are switched off on the platform.

Request​

Responses​

Preview started.