airbyte-api

library1.0.1pypypi✓ verified 24d ago

The `airbyte-api` library is the official Python client SDK for interacting with the Airbyte API. It provides programmatic access to manage connections, sources, destinations, and perform data synchronization operations. The current version is 0.53.0 and it is actively maintained with frequent updates reflecting the underlying Airbyte platform and API.

data devops http-networking workflow

pip install airbyte-api

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AIRBYTE-API

airbyte-api

datapythonv1.0.1

Install

4.2s avg

Import

1313ms

Disk

40MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 1.372s · 43.2MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 4.2s · import 1.254s · 43MB

40MB installed

● package 40MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Airbyte

✓ import airbyte_api

shared

✓ from airbyte_api.models import shared

Initialize the Airbyte client with API key and server URL, then perform a simple API call to list workspaces. Remember to set `AIRBYTE_API_KEY` and `AIRBYTE_SERVER_URL` environment variables, or replace placeholders.

import airbyte_api import os from airbyte_api.models import shared # Initialize the Airbyte client client = airbyte_api.Airbyte( bearer_auth=os.environ.get('AIRBYTE_API_KEY', 'YOUR_API_KEY'), server_url=os.environ.get('AIRBYTE_SERVER_URL', 'https://api.airbyte.com/v1') ) # Example: List workspaces try: response = client.workspaces.list_workspaces() if response.status_code == 200: print("Successfully listed workspaces:") for workspace in response.list_workspaces_response.data: print(f"- ID: {workspace.workspace_id}, Name: {workspace.name}") else: print(f"Error listing workspaces: Status {response.status_code}") if response.error_response: print(f"Error details: {response.error_response.message}") except Exception as e: print(f"An unexpected error occurred: {e}")

Debug

Known issues

breakingThe `airbyte-api` Python SDK is currently in beta. Breaking changes may occur in minor versions until the SDK reaches a stable v1.0.0 release. Always review the changelog before upgrading.

fix

Refer to the official GitHub repository and changelog for release notes and migration guides during upgrades. Pin dependency versions to avoid unexpected breaks.

affects: <1.0.0

gotchaIncorrect `bearer_auth` or `server_url` can lead to authentication failures or 'not found' errors. Ensure your API key is correct and the `server_url` points to the correct Airbyte API endpoint (e.g., `https://api.airbyte.com/v1` for Airbyte Cloud, or your self-hosted instance's URL).

fix

Verify your Airbyte API key and ensure the `server_url` matches your Airbyte deployment. For self-hosted, this often includes a port (e.g., `http://localhost:8000/api/v1`).

affects: All

gotchaWhen making API calls, it's crucial to always check the `response.status_code` to ensure the call was successful and handle potential errors. Directly accessing `response.data` or similar attributes without checking status can lead to `AttributeError` if an error occurred and the expected data model is not present.

fix

Always include `if response.status_code == 200:` (or other expected success codes) checks before processing the response body. Utilize `response.error_response` for detailed error messages when available.

affects: All

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'airbyte_cdk'

The 'airbyte_cdk' module is not installed in the Python environment.

fix

Install the 'airbyte-cdk' package using pip: 'pip install airbyte-cdk'.

ModuleNotFoundError: No module named 'airbyte_cdk.sources.declarative.manifest_declarative_source'

The 'airbyte_cdk' module is either not installed or is an outdated version lacking the 'declarative.manifest_declarative_source' submodule.

fix

Ensure the latest version of 'airbyte-cdk' is installed: 'pip install --upgrade airbyte-cdk'.

ModuleNotFoundError: No module named 'source_salesforce'

The 'source_salesforce' module is not installed in the Python environment.

fix

Install the 'source-salesforce' package using pip: 'pip install source-salesforce'.

ModuleNotFoundError: No module named 'requests'

The 'requests' library is not installed in the Python environment.

fix

Install the 'requests' package using pip: 'pip install requests'.

AttributeError: 'Progress' object has no attribute 'status'

The 'Progress' object lacks a 'status' attribute, possibly due to an outdated or incompatible version of the 'dagger' library.

fix

Ensure the latest version of the 'dagger' library is installed: 'pip install --upgrade dagger'.

Upgrade

Version history

1.0.1latest on PyPI · released Jun 23, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

60 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/airbytehq/airbyte-api-python-sdk.git ↗

packagehttps://pypi.org/project/airbyte-api/ ↗

homepagehttps://airbyte.com ↗