Airbyte Public API

The public API from Airbyte — 47 operation(s) for public.

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /embedded/widget_token Get a token for the Airbyte Embedded widget · Airbyte Get a Widget Token for Airbyte Embedded #
Ask an LLM
“How do I get a widget token so I can render the Airbyte Embedded widget in my app?”
“Which allowed origin and external user id does the embedded widget token need?”
Tell an agent
Get an embedded widget token for external user {externalUserId} in organization {organizationId}, allowing origin {allowedOrigin}.
Issue a widget token so {allowedOrigin} can load the embedded widget for end user {externalUserId} under organization {organizationId}.
POST /embedded/scoped_token Generate a token scoped to an end-user workspace · Airbyte Generate a Scoped Token for Airbyte Embedded #
Ask an LLM
“How can I generate a token that only has access to one end user's workspace?”
“Is there a way to hand an embedded customer a token limited to their own workspace?”
Tell an agent
Generate a scoped token for workspace {workspaceId}.
Create a workspace-scoped Embedded token for end-user workspace {workspaceId}.
GET /embedded/organizations List my organizations that have Embedded enabled · Airbyte List Organizations That a User Has Access to That Have Embedded Enabled #
Ask an LLM
“Which of my organizations have Airbyte Embedded turned on?”
“What organizations can I use for embedded integrations with my current user?”
Tell an agent
List the organizations I can access that have Embedded enabled.
Show which of my organizations are set up for Embedded.

Documentation

Specifications

Other Resources

🔗
SDKs
https://github.com/airbytehq/airbyte-api-python-sdk
🔗
SDKs
https://github.com/airbytehq/airbyte-api-java-sdk
🔗
SDKs
https://pypi.org/project/airbyte-api/
🔗
SDKs
https://github.com/airbytehq/terraform-provider-airbyte
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/graphql/airbyte-graphql.md
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-application-token-bootstrap-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-cancel-running-job-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-destination-create-verify-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-find-connection-and-sync-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-provision-pipeline-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-reset-and-resync-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-source-create-verify-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-tag-connection-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-trigger-sync-and-poll-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/arazzo/airbyte-workspace-bootstrap-workflow.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/airbyte:airbyte-public-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

airbyte-public-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: airbyte-api Public API
  version: 1.0.0
  description: Programmatically control Airbyte Cloud, OSS & Enterprise.
servers:
- url: https://api.airbyte.com/v1
  description: Airbyte API v1
tags:
- name: Public
paths:
  /embedded/widget_token:
    post:
      description: Get a token for the embedded widget. This endpoint is only available when Airbyte Embedded is enabled.
      operationId: getEmbeddedWidget
      x-speakeasy-alias: getEmbeddedWidget
      x-speakeasy-group: EmbeddedWidget
      summary: Airbyte Get a Widget Token for Airbyte Embedded
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedWidgetRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedWidgetResponse'
              examples:
                getEmbeddedWidget200Example:
                  summary: Default getEmbeddedWidget 200 response
                  x-microcks-default: true
                  value:
                    token: example
          description: Success
      tags:
      - Public
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /embedded/scoped_token:
    post:
      description: Generate a token scoped to an end-user workspace.
      operationId: generateEmbeddedScopedToken
      x-speakeasy-alias: generateEmbeddedScopedToken
      x-speakeasy-group: EmbeddedScopedToken
      summary: Airbyte Generate a Scoped Token for Airbyte Embedded
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedScopedTokenRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedScopedTokenResponse'
              examples:
                generateEmbeddedScopedToken200Example:
                  summary: Default generateEmbeddedScopedToken 200 response
                  x-microcks-default: true
                  value:
                    token: example
          description: Success
      tags:
      - Public
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /embedded/organizations:
    get:
      summary: Airbyte List Organizations That a User Has Access to That Have Embedded Enabled
      tags:
      - Public
      operationId: listEmbeddedOrganizationsByUser
      x-speakeasy-alias: listEmbeddedOrganizationsByUser
      x-speakeasy-group: EmbeddedWidget
      responses:
        '200':
          description: Successfully retrieved organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedOrganizationsList'
              examples:
                listEmbeddedOrganizationsByUser200Example:
                  summary: Default listEmbeddedOrganizationsByUser 200 response
                  x-microcks-default: true
                  value:
                    organizations: example
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    EmbeddedOrganizationsList:
      required:
      - organizations
      properties:
        organizations:
          type: array
          items:
            $ref: '#/components/schemas/EmbeddedOrganizationListItem'
      x-speakeasy-component: true
    EmbeddedScopedTokenRequest:
      type: object
      required:
      - workspaceId
      properties:
        workspaceId:
          type: string
          format: uuid
      x-speakeasy-component: true
    EmbeddedScopedTokenResponse:
      type: object
      required:
      - token
      properties:
        token:
          type: string
      x-speakeasy-component: true
    EmbeddedOrganizationListItem:
      type: object
      required:
      - organizationId
      - organizationName
      - permission
      properties:
        organizationId:
          type: string
          format: uuid
        organizationName:
          type: string
        permission:
          $ref: '#/components/schemas/PermissionType'
      x-speakeasy-component: true
    EmbeddedWidgetRequest:
      type: object
      required:
      - allowedOrigin
      - externalUserId
      - organizationId
      properties:
        allowedOrigin:
          type: string
        externalUserId:
          type: string
        organizationId:
          type: string
          format: uuid
      x-speakeasy-component: true
    PermissionType:
      type: string
      description: Describes what actions/endpoints the permission entitles to
      enum:
      - instance_admin
      - organization_admin
      - organization_editor
      - organization_runner
      - organization_reader
      - organization_member
      - workspace_owner
      - workspace_admin
      - workspace_runner
      - workspace_editor
      - workspace_reader
      x-speakeasy-component: true
    EmbeddedWidgetResponse:
      type: object
      required:
      - token
      properties:
        token:
          type: string
      x-speakeasy-component: true