Run Source Connection

Trigger a sync run for a source connection.

Args: db: The database session source_connection_id: The ID of the source connection to run access_token: Optional access token to use instead of stored credentials auth_context: The current authentication context background_tasks: Background tasks for async operations

Returns: The created sync job

Path parameters

source_connection_idstringRequired

Request

This endpoint expects an object.

access_tokenstringOptional

Response

Successful Response

source_connection_idstringformat: "uuid"

idstringformat: "uuid"

organization_idstringformat: "uuid"

created_by_emailstring or nullformat: "email"

modified_by_emailstring or nullformat: "email"

created_atdatetime or null

modified_atdatetime or null

statusenum or null

Sync job status enum.

entities_insertedinteger or null

entities_updatedinteger or null

entities_deletedinteger or null

entities_keptinteger or null

entities_skippedinteger or null

entities_encounteredmap from strings to optional integers or null

started_atdatetime or null

completed_atdatetime or null

failed_atdatetime or null

errorstring or null

1	{
2	"source_connection_id": "source_connection_id",
3	"id": "id",
4	"organization_id": "organization_id",
5	"created_by_email": "created_by_email",
6	"modified_by_email": "modified_by_email",
7	"created_at": "2024-01-15T09:30:00Z",
8	"modified_at": "2024-01-15T09:30:00Z",
9	"status": "created",
10	"entities_inserted": 1,
11	"entities_updated": 1,
12	"entities_deleted": 1,
13	"entities_kept": 1,
14	"entities_skipped": 1,
15	"entities_encountered": {
16	"key": 1
17	},
18	"started_at": "2024-01-15T09:30:00Z",
19	"completed_at": "2024-01-15T09:30:00Z",
20	"failed_at": "2024-01-15T09:30:00Z",
21	"error": "error"
22	}

Run Source Connection

Path parameters

Headers

Request

Response

Errors

1	curl -X POST https://api.airweave.ai/source-connections/source_connection_id/run \
2	-H "Content-Type: application/json" \
3	-d '{}'