> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.airweave.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.airweave.ai/_mcp/server.

# Cancel Sync Job

POST https://api.airweave.ai/source-connections/{source_connection_id}/jobs/{job_id}/cancel

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.

Reference: https://docs.airweave.ai/api-reference/source-connections/cancel-job-source-connections-source-connection-id-jobs-job-id-cancel-post

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://api.airweave.ai` (Production, default)
- `http://localhost:8001` (Local)

## Request

### Path parameters

- `source_connection_id` (string, required) — Unique identifier of the source connection (UUID)
- `job_id` (string, required) — Unique identifier of the sync job to cancel (UUID)

## Response

### 200

Job with cancellation status

- `id` (string, required) — Unique identifier of the sync job
- `source_connection_id` (string, required) — ID of the source connection this job belongs to
- `status` (enum, required) — Current status: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, or CANCELLING
  - Allowed values: `created`, `pending`, `running`, `completed`, `failed`, `cancelling`, `cancelled`
- `started_at` (string, optional, nullable) — When the job started execution (ISO 8601)
- `completed_at` (string, optional, nullable) — When the job finished (ISO 8601). Null if still running.
- `duration_seconds` (double, optional, nullable) — Total execution time in seconds. Null if still running.
- `entities_inserted` (integer, optional, default: 0) — Number of new entities created during this sync
- `entities_updated` (integer, optional, default: 0) — Number of existing entities updated during this sync
- `entities_deleted` (integer, optional, default: 0) — Number of entities removed during this sync
- `entities_failed` (integer, optional, default: 0) — Number of entities that failed to process
- `error` (string, optional, nullable) — Error message if the job failed
- `error_category` (enum, optional, nullable) — Error category for credential errors (e.g. oauth_credentials_expired)
  - Allowed values: `oauth_credentials_expired`, `api_key_invalid`, `auth_provider_account_gone`, `auth_provider_credentials_invalid`, `usage_limit_exceeded`, `rate_limited`
- `error_details` (map from string to any, optional, nullable) — Additional error context for debugging

## Errors

### 404 Not Found Error

Job Not Found

- `detail` (string, required) — Error message describing what was not found

### 409 Conflict Error

Job Cannot Be Cancelled

- `detail` (string, required) — Error message describing the conflict

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 429 Too Many Requests Error

Rate Limit Exceeded

- `detail` (string, required) — Error message explaining the rate limit

## Types

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "source_connection_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created",
  "started_at": "2024-03-15T12:00:00Z",
  "completed_at": "2024-03-15T12:05:32Z",
  "duration_seconds": 332.5,
  "entities_inserted": 45,
  "entities_updated": 12,
  "entities_deleted": 3,
  "entities_failed": 0
}
```

**SDK Code**

```python
import requests

url = "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel"

headers = {"x-api-key": "<apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```typescript
import { AirweaveSDKClient } from "@airweave/sdk";

const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
await client.sourceConnections.cancelJob("550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001");

```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs/660e8400-e29b-41d4-a716-446655440001/cancel")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```