Delete Source Connection

import requests
url = "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000"
headers = {"x-api-key": "<apiKey>"}
response = requests.delete(url, headers=headers)
print(response.json())

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "GitHub Docs Repo",
  "short_name": "github",
  "readable_collection_id": "documentation-ab123",
  "status": "active",
  "created_at": "2024-03-15T09:30:00Z",
  "modified_at": "2024-03-15T14:22:15Z",
  "auth": {
    "method": "direct",
    "authenticated": true,
    "authenticated_at": "2024-03-15T09:30:00Z"
  },
  "description": "Main documentation repository",
  "config": {
    "branch": "main",
    "repo_name": "company/docs"
  },
  "schedule": {
    "cron": "0 */6 * * *",
    "next_run": "2024-03-15T18:00:00Z"
  },
  "sync": {
    "total_runs": 15,
    "successful_runs": 14,
    "failed_runs": 1,
    "last_job": {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "status": "created",
      "started_at": "2024-03-15T12:00:00Z",
      "completed_at": "2024-03-15T12:05:32Z",
      "duration_seconds": 332,
      "entities_inserted": 45,
      "entities_updated": 12
    }
  },
  "entities": {
    "total_entities": 1250,
    "by_type": {
      "file": {
        "count": 1250
      }
    }
  },
  "federated_search": false
}

Permanently delete a source connection and all its synced data.

What happens when you delete:

Any running sync is cancelled and the API waits (up to 15 s) for the worker to stop writing.
The source connection, sync configuration, job history, and entity metadata are cascade-deleted from the database.
A background cleanup workflow is scheduled to remove data from the vector database (Vespa) and raw data storage (ARF). This may take several minutes for large datasets but does not block the response.

The API returns immediately after step 2. Vector database cleanup happens asynchronously — the data becomes unsearchable as soon as the database records are deleted.

Warning: This action cannot be undone.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection to delete (UUID)

Response

Deleted source connection

idstringformat: "uuid"

Unique identifier of the source connection

organization_idstringformat: "uuid"

Organization this connection belongs to

namestring

Display name of the connection

short_namestring

Source type identifier

readable_collection_idstring

Collection this connection belongs to

statusenum

Current operational status of the connection

created_atstringformat: "date-time"

When the connection was created (ISO 8601)

modified_atstringformat: "date-time"

When the connection was last modified (ISO 8601)

authobject

Authentication status and details

descriptionstring or nullOptional

Optional description of the connection's purpose

configmap from strings to any or nullOptional

Source-specific configuration values

scheduleobject or nullOptional

Sync schedule configuration

syncobject or nullOptional

Sync execution history and statistics

sync_idstring or nullOptionalformat: "uuid"

ID of the associated sync (internal use)

entitiesobject or nullOptional

Summary of synced entities by type

error_categoryenum or nullOptional

Error category when status is needs_reauth (e.g. oauth_credentials_expired)

error_messagestring or nullOptional

Human-readable error message when status is needs_reauth

provider_settings_urlstring or nullOptional

URL to the auth provider's settings dashboard (for auth_provider errors)

provider_short_namestring or nullOptional

Auth provider short_name (e.g. 'composio', 'pipedream') for display

federated_searchbooleanOptionalDefaults to false

Whether this source uses federated (real-time) search instead of syncing

Errors

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error