Run Sync | Airweave

Trigger a data synchronization job for a source connection.

Starts an asynchronous sync job that pulls the latest data from the connected source. The job runs in the background and you can monitor its progress using the jobs endpoint.

For continuous sync connections, this performs an incremental sync by default. Use force_full_sync=true to perform a complete re-sync of all data.

Trigger a data synchronization job for a source connection. Starts an asynchronous sync job that pulls the latest data from the connected source. The job runs in the background and you can monitor its progress using the jobs endpoint. For continuous sync connections, this performs an incremental sync by default. Use `force_full_sync=true` to perform a complete re-sync of all data.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection to sync (UUID)

Query parameters

force_full_syncbooleanOptionalDefaults to false

Force a full sync ignoring cursor data. Only applies to continuous sync connections. Non-continuous connections always perform full syncs.

Response

Created sync job

idstringformat: "uuid"

Unique identifier of the sync job

source_connection_idstringformat: "uuid"

ID of the source connection this job belongs to

statusenum

Current status: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, or CANCELLING

started_atstring or nullOptionalformat: "date-time"

When the job started execution (ISO 8601)

completed_atstring or nullOptionalformat: "date-time"

When the job finished (ISO 8601). Null if still running.

duration_secondsdouble or nullOptional

Total execution time in seconds. Null if still running.

entities_insertedintegerOptionalDefaults to 0

Number of new entities created during this sync

entities_updatedintegerOptionalDefaults to 0

Number of existing entities updated during this sync

entities_deletedintegerOptionalDefaults to 0

Number of entities removed during this sync

entities_failedintegerOptionalDefaults to 0

Number of entities that failed to process

errorstring or nullOptional

Error message if the job failed

error_categoryenum or nullOptional

Error category for credential errors (e.g. oauth_credentials_expired)

error_detailsmap from strings to any or nullOptional

Additional error context for debugging

Errors

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	import requests
2
3	url = "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/run"
4
5	headers = {"x-api-key": "<apiKey>"}
6
7	response = requests.post(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "770e8400-e29b-41d4-a716-446655440002",
3	"source_connection_id": "550e8400-e29b-41d4-a716-446655440000",
4	"status": "created",
5	"started_at": "2024-03-15T12:00:00Z",
6	"completed_at": "2024-03-15T12:05:32Z",
7	"duration_seconds": 332.5,
8	"entities_inserted": 45,
9	"entities_updated": 12,
10	"entities_deleted": 3,
11	"entities_failed": 0
12	}