AIairweave-ai
sources

Get Source

Changed on

Retrieve detailed information about a specific data source connector.

Returns the complete configuration for a source type, including:

  • Authentication fields: Schema for credentials required to connect
  • Configuration fields: Schema for optional settings and customization
  • Supported auth providers: Pre-configured OAuth providers available for this source

Use this endpoint before creating a source connection to understand what authentication and configuration values are required.

get/sources/{short_name}

Request

  • Base URL
    https://api.airweave.ai
  • Auth
    API key in header x-api-key

Path parameters

short_namestring required

Technical identifier of the source type (e.g., 'github', 'stripe', 'slack')

Example:github

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.

Changes

  • a944d305e967Revision changes
    • info

      added the optional property to the response with the status

  • dcef44679b67Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status