{"id":1314,"library":"airbyte-api","title":"Airbyte API Client","description":"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.","status":"active","version":"0.53.0","language":"en","source_language":"en","source_url":"https://github.com/airbytehq/airbyte-api-python-sdk","tags":["data integration","ETL","API client","data synchronization","API SDK"],"install":[{"cmd":"pip install airbyte-api","lang":"bash","label":"Install `airbyte-api`"}],"dependencies":[],"imports":[{"symbol":"Airbyte","correct":"import airbyte_api"},{"symbol":"shared","correct":"from airbyte_api.models import shared"}],"quickstart":{"code":"import airbyte_api\nimport os\nfrom airbyte_api.models import shared\n\n# Initialize the Airbyte client\nclient = airbyte_api.Airbyte(\n    bearer_auth=os.environ.get('AIRBYTE_API_KEY', 'YOUR_API_KEY'),\n    server_url=os.environ.get('AIRBYTE_SERVER_URL', 'https://api.airbyte.com/v1')\n)\n\n# Example: List workspaces\ntry:\n    response = client.workspaces.list_workspaces()\n\n    if response.status_code == 200:\n        print(\"Successfully listed workspaces:\")\n        for workspace in response.list_workspaces_response.data:\n            print(f\"- ID: {workspace.workspace_id}, Name: {workspace.name}\")\n    else:\n        print(f\"Error listing workspaces: Status {response.status_code}\")\n        if response.error_response:\n            print(f\"Error details: {response.error_response.message}\")\nexcept Exception as e:\n    print(f\"An unexpected error occurred: {e}\")\n","lang":"python","description":"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."},"warnings":[{"fix":"Refer to the official GitHub repository and changelog for release notes and migration guides during upgrades. Pin dependency versions to avoid unexpected breaks.","message":"The `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.","severity":"breaking","affected_versions":"<1.0.0"},{"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`).","message":"Incorrect `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).","severity":"gotcha","affected_versions":"All"},{"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.","message":"When 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.","severity":"gotcha","affected_versions":"All"}],"env_vars":null,"last_verified":"2026-04-09T00:00:00.000Z","next_check":"2026-07-08T00:00:00.000Z"}