Sync

Get latest sync status

Inspect the most recent sync run for the project, including overall status, the URLs that were processed, and the event log for the run.

Use this to:

  • Detect when an automated POST /api/v2/projects/{slug}/sources/ followed by POST /api/v2/projects/{slug}/sync/ flow has finished (status transitions from running to success/error/warning).
  • Surface failures with actionable context. events includes per-URL warnings and errors.

For lightweight polling, prefer GET /api/v2/projects/{slug}/ and read its last_sync summary instead. It returns the same status and timestamps without the full event log.

Returns 404 when the project has never been synced.

Required permission: sync_read

get/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 status retrieved successfully

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).

urlsstring[] required

URLs processed in this run.

Changes

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