Sync

Start a sync

Re-crawl all project sources and update the search index. Returns immediately; the crawl runs in the background. Poll GET /api/v2/projects/{slug}/sync/, or the last_sync field from GET /api/v2/projects/{slug}/, to track completion.

Calling this endpoint while a sync is already running cancels the in-progress run and starts a fresh one.

When only one page changed, use POST /api/v2/projects/{slug}/recrawl/ instead. It replaces that page in the existing index and leaves the rest of the project untouched.

Rate limits may apply to this endpoint.

Required permission: sync_create

post/api/v2/projects/{slug}/sync/

Request

  • Base URL: https://app.biel.ai
  • URL: https://app.biel.ai/api/v2/projects/{slug}/sync/
  • Auth: API key in header Authorization

Path parameters

slugstring required

Project slug identifier.

Response

Sync started. Poll the returned uuid via GET /api/v2/projects/{slug}/sync/{sync_uuid}/.

uuidstring uuid required

UUID of the sync run.

status'running' | 'success' | 'error' | 'warning' | 'canceled' required
  • running: crawl is in progress.
  • success: crawl finished without errors.
  • warning: crawl finished with non-fatal warnings (some URLs may have failed).
  • error: crawl failed.
  • canceled: a newer POST /api/v2/projects/{slug}/sync/ call superseded this run.
started_atstring date-time required

ISO-8601 timestamp of when the run started.

finished_atstring date-time nullable

ISO-8601 timestamp of when the run finished, or null while status is running.

total_sourcesinteger required

Total number of sources processed in this run, including expanded entries (for example, individual files of a repository).

Changes

No recorded changes to this operation across all 1 revision of this API.