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

List Source Connections

GET
/source-connections
GET
/source-connections
1import requests
2
3url = "https://api.airweave.ai/source-connections"
4
5headers = {"x-api-key": "<apiKey>"}
6
7response = requests.get(url, headers=headers)
8
9print(response.json())
1[
2  {
3    "id": "550e8400-e29b-41d4-a716-446655440000",
4    "name": "GitHub Docs Repo",
5    "short_name": "github",
6    "readable_collection_id": "documentation-ab123",
7    "created_at": "2024-03-15T09:30:00Z",
8    "modified_at": "2024-03-15T14:22:15Z",
9    "is_authenticated": true,
10    "auth_method": "direct",
11    "status": "active",
12    "entity_count": 0,
13    "federated_search": false
14  }
15]

Retrieve all source connections for your organization.

Returns a lightweight list of source connections with essential fields for display and navigation. Use the collection filter to see connections within a specific collection.

For full connection details including sync history, use the GET /{id} endpoint.

Was this page helpful?
Previous

Get Source Connection

Next
Built with

Authentication

x-api-keystring
API Key authentication via header

Query parameters

collectionstring or nullOptional
Filter by collection readable ID
skipintegerOptional>=0Defaults to 0
Number of connections to skip for pagination
limitintegerOptional1-1000Defaults to 100

Maximum number of connections to return (1-1000)

Response

List of source connections
idstringformat: "uuid"
Unique identifier of the source connection
namestring
Display name of the connection
short_namestring
Source type identifier
readable_collection_idstring
Collection this connection belongs to
created_atstringformat: "date-time"

When the connection was created (ISO 8601)

modified_atstringformat: "date-time"

When the connection was last modified (ISO 8601)

is_authenticatedboolean
Whether the connection has valid credentials
auth_methodenum
Get authentication method from database value.
Allowed values:
statusenum
Compute connection status from current state.
entity_countintegerDefaults to 0
Total number of entities synced from this connection
federated_searchbooleanDefaults to false

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

Errors

422
Unprocessable Entity Error
429
Too Many Requests Error