4ce28cf9b5
* Update API doc table Update API doc table * replace <br> with <br /> --------- Co-authored-by: terencecho <3916587+terencecho@users.noreply.github.com>
5.8 KiB
5.8 KiB
API documentation
Airbyte has two sets of APIs which are intended for different uses. The table below outlines their descriptions, use cases, availability and status.
| Configuration API | Airbyte API | |
|---|---|---|
| Description | The Config API is an internal Airbyte API that is designed for communications between different Airbyte components. | Airbyte API is designed for ease-of-use, reliability and full support by Airbyte team. |
| Use Cases | Enables OSS users to configure their own Self-Hosted Airbyte deployment (internal state, etc) Enables Airbyte team to configure Airbyte Cloud (internal state, etc) |
Enables users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow) Exists for Airbyte users to write applications against. Enables Powered by Airbyte (Headless version and UI version) |
| Available to be used by | OSS users | Cloud users now (and OSS users in June 2023) |
| Status | 🚨 WARNING 🚨 API is in Alpha state. Airbyte does NOT have active commitments to support it. OSS users can interact with the Config API, but at their own risk of future breaking changes. This API is utilized internally by the Airbyte Engineering team and can be changed by Airbyte Engineering if their needs require it, which could potentially break any external applications that are using it. If breaking changes did occur, OSS users would need to update their code to catch up to any backwards incompatible changes in the API. |
Closed Beta. See Airbyte roadmap for more details and to request early-access. |
| Documentation | Available here | Available to Closed Beta participants. |