Start a knowledge base sync job

POST 
/ai/knowledgebases/:id/sync

Starts an asynchronous sync and returns JobRunId. Requires editor access. Unstructured: omit SourceIds to sync all attached sources (ExecutionScope KnowledgeBase). If SourceIds is present, those Bedrock source IDs are synced (ExecutionScope Datasource) and must already be attached. Structured: the body is ignored and the whole knowledge base is synced. Fails if a JobRun is already RUNNING, if no sources are attached, or if an unstructured embedding model is not assigned.

Request

Responses

200

Sync job started. Returns Message and JobRunId.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

Input validation or authorization failure. Body is {"Message": " - "}. Codes: IPV-1002 (KB not found), AI-1009 (no sources or embedding model not assigned), IPV-1078 (sync already RUNNING or invalid SourceIds), AUTH-1001 (missing role_id), AUTH-1012 (editor required), AUTH-1011 (caller not authorized).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Backend failure. Body is {"Message": " - "}. Codes: GE-1085 (unexpected backend failure), DB-1002 (persistence failure).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers