For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Fork this repoGet a demo
  • Docs
    • Welcome
    • Quickstart
    • Concepts
    • Search
    • MCP Server
    • CLI
    • Agent Skills
    • Connect
    • Add New Connector
    • Rate Limits
  • API Reference
      • GETList Source Connections
      • GETGet Source Connection
      • GETList Sync Jobs
      • POSTCreate Source Connection
      • PATCHUpdate Source Connection
      • POSTRun Sync
      • POSTCancel Sync Job
      • DELDelete Source Connection
LogoLogo
Fork this repoGet a demo
API ReferenceSource Connections

Delete Source Connection

DELETE
/source-connections/:source_connection_id
DELETE
/source-connections/:source_connection_id
1import requests
2
3url = "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000"
4
5headers = {"x-api-key": "<apiKey>"}
6
7response = requests.delete(url, headers=headers)
8
9print(response.json())
1{
2  "id": "550e8400-e29b-41d4-a716-446655440000",
3  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
4  "name": "GitHub Docs Repo",
5  "short_name": "github",
6  "readable_collection_id": "documentation-ab123",
7  "status": "active",
8  "created_at": "2024-03-15T09:30:00Z",
9  "modified_at": "2024-03-15T14:22:15Z",
10  "auth": {
11    "method": "direct",
12    "authenticated": true,
13    "authenticated_at": "2024-03-15T09:30:00Z"
14  },
15  "description": "Main documentation repository",
16  "config": {
17    "branch": "main",
18    "repo_name": "company/docs"
19  },
20  "schedule": {
21    "cron": "0 */6 * * *",
22    "next_run": "2024-03-15T18:00:00Z"
23  },
24  "sync": {
25    "total_runs": 15,
26    "successful_runs": 14,
27    "failed_runs": 1,
28    "last_job": {
29      "id": "770e8400-e29b-41d4-a716-446655440002",
30      "status": "created",
31      "started_at": "2024-03-15T12:00:00Z",
32      "completed_at": "2024-03-15T12:05:32Z",
33      "duration_seconds": 332,
34      "entities_inserted": 45,
35      "entities_updated": 12
36    }
37  },
38  "entities": {
39    "total_entities": 1250,
40    "by_type": {
41      "file": {
42        "count": 1250
43      }
44    }
45  },
46  "federated_search": false
47}
Permanently delete a source connection and all its synced data. **What happens when you delete:** 1. Any running sync is cancelled and the API waits (up to 15 s) for the worker to stop writing. 2. The source connection, sync configuration, job history, and entity metadata are cascade-deleted from the database. 3. 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.
Was this page helpful?
Previous

List Sources

Next
Built with

Permanently delete a source connection and all its synced data.

What happens when you delete:

  1. Any running sync is cancelled and the API waits (up to 15 s) for the worker to stop writing.
  2. The source connection, sync configuration, job history, and entity metadata are cascade-deleted from the database.
  3. 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 null
Optional description of the connection's purpose
configmap from strings to any or null

Source-specific configuration values

scheduleobject or null
Sync schedule configuration
syncobject or null
Sync execution history and statistics
sync_idstring or nullformat: "uuid"

ID of the associated sync (internal use)

entitiesobject or null
Summary of synced entities by type
error_categoryenum or null

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

error_messagestring or null

Human-readable error message when status is needs_reauth

provider_settings_urlstring or null

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

provider_short_namestring or null

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

federated_searchbooleanDefaults 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