Skip to main content

Airbyte API

Not availableCloud Not availableSelf-Managed CommunityNot availableSelf-Managed EnterpriseAvailableEmbedded Compare

The Airbyte API allows you to build a fully integrated Airbyte Embedded Experience.

Implementation Steps​

Follow these steps to implement Airbyte Embedded with the API:

1. One-Time Setup (Your Organization)​

First, configure the foundation for your embedded integration:

  1. Create Connection Templates: Define where your users' data will be stored (destination configuration)
  2. Create Source Templates: Choose which data connectors your users can access

2. Per-User Integration (Runtime)​

For each user who wants to connect their data:

  1. Generate User Tokens & Configure Sources: Authenticate users and collect their source credentials

This approach separates one-time organizational setup from per-user operations, making your integration more scalable.

The complete API reference can be found at https://api.airbyte.ai/api/v1/redoc

Was this page helpful?