airbyte-api

What it is and what it does

airbyte-api is a Python SDK that wraps the Airbyte API, letting you programmatically create, update, delete, and manage connections, sources, destinations, and other Airbyte resources. It uses httpx and pydantic under the hood to handle HTTP requests and data validation. The SDK supports both synchronous and asynchronous workflows, so you can integrate Airbyte automation into scripts, applications, or orchestration tools.

You authenticate using API Keys from the Airbyte Developer Portal and then interact with resources like connections through a client object. The SDK is actively maintained and requires Python 3.10 or later. It's designed for developers who want to automate data pipeline operations without manually calling REST endpoints.

Use it for:

• Automate creation and management of data connections between sources and destinations in Airbyte Cloud.
• Build custom orchestration workflows that trigger Airbyte syncs or manage connection configurations programmatically.
• Integrate Airbyte operations into CI/CD pipelines or infrastructure-as-code deployments.
• Dynamically provision data pipelines for multi-tenant SaaS applications using Airbyte as the backbone.
• Monitor and update connection details, namespace formats, and other settings without manual portal access.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Python SDK for programmatically controlling Airbyte Cloud, OSS, and Enterprise through an API, supporting both synchronous and asynchronous operations.

Yes, if you need to automate Airbyte operations. The SDK has low install friction, active maintenance, no known vulnerabilities, and sits in the top 5000 packages by download volume. The main caveat is that the license status is unclear—verify the actual license in the repository before using in proprietary work. Requires Python 3.10+.

Install

airbyte-api on PyPI

pip install airbyte-api

uv add airbyte-api

poetry add airbyte-api

Installing airbyte-api

Before you install

Low friction installation with a pure-Python wheel and three common dependencies (httpx, httpcore, pydantic). Actively maintained with a recent release 52 days ago and ongoing repository activity.

License in practice

License status is unclear—no SPDX identifier or raw license text is available in the package metadata. Verify the actual license terms in the repository before using in proprietary or commercial contexts.

Quickstart

pip install airbyte-api

from airbyte_api import AirbyteAPI, models

with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="your_password",
            username="your_username",
        ),
    ),
) as client:
    res = client.connections.create_connection(request={
        "source_id": "...",
        "destination_id": "...",
        "name": "My Connection",
    })

Requires Python 3.10 or later. You must obtain an API Key from the Airbyte Developer Portal before making requests.

Verify before relying

• Whether the SDK supports all Airbyte deployment types (Cloud, OSS, Enterprise) equally or with differences.
• Rate limiting, retry behavior, and timeout defaults for API requests.
• Whether async operations require additional setup or dependencies beyond what is listed.

Package facts

Evidence: airbyte_api-1.0.1-py3-none-any.whl

Tags

More WWW/HTTP packages