v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-222763184.3 KB

sources

List Sources

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

get/sources

Response

Successful Response

namestring required

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

descriptionstring nullable

Detailed description explaining what data this source can extract and its typical use cases.

auth_methodsstring[] nullable

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

oauth_typestring nullable

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

requires_byocboolean

Whether this OAuth source requires users to bring their own client.

auth_config_classstring nullable

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

config_classstring nullable

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

short_namestring required

Technical identifier used internally to reference this source type. Must be unique across all sources.

class_namestring required

Python class name of the source implementation that handles data extraction logic.

output_entity_definitionsstring[]

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

labelsstring[] nullable

Categorization tags to help users discover and filter sources by domain or use case.

supports_continuousboolean

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

federated_searchboolean

Whether this source uses federated search instead of traditional syncing.

supports_temporal_relevanceboolean

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

supports_access_controlboolean

Whether this source supports document-level access control.

rate_limit_levelstring nullable

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

feature_flagstring nullable

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

supports_browse_treeboolean

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

supported_auth_providersstring[] nullable

List of auth provider short names that support this source.