/airbyte

name: airbyte
description: |
  Airbyte integration. Manage data, records, and automate workflows. Use when the user wants to interact with Airbyte data.
compatibility: Requires network access and a valid Membrane account (Free tier supported).
license: MIT
homepage: https://getmembrane.com
repository: https://github.com/membranedev/application-skills
metadata:
  author: membrane
  version: "1.0"
  categories: ""

Airbyte

Airbyte is an open-source data integration platform that helps you consolidate data from different sources into data warehouses, data lakes, and databases. It's used by data engineers and analysts to build and manage data pipelines for analytics and reporting.

Official docs: https://docs.airbyte.com/

Airbyte Overview

• **Connections**
• **Syncs**
• **Sources**
• **Destinations**
• **Workspaces**
• **Users**

Working with Airbyte

This skill uses the Membrane CLI to interact with Airbyte. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

npm install -g @membranehq/cli@latest

Authentication

membrane login --tenant --clientName=<agentType>

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

membrane login complete <code>

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

Connecting to Airbyte

Use `membrane connection ensure` to find or create a connection by app URL or domain:

membrane connection ensure "https://airbyte.com/" --json

The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

npx @membranehq/cli connection get <id> --wait --json

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

• **`READY`** — connection is fully set up. Skip to **Step 2**.
• **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
• `clientAction.type` — the kind of action needed:
• `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
• `"provide-input"` — more information is needed (e.g. which app to connect to).
• `clientAction.description` — human-readable explanation of what's needed.
• `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
• `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

• **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

Searching for actions

Search using a natural language description of what you want to do:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

Popular actions

| Name | Key | Description | |---|---|---| | List Connections | list-connections | No description | | List Destinations | list-destinations | No description | | List Sources | list-sources | No description | | List Jobs | list-jobs | No description | | List Workspaces | list-workspaces | No description | | List Users | list-users | No description | | List Organizations | list-organizations | No description | | Get Connection | get-connection | No description | | Get Destination | get-destination | No description | | Get Source | get-source | No description | | Get Workspace | get-workspace | No description | | Get Job | get-job | No description | | Create Connection | create-connection | No description | | Create Destination | create-destination | No description | | Create Source | create-source | No description | | Create Workspace | create-workspace | No description | | Update Connection | update-connection | No description | | Update Destination | update-destination | No description | | Update Source | update-source | No description | | Update Workspace | update-workspace | No description |

Running actions

membrane action run <actionId> --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

The result is in the `output` field of the response.

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Airbyte API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transpa