Cancel Sync Job | Airweave

Request cancellation of a running sync job.

State lifecycle: PENDING / RUNNING → CANCELLING → CANCELLED

The API immediately marks the job as CANCELLING in the database.
A cancellation signal is sent to the Temporal workflow.
The worker receives the signal, gracefully stops the sync pipeline (cancels worker pool, source stream), and marks the job as CANCELLED.

Already-processed entities are retained in the vector database. If the worker is unresponsive, a background cleanup job will force the transition to CANCELLED after 3 minutes.

Note: Only jobs in PENDING or RUNNING state can be cancelled. Attempting to cancel a COMPLETED, FAILED, or CANCELLED job returns 400.

Request cancellation of a running sync job. **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED` 1. The API immediately marks the job as **CANCELLING** in the database. 2. A cancellation signal is sent to the Temporal workflow. 3. The worker receives the signal, gracefully stops the sync pipeline (cancels worker pool, source stream), and marks the job as **CANCELLED**. Already-processed entities are retained in the vector database. If the worker is unresponsive, a background cleanup job will force the transition to CANCELLED after 3 minutes. **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled. Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection (UUID)

job_idstringRequiredformat: "uuid"

Unique identifier of the sync job to cancel (UUID)

Response

Job with cancellation status

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 nullformat: "date-time"

When the job started execution (ISO 8601)

completed_atstring or nullformat: "date-time"

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

duration_secondsdouble or null

Total execution time in seconds. Null if still running.

entities_insertedinteger or nullDefaults to 0

Number of new entities created during this sync

entities_updatedinteger or nullDefaults to 0

Number of existing entities updated during this sync

entities_deletedinteger or nullDefaults to 0

Number of entities removed during this sync

entities_failedinteger or nullDefaults to 0

Number of entities that failed to process

errorstring or null

Error message if the job failed

error_detailsmap from strings to any or null

Additional error context for debugging

Errors

Request cancellation of a running sync job.

State lifecycle: PENDING / RUNNING → CANCELLING → CANCELLED

The API immediately marks the job as CANCELLING in the database.
A cancellation signal is sent to the Temporal workflow.
The worker receives the signal, gracefully stops the sync pipeline (cancels worker pool, source stream), and marks the job as CANCELLED.

Already-processed entities are retained in the vector database. If the worker is unresponsive, a background cleanup job will force the transition to CANCELLED after 3 minutes.

Note: Only jobs in PENDING or RUNNING state can be cancelled. Attempting to cancel a COMPLETED, FAILED, or CANCELLED job returns 400.

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.source_connections.cancel_job(
7	source_connection_id="550e8400-e29b-41d4-a716-446655440000",
8	job_id="660e8400-e29b-41d4-a716-446655440001",
9	)

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	}