Sync

Get a sync run

Retrieve a specific sync run by UUID. Returns the same shape as GET /api/v2/projects/{slug}/sync/, but addresses a single run instead of the latest one. Use the uuid returned by POST /api/v2/projects/{slug}/sync/.

Required permission: sync_read

get/api/v2/projects/{slug}/sync/{sync_uuid}/

Request

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

Path parameters

slugstring required

Project slug identifier.

sync_uuidstring uuid required

UUID of the sync run to retrieve.

Response

Sync run 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.