> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.airweave.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.airweave.ai/_mcp/server.

# Get Source

GET https://api.airweave.ai/sources/{short_name}

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.

Reference: https://docs.airweave.ai/api-reference/sources/get-sources-short-name-get

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://api.airweave.ai` (Production, default)
- `http://localhost:8001` (Local)

## Request

### Path parameters

- `short_name` (string, required) — Technical identifier of the source type (e.g., 'github', 'stripe', 'slack')

## Response

### 200

Successful Response

- `name` (string, required) — Human-readable name of the data source connector (e.g., 'GitHub', 'Stripe', 'PostgreSQL').
- `short_name` (string, required) — Technical identifier used internally to reference this source type. Must be unique across all sources.
- `class_name` (string, required) — Python class name of the source implementation that handles data extraction logic.
- `config_fields` (Fields, required) — Schema definition for configuration fields required to customize this source.
- `description` (string, optional, nullable) — Detailed description explaining what data this source can extract and its typical use cases.
- `auth_methods` (list of string, optional, nullable) — List of supported authentication methods (e.g., 'direct', 'oauth_browser').
- `oauth_type` (string, optional, nullable) — OAuth token type for OAuth sources (e.g., 'access_only', 'with_refresh').
- `requires_byoc` (boolean, optional, default: false) — Whether this OAuth source requires users to bring their own client.
- `auth_config_class` (string, optional, nullable) — Python class name that defines the authentication configuration fields required for this source (only for DIRECT auth).
- `config_class` (string, optional, nullable) — Python class name that defines the source-specific configuration options and parameters.
- `output_entity_definitions` (list of string, optional) — List of entity definition short names that this source can produce (e.g., ['asana_task_entity', 'asana_project_entity']).
- `labels` (list of string, optional, nullable) — Categorization tags to help users discover and filter sources by domain or use case.
- `supports_continuous` (boolean, optional, default: false) — Whether this source supports cursor-based continuous syncing for incremental data extraction.
- `federated_search` (boolean, optional, default: false) — Whether this source uses federated search instead of traditional syncing.
- `supports_temporal_relevance` (boolean, optional, default: true) — Whether this source's entities have timestamps that enable recency-based ranking.
- `supports_access_control` (boolean, optional, default: false) — Whether this source supports document-level access control.
- `rate_limit_level` (string, optional, nullable) — Rate limiting level for this source: 'org' (organization-wide), 'connection' (per-connection/per-user), or None (no rate limiting).
- `feature_flag` (string, optional, nullable) — Feature flag required to access this source. If set, only organizations with this feature enabled can see/use this source.
- `supports_browse_tree` (boolean, optional, default: false) — Whether this source supports lazy-loaded browse tree for selective node syncing.
- `auth_fields` (Fields, optional, nullable) — Schema definition for authentication fields required to connect to this source.
- `supported_auth_providers` (list of string, optional, nullable) — List of auth provider short names that support this source.

## Errors

### 404 Not Found Error

Source Not Found

- `detail` (string, required) — Error message describing what was not found

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 429 Too Many Requests Error

Rate Limit Exceeded

- `detail` (string, required) — Error message explaining the rate limit

## Types

### Fields

Fields model.

- `fields` (list of ConfigField, required)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ConfigField

Config field model.

- `name` (string, required)
- `title` (string, required)
- `type` (string, required)
- `description` (string, optional, nullable)
- `required` (boolean, optional, default: true)
- `items_type` (string, optional, nullable)
- `feature_flag` (string, optional, nullable)
- `is_secret` (boolean, optional, default: false)
- `enum_values` (list of string, optional, nullable)

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "name": "GitHub",
  "short_name": "github",
  "class_name": "GitHubSource",
  "config_fields": {
    "fields": [
      {
        "name": "string",
        "title": "string",
        "type": "string"
      }
    ]
  },
  "description": "Connect to GitHub repositories for code, issues, pull requests, and documentation",
  "auth_config_class": "GitHubAuthConfig",
  "config_class": "GitHubConfig",
  "labels": [
    "code"
  ],
  "auth_fields": {
    "fields": [
      {
        "name": "personal_access_token",
        "title": "Personal Access Token",
        "type": "string",
        "description": "GitHub Personal Access Token with repository read permissions",
        "secret": true
      },
      {
        "name": "repo_name",
        "title": "Repository Name",
        "type": "string",
        "description": "Full repository name in format 'owner/repo'"
      }
    ]
  },
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "auth_type": "config_class",
  "output_entity_definition_ids": [
    "def12345-6789-abcd-ef01-234567890abc",
    "def67890-abcd-ef01-2345-67890abcdef1"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "modified_at": "2024-01-01T00:00:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.airweave.ai/sources/github"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```typescript
import { AirweaveSDKClient } from "@airweave/sdk";

const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
await client.sources.get("github");

```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.airweave.ai/sources/github"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.airweave.ai/sources/github")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.airweave.ai/sources/github")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.airweave.ai/sources/github', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.airweave.ai/sources/github");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.airweave.ai/sources/github")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```