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
- 200
- 403
- 404
- 409
- 422
OK
scope_missing, kb_not_in_allowlist, role_insufficient, actor_not_permitted, tenant_suspended, module_disabled (knowledge bases switched off on the platform: an operation that creates data or starts processing, for an organization that still has knowledge bases), web_sources_disabled, domain_blocked, domain_not_verified (website sources)
not_found (absent or owned by another organization — identical), module_disabled
idempotency_key_conflict, idempotency_in_progress, version_conflict, duplicate_content, kb_suspended, kb_deleting, document_deleting, document_not_ready, invalid_document_state, trial_kb_frozen, resource_limit_reached, export_in_progress, source_sync_in_progress, invalid_source_state, duplicate_source
validation_failed, invalid_identifier, metadata_*, filter_invalid, query_too_long, batch_too_large, file-type codes, https_required, source_url_rejected, robots_disallowed, ai_signal_optout, attestation_required, terms_acceptance_required