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 Sources
      • GETGet Source
LogoLogo
Fork this repoGet a demo
API ReferenceSources

List Sources

GET
/sources
GET
/sources
1import requests
2
3url = "https://api.airweave.ai/sources"
4
5headers = {"x-api-key": "<apiKey>"}
6
7response = requests.get(url, headers=headers)
8
9print(response.json())
1[
2  {
3    "name": "GitHub",
4    "short_name": "github",
5    "class_name": "GitHubSource",
6    "config_fields": {
7      "fields": [
8        {
9          "name": "string",
10          "title": "string",
11          "type": "string"
12        }
13      ]
14    },
15    "description": "Connect to GitHub repositories for code, issues, pull requests, and documentation",
16    "auth_config_class": "GitHubAuthConfig",
17    "config_class": "GitHubConfig",
18    "labels": [
19      "code"
20    ],
21    "auth_fields": {
22      "fields": [
23        {
24          "name": "personal_access_token",
25          "title": "Personal Access Token",
26          "type": "string",
27          "description": "GitHub Personal Access Token with repository read permissions",
28          "secret": true
29        },
30        {
31          "name": "repo_name",
32          "title": "Repository Name",
33          "type": "string",
34          "description": "Full repository name in format 'owner/repo'"
35        }
36      ]
37    },
38    "id": "550e8400-e29b-41d4-a716-446655440000",
39    "auth_type": "config_class",
40    "output_entity_definition_ids": [
41      "def12345-6789-abcd-ef01-234567890abc",
42      "def67890-abcd-ef01-2345-67890abcdef1"
43    ],
44    "created_at": "2024-01-01T00:00:00Z",
45    "modified_at": "2024-01-01T00:00:00Z"
46  }
47]
Retrieve all available data source connectors. Returns the complete catalog of source types that Airweave can connect to, including their authentication methods, configuration requirements, and supported features. Use this endpoint to discover which integrations are available for your organization. Each source includes: - **Authentication methods**: How to connect (OAuth, API key, etc.) - **Configuration schemas**: What settings are required or optional - **Supported auth providers**: Pre-configured OAuth providers available
Was this page helpful?
Previous

Get Source

Next
Built with

Retrieve all available data source connectors.

Returns the complete catalog of source types that Airweave can connect to, including their authentication methods, configuration requirements, and supported features. Use this endpoint to discover which integrations are available for your organization.

Each source includes:

  • Authentication methods: How to connect (OAuth, API key, etc.)
  • Configuration schemas: What settings are required or optional
  • Supported auth providers: Pre-configured OAuth providers available

Authentication

x-api-keystring
API Key authentication via header

Response

Successful Response
namestring

Human-readable name of the data source connector (e.g., ‘GitHub’, ‘Stripe’, ‘PostgreSQL’).

short_namestring
Technical identifier used internally to reference this source type. Must be unique across all sources.
class_namestring
Python class name of the source implementation that handles data extraction logic.
config_fieldsobject
Schema definition for configuration fields required to customize this source.
descriptionstring or null
Detailed description explaining what data this source can extract and its typical use cases.
auth_methodslist of strings or null

List of supported authentication methods (e.g., ‘direct’, ‘oauth_browser’).

oauth_typestring or null

OAuth token type for OAuth sources (e.g., ‘access_only’, ‘with_refresh’).

requires_byocbooleanDefaults to false
Whether this OAuth source requires users to bring their own client.
auth_config_classstring or null

Python class name that defines the authentication configuration fields required for this source (only for DIRECT auth).

config_classstring or null

Python class name that defines the source-specific configuration options and parameters.

output_entity_definitionslist of strings

List of entity definition short names that this source can produce (e.g., [‘asana_task_entity’, ‘asana_project_entity’]).

labelslist of strings or null
Categorization tags to help users discover and filter sources by domain or use case.
supports_continuousbooleanDefaults to false

Whether this source supports cursor-based continuous syncing for incremental data extraction.

federated_searchbooleanDefaults to false
Whether this source uses federated search instead of traditional syncing.
supports_temporal_relevancebooleanDefaults to true

Whether this source’s entities have timestamps that enable recency-based ranking.

supports_access_controlbooleanDefaults to false

Whether this source supports document-level access control.

rate_limit_levelstring or null

Rate limiting level for this source: ‘org’ (organization-wide), ‘connection’ (per-connection/per-user), or None (no rate limiting).

feature_flagstring or null

Feature flag required to access this source. If set, only organizations with this feature enabled can see/use this source.

supports_browse_treebooleanDefaults to false

Whether this source supports lazy-loaded browse tree for selective node syncing.

auth_fieldsobject or null
Schema definition for authentication fields required to connect to this source.
supported_auth_providerslist of strings or null
List of auth provider short names that support this source.

Errors

422
Unprocessable Entity Error
429
Too Many Requests Error