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
- 202
- 402
- 403
- 404
- 409
- 429
- 503
Run queued.
trial_exhausted, insufficient_credits, credit_limit_exceeded, payg_spend_cap_exceeded, payment_suspended — details.price_card_url always set. After the free trial, knowledge bases are billed pay-as-you-go for every organization (from the prepaid wallet or on the postpaid invoice); no plan or commitment covers them.
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
rate_limited, concurrency_limited — Retry-After header set
maintenance_mode, knowledge_unavailable, retrieval_unavailable, billing_unavailable — Retry-After header set