Skip to main content

Sync

Sync endpoints let you monitor and control the synchronization between source tables and vector tables.

Sync Status

GET /v1/vector-tables/{vector_table_id}/sync/status

Response (200):

{
"vector_table_id": "vt_abc123",
"sync_status": "synced",
"last_sync_at": "2025-01-15T10:30:00Z",
"rows_pending": 0,
"staleness_secs": 120,
"last_error": null,
"last_error_at": null
}

Sync Statuses

StatusDescription
pendingVector table created, no backfill run yet
backfillingInitial backfill in progress
syncedUp to date and actively syncing
pausedSync manually paused
errorLast sync failed (see last_error)
pending_rebackfillConfiguration changed, needs re-backfill with atomic swap

Pause Sync

POST /v1/vector-tables/{vector_table_id}/sync/pause

Pauses automatic sync for the vector table. Queries continue to work against existing vectors.

Returns 409 Conflict if sync is already paused.

Response (200):

{
"vector_table_id": "vt_abc123",
"sync_status": "paused",
"message": "Sync has been paused"
}

Resume Sync

POST /v1/vector-tables/{vector_table_id}/sync/resume

Resumes a paused sync. Only works when status is paused.

Response (200):

{
"vector_table_id": "vt_abc123",
"sync_status": "synced",
"message": "Sync has been resumed"
}