From 58823fe9d81afc60f17e43c42aad81661ff4ef10 Mon Sep 17 00:00:00 2001 From: Riley Brook Date: Mon, 27 Feb 2023 14:31:06 -0800 Subject: [PATCH] Update API page --- docs/api-documentation.md | 28 ++++++++-------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/docs/api-documentation.md b/docs/api-documentation.md index 78175265edc5..b291b952c7ec 100644 --- a/docs/api-documentation.md +++ b/docs/api-documentation.md @@ -1,22 +1,10 @@ # API documentation -## Open-Source API - -Airbyte Open Source doesn't require an API Token for Authentication. -All endpoints are acccessible without the token. - -:::caution - -Our Open-Source API (configuration API) is still in an alpha state and might change. You won’t lose any functionality, but you may need to update your code to catch up to any backwards incompatible changes in the API. -::: - -**Check out the** [**Open-Source API documentation**](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html)**.** - -Contact us on [Slack](https://slack.airbyte.io) if you have any questions about it. - ---- - -## Airbyte Cloud API - -Airbyte Cloud will support API access in 2023. See [Airbyte roadmap](https://app.harvestr.io/roadmap/view/pQU6gdCyc/airbyte-roadmap) for more details. - +Airbyte has 2 APIs. Please see the table below for differences between them. + +| **Configuration API** | **Airbyte API** | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Purpose:** Enables OSS users to configure their own Self-Hosted Airbyte deployment (ex UI, internal state, etc) | **Purpose:** Enables users to control Airbyte programmatically and use with Orchestration tools (ex: Airflow) | +| **Purpose:** Enables Airbyte team to configure Airbyte Cloud (ex UI, internal state, etc) | **Purpose:** Exists for Airbyte users to write applications against and enable [Powered by Airbyte](https://airbyte.com/embed-airbyte-connectors-with-api) (Headless version and UI version) | +| **Status:** Alpha state and might change. You won’t lose any functionality, but you may need to update your code to catch up to any backwards incompatible changes in the API. | **Status:** Closed Beta. See [Airbyte roadmap](https://app.harvestr.io/roadmap/view/pQU6gdCyc/airbyte-roadmap) for more details. | +| **Documentation** [Available here](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html) | **Documentation:** Available to Closed Beta participants. |