Skip to main content

Rename, change the scope, pause or resume a website source

PATCH 

/v1/knowledge_bases/:kb_id/sources/:source_id

Status changes: active, syncing, held or blocked_by_site → paused; paused or blocked_by_site → active; anything else is 409 invalid_source_state. Pausing cancels a running sync. Resuming a source that still has an unresolved held run returns it to held. Resuming a source whose domain is blocked by the platform is 403 domain_blocked.

A scope change applies from the next run; pages that fall out of scope are then removed (subject to the deletion hold). scope and schedule merge per top-level key: a key you send replaces that key (arrays as a whole), a key you leave out keeps its value. reinclude_urls makes pages eligible again that are excluded because you deleted their documents. Switching schedule on or changing its interval needs a verified domain (403 domain_not_verified) and interval_hours of at least web.limits.min_refresh_hours of GET /v1/knowledge_module; switching it off ({"enabled": false}) always works. render (off, auto, always) can be set on any source; it takes effect from the next run, and only while the domain is verified and JavaScript rendering is enabled on the platform (render_active).

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.

Request​

Responses​

OK