Description
<div align="center"> <img src="https://user-images.githubusercontent.com/68016351/222853569-b35cc448-6481-4cf2-a237-bd5da47e94fd.png" width="500"> <p>Programatically control Airbyte Cloud through an API.</p> <a href="https://reference.airbyte.com/reference/start"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a> <a href="https://github.com/airbytehq/airbyte-api-python-sdk/actions"><img src="https://img.shields.io/github/actions/workflow/status/airbytehq/airbyte-api-python-sdk/speakeasy_sdk_generation.yml?style=for-the-badge" /></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a> <a href="https://github.com/airbytehq/airbyte-api-python-sdk/releases"><img src="https://img.shields.io/github/v/release/airbytehq/airbyte-api-python-sdk?sort=semver&style=for-the-badge" /></a> </div> ## Authentication Developers will need to create an API Key within your [Developer Portal](https://portal.airbyte.com/) to make API requests. You can use your existing Airbyte account to log in to the Developer Portal. Once you are in the Developer Portal, use the API Keys tab to create or remove API Keys. You can see a [walkthrough demo here](https://www.loom.com/share/7997a7c67cd642cc8d1c72ef0dfcc4bc)🎦 The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab. <!-- Start Summary [summary] --> ## Summary airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise. <!-- End Summary [summary] --> <!-- Start Table of Contents [toc] --> ## Table of Contents <!-- $toc-max-depth=2 --> * [Authentication](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#authentication) * [SDK Installation](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#sdk-installation) * [SDK Example Usage](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#sdk-example-usage) * [Available Resources and Operations](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#available-resources-and-operations) * [Error Handling](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#error-handling) * [Server Selection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#server-selection) * [Custom HTTP Client](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#custom-http-client) * [Authentication](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/#authentication-1) <!-- End Table of Contents [toc] --> <!-- Start SDK Installation [installation] --> ## SDK Installation The SDK can be installed using the *pip* package manager, with dependencies and metadata stored in the `setup.py` file. ```bash pip install airbyte-api ``` <!-- End SDK Installation [installation] --> <!-- Start SDK Example Usage [usage] --> ## SDK Example Usage ### Example ```python import airbyte_api from airbyte_api import models s = airbyte_api.AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password='', username='', ), ), ) res = s.connections.create_connection(request=models.ConnectionCreateRequest( destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281', source_id='95e66a59-8045-4307-9678-63bc3c9b8c93', name='Postgres-to-Bigquery', )) if res.connection_response is not None: # handle response pass ``` <!-- End SDK Example Usage [usage] --> <!-- Start Available Resources and Operations [operations] --> ## Available Resources and Operations <details open> <summary>Available methods</summary> ### [connections](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md) * [create_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#create_connection) - Create a connection * [delete_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#delete_connection) - Delete a Connection * [get_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#get_connection) - Get Connection details * [list_connections](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#list_connections) - List connections * [patch_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#patch_connection) - Update Connection details ### [declarative_source_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md) * [create_declarative_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcede
Release History
| Version | Changes | Urgency | Date |
|---|---|---|---|
| 0.53.0 | Imported from PyPI (0.53.0) | Low | 4/21/2026 |
| v0.53.0 | # Generated by Speakeasy CLI ## 2025-10-02 19:54:17 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.508.0 (2.536.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.53.0] . ### Releases - [PyPI v0.53.0] https://pypi.org/project/airbyte-api/0.53.0 - . Publishing Completed | Low | 10/2/2025 |
| v0.52.2 | # Generated by Speakeasy CLI ## 2024-12-11 00:19:25 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.453.10 (2.474.15) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.52.2] . ### Releases - [PyPI v0.52.2] https://pypi.org/project/airbyte-api/0.52.2 - . Publishing Completed | Low | 12/11/2024 |
| v0.52.1 | # Generated by Speakeasy CLI ## 2024-09-25 00:17:36 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.402.12 (2.422.15) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.52.1] . ### Releases - [PyPI v0.52.1] https://pypi.org/project/airbyte-api/0.52.1 - . Publishing Completed | Low | 9/25/2024 |
| v0.52.0 | # Generated by Speakeasy CLI ## 2024-09-11 00:14:28 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.395.1 (2.415.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.52.0] . ### Releases - [PyPI v0.52.0] https://pypi.org/project/airbyte-api/0.52.0 - . Publishing Completed | Low | 9/11/2024 |
| v0.51.0 | # Generated by Speakeasy CLI ## 2024-07-15 18:36:21 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.335.2 (2.372.3) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.51.0] . ### Releases - [PyPI v0.51.0] https://pypi.org/project/airbyte-api/0.51.0 - . Publishing Completed | Low | 7/15/2024 |
| v0.50.1 | # Generated by Speakeasy CLI ## 2024-06-03 00:15:07 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.50.1] . ### Releases - [PyPI v0.50.1] https://pypi.org/project/airbyte-api/0.50.1 - . Publishing Completed | Low | 6/3/2024 |
| v0.50.0 | # Generated by Speakeasy CLI ## 2024-05-15 22:21:55 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.291.0 (2.332.4) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.50.0] . ### Releases - [PyPI v0.50.0] https://pypi.org/project/airbyte-api/0.50.0 - . | Low | 5/15/2024 |
| v0.49.4 | # Generated by Speakeasy CLI ## 2024-05-15 00:14:16 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.289.0 (2.331.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.49.4] . ### Releases - [PyPI v0.49.4] https://pypi.org/project/airbyte-api/0.49.4 - . | Low | 5/15/2024 |
| v0.49.3 | # Generated by Speakeasy CLI ## 2024-05-14 00:14:22 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.286.3 (2.329.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.49.3] . ### Releases - [PyPI v0.49.3] https://pypi.org/project/airbyte-api/0.49.3 - . | Low | 5/14/2024 |
| v0.49.2 | # Generated by Speakeasy CLI ## 2024-04-11 22:31:51 ### Changes Based on: - OpenAPI Doc - Speakeasy CLI 1.250.0 (2.304.1) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.49.2] . ### Releases - [PyPI v0.49.2] https://pypi.org/project/airbyte-api/0.49.2 - . | Low | 4/11/2024 |
| v0.47.3 | # Generated by Speakeasy CLI ## 2024-02-24 00:13:58 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.193.4 (2.272.4) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.47.3] . ### Releases - [PyPI v0.47.3] https://pypi.org/project/airbyte-api/0.47.3 - . | Low | 2/27/2024 |
| v0.47.2 | # Generated by Speakeasy CLI ## 2024-02-20 21:16:52 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.184.0 (2.263.3) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.47.2] . ### Releases - [PyPI v0.47.2] https://pypi.org/project/airbyte-api/0.47.2 - . | Low | 2/20/2024 |
| v0.47.1 | # Generated by Speakeasy CLI ## 2024-02-15 00:13:37 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.180.0 (2.258.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.47.1] . ### Releases - [PyPI v0.47.1] https://pypi.org/project/airbyte-api/0.47.1 - . | Low | 2/20/2024 |
| v0.47.0 | # Generated by Speakeasy CLI ## 2024-02-13 00:14:09 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.178.0 (2.253.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.47.0] . ### Releases - [PyPI v0.47.0] https://pypi.org/project/airbyte-api/0.47.0 - . | Low | 2/13/2024 |
| v0.44.3 | # Generated by Speakeasy CLI ## 2024-01-18 22:42:26 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.44.3] . ### Releases - [PyPI v0.44.3] https://pypi.org/project/airbyte-api/0.44.3 - . | Low | 1/18/2024 |
| v0.44.2 | # Generated by Speakeasy CLI ## 2024-01-06 00:14:20 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.133.1 (2.228.1) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.44.2] . ### Releases - [PyPI v0.44.2] https://pypi.org/project/airbyte-api/0.44.2 - . | Low | 1/9/2024 |
| v0.40.0 | # Generated by Speakeasy CLI ## 2023-10-18 00:13:28 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.101.0 (2.161.0) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.40.0] . ### Releases - [PyPI v0.40.0] https://pypi.org/project/airbyte-api/0.40.0 - . | Low | 10/20/2023 |
| v0.38.1 | # Generated by Speakeasy CLI ## 2023-10-02 00:14:02 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.92.3 (2.143.2) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.38.1] . ### Releases - [PyPI v0.38.1] https://pypi.org/project/airbyte-api/0.38.1 - . | Low | 10/3/2023 |
| v0.35.4 | # Generated by Speakeasy CLI ## 2023-09-12 16:21:57 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.35.4] . ### Releases - [PyPI v0.35.4] https://pypi.org/project/airbyte-api/0.35.4 - . | Low | 9/12/2023 |
| v0.35.2 | # Generated by Speakeasy CLI ## 2023-09-05 00:12:47 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.78.3 (2.96.3) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.35.2] . ### Releases - [PyPI v0.35.2] https://pypi.org/project/airbyte-api/0.35.2 - . | Low | 9/5/2023 |
| v0.35.0 | # Generated by Speakeasy CLI ## 2023-09-01 00:14:04 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.77.0 (2.91.2) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.35.0] . ### Releases - [PyPI v0.35.0] https://pypi.org/project/airbyte-api/0.35.0 - . | Low | 9/1/2023 |
| v0.32.2 | # Generated by Speakeasy CLI ## 2023-08-21 14:53:00 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.74.3 (2.86.6) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.32.2] . ### Releases - [PyPI v0.32.2] https://pypi.org/project/airbyte-api/0.32.2 - . | Low | 8/21/2023 |
| v0.31.0 | # Generated by Speakeasy CLI ## 2023-08-16 00:12:30 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.73.1 (2.84.3) https://github.com/speakeasy-api/speakeasy ### Generated - [python v0.31.0] . ### Releases - [PyPI v0.31.0] https://pypi.org/project/airbyte-api/0.31.0 - . | Low | 8/16/2023 |
| v0.29.0 | # Generated by Speakeasy CLI ## 2023-08-04 00:15:01 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.68.3 (2.81.1) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.29.0] https://pypi.org/project/airbyte-api/0.29.0 - . | Low | 8/7/2023 |
| v0.27.1 | # Generated by Speakeasy CLI ## 2023-08-01 00:16:53 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.66.1 (2.75.2) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.27.1] https://pypi.org/project/airbyte-api/0.27.1 - . | Low | 8/1/2023 |
| v0.27.0 | # Generated by Speakeasy CLI ## 2023-07-28 00:13:52 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.65.2 (2.75.1) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.27.0] https://pypi.org/project/airbyte-api/0.27.0 - . | Low | 7/31/2023 |
| v0.26.1 | # Generated by Speakeasy CLI ## 2023-07-27 00:13:33 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.65.1 (2.73.1) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.26.1] https://pypi.org/project/airbyte-api/0.26.1 - . | Low | 7/27/2023 |
| v0.24.2 | # Generated by Speakeasy CLI ## 2023-07-20 17:11:34 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.62.1 (2.70.2) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.24.2] https://pypi.org/project/airbyte-api/0.24.2 - . | Low | 7/20/2023 |
| v0.15.1 | # Generated by Speakeasy CLI ## 2023-06-20 00:13:20 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.15.1] https://pypi.org/project/airbyte-api/0.15.1 - . | Low | 6/20/2023 |
| v0.14.1 | # Generated by Speakeasy CLI ## 2023-06-11 00:16:27 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.47.1 (2.39.2) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.14.1] https://pypi.org/project/airbyte-api/0.14.1 - . | Low | 6/12/2023 |
| v0.12.1 | # Generated by Speakeasy CLI ## 2023-06-07 00:14:25 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.44.2 (2.35.9) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.12.1] https://pypi.org/project/airbyte-api/0.12.1 - . | Low | 6/7/2023 |
| v0.12.0 | # Generated by Speakeasy CLI ## 2023-06-03 00:13:54 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.43.0 (2.35.3) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.12.0] https://pypi.org/project/airbyte-api/0.12.0 - . | Low | 6/5/2023 |
| v0.11.2 | # Generated by Speakeasy CLI ## 2023-06-01 00:17:50 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.40.2 (2.34.2) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.11.2] https://pypi.org/project/airbyte-api/0.11.2 - . | Low | 6/2/2023 |
| v0.10.0 | # Generated by Speakeasy CLI ## 2023-05-23 00:13:59 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.37.5 (2.32.2) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.10.0] https://pypi.org/project/airbyte-api/0.10.0 - . | Low | 5/23/2023 |
| v0.7.0 | # Generated by Speakeasy CLI ## 2023-05-16 18:07:28 ### Changes Based on: - OpenAPI Doc 1.0.0 - Speakeasy CLI 1.33.2 (2.29.0) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.7.0] https://pypi.org/project/airbyte-api/0.7.0 - . | Low | 5/16/2023 |
| v0.6.0 | # Generated by Speakeasy CLI ## 2023-05-16 00:13:12 ### Changes Based on: - OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download - Speakeasy CLI 1.32.0 (2.28.0) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.6.0] https://pypi.org/project/airbyte-api/0.6.0 - . | Low | 5/16/2023 |
| v0.5.0 | # Generated by Speakeasy CLI ## 2023-05-13 00:12:03 ### Changes Based on: - OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download - Speakeasy CLI 1.31.1 (2.27.0) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.5.0] https://pypi.org/project/airbyte-api/0.5.0 - . | Low | 5/15/2023 |
| v0.3.0 | # Generated by Speakeasy CLI ## 2023-04-27 00:14:16 ### Changes Based on: - OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download - Speakeasy CLI 1.25.1 (2.22.0) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.3.0] https://pypi.org/project/airbyte-api/0.3.0 - . | Low | 4/27/2023 |
| v0.1.0 | # Generated by Speakeasy CLI ## 2023-04-24 22:22:31 ### Changes Based on: - OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download - Speakeasy CLI 1.22.2 (2.20.1) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.1.0] https://pypi.org/project/airbyte-api/0.1.0 - . | Low | 4/24/2023 |
| v0.0.1 | # Generated by Speakeasy CLI ## 2023-04-18 20:01:26 ### Changes Based on: - OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download - Speakeasy CLI 1.20.2 (2.18.2) https://github.com/speakeasy-api/speakeasy ### Releases - [PyPI v0.0.1] https://pypi.org/project/airbyte/0.0.1 - . | Low | 4/18/2023 |
