> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List available PyAirbyte sources

> List all available PyAirbyte source connectors with their configuration schemas.



## OpenAPI

````yaml get /api/airbyte/sources
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/airbyte/sources:
    get:
      tags:
        - PyAirbyte ingestion
      summary: List available PyAirbyte sources
      description: >-
        List all available PyAirbyte source connectors with their configuration
        schemas.
      operationId: get_sources_api_airbyte_sources_get
      responses:
        '200':
          description: List of available source connectors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AirbyteSourcesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    AirbyteSourcesResponse:
      properties:
        sources:
          items:
            $ref: '#/components/schemas/AirbyteSourceInfo'
          type: array
          title: Sources
          description: List of available source connectors.
      type: object
      title: AirbyteSourcesResponse
      description: Response listing all available PyAirbyte source connectors.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    AirbyteSourceInfo:
      properties:
        name:
          type: string
          title: Name
          description: Source identifier. For example, `source-github`.
        package_name:
          type: string
          title: Package Name
          description: PyPI package name. For example, `airbyte-source-github`.
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
          description: >-
            Pinned PyPI package version. For example, `2.3.3`. If `None`, the
            latest available version applies.
        display_name:
          type: string
          title: Display Name
          description: Human-readable source name.
        category:
          type: string
          title: Category
          description: Category grouping. For example, `Engineering` or `CRM`.
        description:
          type: string
          title: Description
          description: Brief description of the source.
          default: ''
        config_fields:
          items:
            $ref: '#/components/schemas/AirbyteSourceConfigField'
          type: array
          title: Config Fields
          description: Configuration fields required by this source.
        config_template:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Config Template
          description: >-
            Template mapping flat form values to the nested config shape the
            connector expects. Uses {{field_name}} placeholders. If `None`, the
            connector receives the flat config as-is.
      type: object
      required:
        - name
        - package_name
        - display_name
        - category
      title: AirbyteSourceInfo
      description: Metadata for a single available PyAirbyte source connector.
    AirbyteSourceConfigField:
      properties:
        name:
          type: string
          title: Name
          description: Field name used in the source config dict.
        title:
          type: string
          title: Title
          description: Human-readable label for the field.
        type:
          type: string
          title: Type
          description: >-
            Data type of the field. For example, `string`, `integer`, or
            `boolean`.
          default: string
        required:
          type: boolean
          title: Required
          description: Indicates whether the field is mandatory.
          default: true
        secret:
          type: boolean
          title: Secret
          description: Whether the field contains sensitive data.
          default: false
        description:
          type: string
          title: Description
          description: Help text for the field.
          default: ''
      type: object
      required:
        - name
        - title
      title: AirbyteSourceConfigField
      description: Schema for a single configuration field of a PyAirbyte source.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````