v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB

webdbs

Trigger a sync now

Queues a sync now. Returns the current run when a sync is already active.

post/webdbs/collections/{collection_id}/sync

Path parameters

collection_idstring required

Collection ID.

Example:col_123

Collection ID.

Query parameters

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Sync queued

collection_idstring required

Collection ID.

run_idstring required

Queued run ID.

queuedboolean required

Whether the run was queued.

Example response

{
  "collection_id": "col_123",
  "run_id": "run_123",
  "queued": true
}