Read Sources

List all available data source connectors.

Returns the complete catalog of source types that Airweave can connect to.

Successful Response

namestring

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

auth_config_classstring

Python class name that defines the authentication configuration fields required for this source.

config_classstring

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

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.

idstringformat: "uuid"

Unique system identifier for this source type. Generated automatically when the source is registered.

created_atstringformat: "date-time"

Timestamp when this source type was registered in the system (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when this source type was last updated (ISO 8601 format).

auth_fieldsobject

Schema definition for authentication fields required to connect to this source. Describes field types, validation rules, and user interface hints.

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_typeenum or null

Type of authentication mechanism required by this source (e.g., ‘oauth2’).

output_entity_definition_idslist of strings or null

List of entity definition IDs that this source can produce. Defines the data schema and structure that this connector outputs.

organization_idstring or nullformat: "uuid"

Organization identifier for custom source connectors. System sources have this set to null.

labelslist of strings or null

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

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.sources.read_sources()

1	[
2	{
3	"name": "GitHub",
4	"auth_config_class": "GitHubAuthConfig",
5	"config_class": "GitHubConfig",
6	"short_name": "github",
7	"class_name": "GitHubSource",
8	"id": "550e8400-e29b-41d4-a716-446655440000",
9	"created_at": "2024-01-01T00:00:00Z",
10	"modified_at": "2024-01-01T00:00:00Z",
11	"auth_fields": {
12	"fields": [
13	{
14	"name": "personal_access_token",
15	"title": "Personal Access Token",
16	"type": "string",
17	"description": "GitHub Personal Access Token with repository read permissions",
18	"secret": true
19	},
20	{
21	"name": "repo_name",
22	"title": "Repository Name",
23	"type": "string",
24	"description": "Full repository name in format 'owner/repo'"
25	}
26	]
27	},
28	"config_fields": {
29	"fields": [
30	{
31	"name": "string",
32	"title": "string",
33	"type": "string"
34	}
35	]
36	},
37	"description": "Connect to GitHub repositories for code, issues, pull requests, and documentation",
38	"auth_type": "config_class",
39	"output_entity_definition_ids": [
40	"def12345-6789-abcd-ef01-234567890abc",
41	"def67890-abcd-ef01-2345-67890abcdef1"
42	],
43	"labels": [
44	"code"
45	]
46	}
47	]