API ReferenceSources

Get Source

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.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

short_namestringRequired

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

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. Describes field types, validation rules, and user interface hints.
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_byocboolean or nullDefaults 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 or null

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_continuousboolean or nullDefaults to false

Whether this source supports cursor-based continuous syncing for incremental data extraction. Sources with this capability can track their sync position and resume from where they left off.

supports_temporal_relevanceboolean or nullDefaults to true

Whether this source’s entities have timestamps that enable recency-based ranking. Sources without file-level timestamps (e.g., code repositories) cannot use temporal relevance for search result weighting.

supports_access_controlboolean or nullDefaults to false

Whether this source supports document-level access control. Sources with this capability extract ACL information from the source and apply it during search to filter results based on user permissions.

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.

auth_fieldsobject or null
Schema definition for authentication fields required to connect to this source. Only present for sources using DIRECT authentication. OAuth sources handle authentication through browser flows.
supported_auth_providerslist of strings or null

List of auth provider short names that support this source (e.g., [‘composio’, ‘pipedream’]). Computed dynamically for API responses. This field is not stored in the database.

Errors