airbyte-api — public

naftiko: 1.0.0-alpha2
info:
  label: airbyte-api — public
  description: 'airbyte-api — public. 91 operations. Lead operation: Airbyte Root Path, Currently Returns a Redirect to the
    Documentation. Self-contained Naftiko capability covering one Airbyte business surface.'
  tags:
  - Airbyte
  - public
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AIRBYTE_API_KEY: AIRBYTE_API_KEY
capability:
  consumes:
  - type: http
    namespace: airbyte-public
    baseUri: https://api.airbyte.com/v1
    description: airbyte-api — public business capability. Self-contained, no shared references.
    resources:
    - name: root
      path: /
      operations:
      - name: getdocumentation
        method: GET
        description: Airbyte Root Path, Currently Returns a Redirect to the Documentation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications
      path: /applications
      operations:
      - name: listapplications
        method: GET
        description: Airbyte List Applications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createapplication
        method: POST
        description: Airbyte Create an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: applications-token
      path: /applications/token
      operations:
      - name: createaccesstoken
        method: POST
        description: Airbyte Get an Access Token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: applications-applicationId
      path: /applications/{applicationId}
      operations:
      - name: getapplication
        method: GET
        description: Airbyte Get an Application Detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteapplication
        method: DELETE
        description: Airbyte Deletes an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: connections
      path: /connections
      operations:
      - name: createconnection
        method: POST
        description: Airbyte Create a Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listconnections
        method: GET
        description: Airbyte List Connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceIds
          in: query
          type: array
          description: The UUIDs of the workspaces you wish to list connections for. Empty list will retrieve all allowed
            workspaces.
        - name: tagIds
          in: query
          type: array
          description: The UUIDs of the tags you wish to list connections for. Empty list will retrieve all connections.
        - name: includeDeleted
          in: query
          type: boolean
          description: Include deleted connections in the returned results.
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of Connections returned. The default is 20.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning Connections. The default is 0
    - name: connections-connectionId
      path: /connections/{connectionId}
      operations:
      - name: getconnection
        method: GET
        description: Airbyte Get Connection Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchconnection
        method: PATCH
        description: Airbyte Update Connection Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconnection
        method: DELETE
        description: Airbyte Delete a Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: connector_definitions
      path: /connector_definitions
      operations:
      - name: listconnectordefinitions
        method: GET
        description: Airbyte List Connector Definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: The type of connector definition to list
          required: true
        - name: workspaceId
          in: query
          type: string
          description: The UUID of the workspace you wish to list connector definitions for. One of this or organizationId
            must be populated.
    - name: dataplanes
      path: /dataplanes
      operations:
      - name: listdataplanes
        method: GET
        description: Airbyte List Dataplanes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: regionIds
          in: query
          type: array
          description: The UUIDs of the regions to filter by. If provided, only dataplanes belonging to these regions will
            be returned. Empty list will retrieve all dataplanes accessi
      - name: createdataplane
        method: POST
        description: Airbyte Create a Dataplane
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: dataplanes-dataplaneId
      path: /dataplanes/{dataplaneId}
      operations:
      - name: getdataplane
        method: GET
        description: Airbyte Get a Dataplane
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedataplane
        method: PATCH
        description: Airbyte Update a Dataplane
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletedataplane
        method: DELETE
        description: Airbyte Delete a Dataplane
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: destinations
      path: /destinations
      operations:
      - name: listdestinations
        method: GET
        description: Airbyte List Destinations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceIds
          in: query
          type: array
          description: The UUIDs of the workspaces you wish to list destinations for. Empty list will retrieve all allowed
            workspaces.
        - name: includeDeleted
          in: query
          type: boolean
          description: Include deleted destinations in the returned results.
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of destinations returned. The default is 20.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning destinations. The default is 0
      - name: createdestination
        method: POST
        description: Airbyte Create a Destination
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: destinations-destinationId
      path: /destinations/{destinationId}
      operations:
      - name: getdestination
        method: GET
        description: Airbyte Get Destination Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeSecretCoordinates
          in: query
          type: boolean
          description: Rather than return *** for secret properties include the secret coordinate information
      - name: deletedestination
        method: DELETE
        description: Airbyte Delete a Destination
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchdestination
        method: PATCH
        description: Airbyte Update a Destination
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: putdestination
        method: PUT
        description: Airbyte Update a Destination and Fully Overwrite it
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: embedded-organizations
      path: /embedded/organizations
      operations:
      - name: listembeddedorganizationsbyuser
        method: GET
        description: Airbyte List Organizations That a User Has Access to That Have Embedded Enabled.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: embedded-scoped_token
      path: /embedded/scoped_token
      operations:
      - name: generateembeddedscopedtoken
        method: POST
        description: Airbyte Generate a Scoped Token for Airbyte Embedded
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: embedded-widget_token
      path: /embedded/widget_token
      operations:
      - name: getembeddedwidget
        method: POST
        description: Airbyte Get a Widget Token for Airbyte Embedded
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups
      path: /groups
      operations:
      - name: listgroups
        method: GET
        description: Airbyte List Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: query
          type: string
          description: Filter groups by organization ID
          required: true
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of Groups returned. The default is 20 Groups.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning Groups. The default is 0.
      - name: creategroup
        method: POST
        description: Airbyte Create Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupId
      path: /groups/{groupId}
      operations:
      - name: getgroup
        method: GET
        description: Airbyte Get Group Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategroup
        method: PATCH
        description: Airbyte Update Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletegroup
        method: DELETE
        description: Airbyte Delete Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupId-members
      path: /groups/{groupId}/members
      operations:
      - name: listgroupmembers
        method: GET
        description: Airbyte List Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of members returned. The default is 20.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning members. The default is 0.
      - name: addgroupmember
        method: POST
        description: Airbyte Add Member to Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupId-members-userId
      path: /groups/{groupId}/members/{userId}
      operations:
      - name: removegroupmember
        method: DELETE
        description: Airbyte Remove Member from Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupId-permissions
      path: /groups/{groupId}/permissions
      operations:
      - name: listgrouppermissions
        method: GET
        description: Airbyte List Group Permissions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: creategrouppermission
        method: POST
        description: Airbyte Create Group Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupId-permissions-permissionId
      path: /groups/{groupId}/permissions/{permissionId}
      operations:
      - name: deletegrouppermission
        method: DELETE
        description: Airbyte Delete Group Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: health
      path: /health
      operations:
      - name: gethealthcheck
        method: GET
        description: Airbyte Health Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs
      path: /jobs
      operations:
      - name: listjobs
        method: GET
        description: Airbyte List Jobs by Sync Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connectionId
          in: query
          type: string
          description: Filter the Jobs by connectionId.
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of Jobs returned. The default is 20 Jobs.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning Jobs. The default is 0.
        - name: jobType
          in: query
          type: string
          description: Filter the Jobs by jobType.
        - name: workspaceIds
          in: query
          type: array
          description: The UUIDs of the workspaces you wish to list jobs for. Empty list will retrieve all allowed workspaces.
        - name: status
          in: query
          type: string
          description: The Job status you want to filter by
        - name: createdAtStart
          in: query
          type: string
          description: The start date to filter by
        - name: createdAtEnd
          in: query
          type: string
          description: The end date to filter by
        - name: updatedAtStart
          in: query
          type: string
          description: The start date to filter by
        - name: updatedAtEnd
          in: query
          type: string
          description: The end date to filter by
        - name: orderBy
          in: query
          type: string
          description: The field and method to use for ordering
      - name: createjob
        method: POST
        description: Airbyte Trigger a Sync or Reset Job of a Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: jobs-jobId
      path: /jobs/{jobId}
      operations:
      - name: getjob
        method: GET
        description: Airbyte Get Job Status and Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: canceljob
        method: DELETE
        description: Airbyte Cancel a Running Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: oauth-callback
      path: /oauth/callback
      operations:
      - name: oauthcallback
        method: GET
        description: Airbyte Receive OAuth Callbacks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryParams
          in: query
          type: object
          description: Query parameters. Should contain state and code.
    - name: organizations
      path: /organizations
      operations:
      - name: listorganizationsforuser
        method: GET
        description: Airbyte List All Organizations for a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-organizationId-oauthCredentials
      path: /organizations/{organizationId}/oauthCredentials
      operations:
      - name: createorupdateorganizationoauthcredentials
        method: PUT
        description: Airbyte Create OAuth Override Credentials for an Organization and Source Type.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-oauthCredentials-actorType-name
      path: /organizations/{organizationId}/oauthCredentials/{actorType}/{name}
      operations:
      - name: deleteorganizationoauthcredentials
        method: DELETE
        description: Airbyte Delete OAuth Override Credentials for an Organization and Source/destination Type.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: actorType
          in: path
          type: string
          required: true
        - name: name
          in: path
          type: string
          description: The name of the source or destination i.e. google-ads
          required: true
    - name: permissions
      path: /permissions
      operations:
      - name: listpermissions
        method: GET
        description: Airbyte List Permissions by User Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: query
          type: string
          description: User Id in permission.
        - name: organizationId
          in: query
          type: string
          description: This is required if you want to read someone else's permissions, and you should have organization admin
            or a higher role.
      - name: createpermission
        method: POST
        description: Airbyte Create a Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: permissions-permissionId
      path: /permissions/{permissionId}
      operations:
      - name: getpermission
        method: GET
        description: Airbyte Get Permission Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatepermission
        method: PATCH
        description: Airbyte Update a Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletepermission
        method: DELETE
        description: Airbyte Delete a Permission
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: regions
      path: /regions
      operations:
      - name: listregions
        method: GET
        description: Airbyte List Regions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: query
          type: string
          description: The UUID of the organization to list regions for
          required: true
      - name: createregion
        method: POST
        description: Airbyte Create a Region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: regions-regionId
      path: /regions/{regionId}
      operations:
      - name: getregion
        method: GET
        description: Airbyte Get a Region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateregion
        method: PATCH
        description: Airbyte Update a Region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteregion
        method: DELETE
        description: Airbyte Delete a Region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sources
      path: /sources
      operations:
      - name: listsources
        method: GET
        description: Airbyte List Sources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceIds
          in: query
          type: array
          description: The UUIDs of the workspaces you wish to list sources for. Empty list will retrieve all allowed workspaces.
        - name: includeDeleted
          in: query
          type: boolean
          description: Include deleted sources in the returned results.
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of sources returned. The default is 20.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning sources. The default is 0
      - name: createsource
        method: POST
        description: Airbyte Create a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: sources-initiateOAuth
      path: /sources/initiateOAuth
      operations:
      - name: initiateoauth
        method: POST
        description: Airbyte Initiate OAuth for a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sources-sourceId
      path: /sources/{sourceId}
      operations:
      - name: getsource
        method: GET
        description: Airbyte Get Source Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeSecretCoordinates
          in: query
          type: boolean
          description: Rather than return *** for secret properties include the secret coordinate information
      - name: patchsource
        method: PATCH
        description: Airbyte Update a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: putsource
        method: PUT
        description: Airbyte Update a Source and Fully Overwrite it
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletesource
        method: DELETE
        description: Airbyte Delete a Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: streams
      path: /streams
      operations:
      - name: getstreamproperties
        method: GET
        description: Airbyte Get Stream Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sourceId
          in: query
          type: string
          description: ID of the source
          required: true
        - name: destinationId
          in: query
          type: string
          description: ID of the destination
        - name: ignoreCache
          in: query
          type: boolean
          description: If true pull the latest schema from the source, else pull from cache (default false)
    - name: tags
      path: /tags
      operations:
      - name: listtags
        method: GET
        description: Airbyte List All Tags
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceIds
          in: query
          type: array
      - name: createtag
        method: POST
        description: Airbyte Create a Tag
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: tags-tagId
      path: /tags/{tagId}
      operations:
      - name: gettag
        method: GET
        description: Airbyte Get a Tag
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletetag
        method: DELETE
        description: Airbyte Delete a Tag
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatetag
        method: PATCH
        description: Airbyte Update a Tag
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users
      path: /users
      operations:
      - name: listuserswithinanorganization
        method: GET
        description: Airbyte List All Users Within an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: query
          type: string
          required: true
        - name: ids
          in: query
          type: array
          description: List of user IDs to filter by
        - name: emails
          in: query
          type: array
          description: List of user emails to filter by
    - name: workspaces
      path: /workspaces
      operations:
      - name: listworkspaces
        method: GET
        description: Airbyte List Workspaces
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceIds
          in: query
          type: array
          description: The UUIDs of the workspaces you wish to fetch. Empty list will retrieve all allowed workspaces.
        - name: includeDeleted
          in: query
          type: boolean
          description: Include deleted workspaces in the returned results.
        - name: limit
          in: query
          type: integer
          description: Set the limit on the number of workspaces returned. The default is 20.
        - name: offset
          in: query
          type: integer
          description: Set the offset to start at when returning workspaces. The default is 0
      - name: createworkspace
        method:

# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/capabilities/airbyte-public.yaml