Airbyte

Airbyte Public Workspaces API

The public_workspaces API from Airbyte — 3 operation(s) for public_workspaces.

GitHub OpenAPI

Operations 6

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

GET /workspaces List workspaces · Airbyte List Workspaces #
Ask an LLM
“What workspaces do I have access to?”
“Can I include deleted workspaces in the list?”
Tell an agent
List all my workspaces.
List workspaces including deleted ones, up to {limit} results.
POST /workspaces Create a workspace · Airbyte Create a Workspace #
Ask an LLM
“How do I create a new workspace?”
“Can I create a workspace in a specific organization and region?”
Tell an agent
Create a workspace named {name}.
Create workspace {name} in organization {organizationId} in region {regionId}.
GET /workspaces/{workspaceId} Get a workspace's details · Airbyte Get Workspace Details #
Ask an LLM
“How do I look up one workspace's settings?”
“Which region and notifications does a workspace have configured?”
Tell an agent
Get workspace {workspaceId}.
Show the details of workspace {workspaceId}.
PATCH /workspaces/{workspaceId} Update a workspace's name, region or notifications · Airbyte Update a Workspace #
Ask an LLM
“How do I rename an existing workspace?”
“Can I change a workspace's notification settings?”
Tell an agent
Rename workspace {workspaceId} to {name}.
Update notifications on workspace {workspaceId} to {notifications}.
DELETE /workspaces/{workspaceId} Delete a workspace · Airbyte Delete a Workspace #
Ask an LLM
“How do I delete a workspace?”
“Can I remove a workspace I no longer need?”
Tell an agent destructive · confirm first
Delete workspace {workspaceId}.
Remove the workspace {workspaceId}.
PUT /workspaces/{workspaceId}/oauthCredentials Set workspace OAuth override credentials for a connector · Airbyte Create OAuth Override Credentials for a Workspace and Source Type #
Ask an LLM
“How do I use my own OAuth app credentials for a connector in just one workspace?”
“Can I override the default OAuth credentials for a source in a single workspace?”
Tell an agent
Set OAuth override credentials for {actorType} {name} in workspace {workspaceId} to {configuration}.
Use my own OAuth app {configuration} for {actorType} connector {name} in workspace {workspaceId} only.

Documentation

📖
Documentation
https://docs.airbyte.com
📖
APIReference
https://reference.airbyte.com/reference/getting-started
📖
Authentication
https://docs.airbyte.com/api-documentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/openapi/airbyte-public-workspaces-api-openapi.yml

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

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-workspaces-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.

GitHub Google LinkedIn

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

OpenAPI Specification

airbyte-public-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: airbyte-api Public Workspaces 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_workspaces
paths:
  /workspaces:
    get:
      tags:
      - public_workspaces
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspacesResponse'
              examples:
                listWorkspaces200Example:
                  summary: Default listWorkspaces 200 response
                  x-microcks-default: true
                  value:
                    previous: example
                    next: example
                    data: example
          description: Successful operation
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: listWorkspaces
      x-speakeasy-alias: listWorkspaces
      x-speakeasy-group: Workspaces
      summary: Airbyte List Workspaces
      parameters:
      - name: workspaceIds
        description: The UUIDs of the workspaces you wish to fetch. Empty list will retrieve all allowed workspaces.
        schema:
          type: array
          items:
            format: uuid
            type: string
        in: query
        required: false
      - name: includeDeleted
        description: Include deleted workspaces in the returned results.
        schema:
          default: false
          type: boolean
        in: query
        required: false
      - name: limit
        description: Set the limit on the number of workspaces returned. The default is 20.
        schema:
          format: int32
          type: integer
          minimum: 1
          maximum: 100
          default: 20
        in: query
      - name: offset
        description: Set the offset to start at when returning workspaces. The default is 0
        schema:
          type: integer
          format: int32
          minimum: 0
          default: 0
        in: query
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - public_workspaces
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCreateRequest'
            examples:
              Workspace Creation Request Example:
                value:
                  name: Company Workspace Name
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
              examples:
                Workspace Creation Response Example:
                  value:
                    workspaceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5
          description: Successful operation
        '400':
          description: Invalid data
        '403':
          description: Not allowed
      operationId: createWorkspace
      x-speakeasy-alias: createWorkspace
      x-speakeasy-group: Workspaces
      summary: Airbyte Create a Workspace
      x-speakeasy-entity-operation: Workspace#create
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /workspaces/{workspaceId}:
    parameters:
    - name: workspaceId
      schema:
        format: UUID
        type: string
      in: path
      required: true
    get:
      tags:
      - public_workspaces
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
              examples:
                Workspace Get Response Example:
                  value:
                    workspaceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826
                    name: Acme Company
                    dataResidency: auto
          description: Get a Workspace by the id in the path.
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: getWorkspace
      x-speakeasy-alias: getWorkspace
      x-speakeasy-group: Workspaces
      summary: Airbyte Get Workspace Details
      x-speakeasy-entity-operation: Workspace#read
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - public_workspaces
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceUpdateRequest'
            examples:
              Workspace Update Request Example:
                value:
                  name: Company Workspace Name
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
              examples:
                Workspace Update Response Example:
                  value:
                    workspaceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5
          description: Successful operation
        '400':
          description: Invalid data
        '403':
          description: Not allowed
      operationId: updateWorkspace
      x-speakeasy-alias: updateWorkspace
      x-speakeasy-group: Workspaces
      summary: Airbyte Update a Workspace
      x-speakeasy-entity-operation: Workspace#update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - public_workspaces
      responses:
        '204':
          description: The resource was deleted successfully
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: deleteWorkspace
      x-speakeasy-alias: deleteWorkspace
      x-speakeasy-group: Workspaces
      summary: Airbyte Delete a Workspace
      x-speakeasy-entity-operation: Workspace#delete
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /workspaces/{workspaceId}/oauthCredentials:
    parameters:
    - name: workspaceId
      schema:
        format: UUID
        type: string
      in: path
      required: true
    put:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceOAuthCredentialsRequest'
        required: true
      tags:
      - public_workspaces
      responses:
        '200':
          description: OAuth credential override was successful.
        '400':
          description: A field in the body has not been set appropriately.
        '403':
          description: API key is invalid.
      operationId: createOrUpdateWorkspaceOAuthCredentials
      x-speakeasy-alias: createOrUpdateWorkspaceOAuthCredentials
      x-speakeasy-group: Workspaces
      summary: Airbyte Create OAuth Override Credentials for a Workspace and Source Type
      description: 'Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth.

        In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination.'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    NotificationConfig:
      description: Configures a notification.
      type: object
      properties:
        email:
          $ref: '#/components/schemas/EmailNotificationConfig'
        webhook:
          $ref: '#/components/schemas/WebhookNotificationConfig'
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    WorkspacesResponse:
      title: Root Type for WorkspacesResponse
      description: ''
      required:
      - data
      type: object
      properties:
        previous:
          type: string
        next:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceResponse'
      example:
        next: https://api.airbyte.com/v1/workspaces?limit=5&offset=10
        previous: https://api.airbyte.com/v1/workspaces?limit=5&offset=0
        data:
          workspaceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826
          name: Acme Company
          dataResidency: auto
      x-speakeasy-component: true
    NotificationsConfig:
      description: Configures workspace notifications.
      type: object
      properties:
        failure:
          $ref: '#/components/schemas/NotificationConfig'
        success:
          $ref: '#/components/schemas/NotificationConfig'
        connectionUpdate:
          $ref: '#/components/schemas/NotificationConfig'
        connectionUpdateActionRequired:
          $ref: '#/components/schemas/NotificationConfig'
        syncDisabled:
          $ref: '#/components/schemas/NotificationConfig'
        syncDisabledWarning:
          $ref: '#/components/schemas/NotificationConfig'
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    ActorTypeEnum:
      description: Whether you're setting this override for a source or destination
      enum:
      - source
      - destination
      x-speakeasy-component: true
    WorkspaceOAuthCredentialsRequest:
      title: Root Type for WorkspaceOAuthCredentials
      description: POST body for creating/updating workspace level OAuth credentials
      required:
      - actorType
      - name
      - configuration
      type: object
      properties:
        actorType:
          $ref: '#/components/schemas/ActorTypeEnum'
        name:
          type: string
          description: The name of the source i.e. google-ads
        configuration:
          $ref: '#/components/schemas/OAuthCredentialsConfiguration'
      x-speakeasy-component: true
    WebhookNotificationConfig:
      description: Configures a webhook notification.
      type: object
      properties:
        enabled:
          type: boolean
        url:
          type: string
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    EmailNotificationConfig:
      description: Configures an email notification.
      type: object
      properties:
        enabled:
          type: boolean
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    OAuthCredentialsConfiguration:
      description: The configuration for this source/destination based on the OAuth section of the relevant specification.
      type: object
      example:
        credentials:
          client_id: 871d9b60-11d1-44cb-8c92-c246d53bf87e
          client_secret: shhhhhh
      x-speakeasy-component: true
    WorkspaceCreateRequest:
      required:
      - name
      type: object
      properties:
        name:
          description: Name of the workspace
          type: string
        organizationId:
          description: ID of organization to add workspace to.
          format: uuid
          type: string
        notifications:
          $ref: '#/components/schemas/NotificationsConfig'
        regionId:
          type: string
          format: uuid
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    WorkspaceUpdateRequest:
      type: object
      properties:
        name:
          description: Name of the workspace
          type: string
        notifications:
          $ref: '#/components/schemas/NotificationsConfig'
        regionId:
          type: string
          format: uuid
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    WorkspaceResponse:
      title: Root Type for WorkspaceResponse
      description: Provides details of a single workspace.
      type: object
      required:
      - workspaceId
      - name
      - dataResidency
      - notifications
      properties:
        workspaceId:
          format: UUID
          type: string
        name:
          type: string
        dataResidency:
          type: string
        notifications:
          $ref: '#/components/schemas/NotificationsConfig'
      x-speakeasy-entity: Workspace
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true