Skip to main content

Start a manual sync run

POST 

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

Starts a manual sync run. 409 source_sync_in_progress while a run is queued, running or waiting for budget. 409 invalid_source_state when the source is paused, held, blocked_by_site, disabled_by_admin or deleting (set it active first), and while an earlier held run is unresolved, even if the source was paused and resumed meanwhile. 429 rate_limited (limit_name: web.manual_sync_cooldown_minutes) when the previous run of this source started less than the cooldown ago. 403 domain_blocked, web_sources_disabled or domain_not_verified. The knowledge-base and billing checks of an upload apply (409 knowledge-base state codes, 402 payment_suspended, 503 maintenance_mode). Pages that did not change cost nothing.

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 503 maintenance_mode during maintenance; refused with 403 module_disabled while knowledge bases are switched off on the platform.

Request​

Responses​

Run queued.