Get Sync Status Overview

Check if there are any running sync operations for the current user.

This endpoint provides a simple check to see if the user has any active sync operations without needing to know specific run IDs.

Response

Returns a simple status overview:

• has_running_sync: Boolean indicating if there are any running syncs
• running_sync_count: Number of currently running sync operations
• latest_running_sync (optional): Information about the most recent running sync if any exists

Example Usage

curl -X GET "http://localhost:8000/api/v1/sync/status" \
  -H "Cookie: auth_token=your-token"

Example Responses

No running syncs:

{
  "has_running_sync": false,
  "running_sync_count": 0
}

With running sync:

{
  "has_running_sync": true,
  "running_sync_count": 1,
  "latest_running_sync": {
    "run_id": "12345678-1234-5678-9012-123456789012",
    "dataset_name": "My Dataset",
    "progress_percentage": 45,
    "created_at": "2025-01-01T00:00:00Z"
  }
}

GET /api/v1/sync/status

Get Sync Status Overview

cURL

curl --request GET \
  --url https://{tenant}.aws.cognee.ai/api/v1/sync/status \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuthApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response