airbyte-api 0.40.0

Python Client SDK for Airbyte API

Programatically control Airbyte Cloud through an API.

Authentication

Developers will need to create an API Key within your Developer Portal to make API requests. You can use your existing Airbyte account to log in to the Developer Portal. Once you are in the Developer Portal, use the API Keys tab to create or remove API Keys. You can see a walkthrough demo here🎦

The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.

SDK Installation

pip install airbyte-api

SDK Example Usage

import airbyte
from airbyte.models import shared

s = airbyte.Airbyte(
    security=shared.Security(
        basic_auth=shared.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
)

req = shared.ConnectionCreateRequest(
    configurations=shared.StreamConfigurations(
        streams=[
            shared.StreamConfiguration(
                cursor_field=[
                    'violet',
                ],
                name='Account',
                primary_key=[
                    [
                        'BMW',
                    ],
                ],
            ),
        ],
    ),
    destination_id='e362083e-afc8-4559-94e0-a570f6dd427d',
    namespace_format='${SOURCE_NAMESPACE}',
    schedule=shared.ConnectionSchedule(
        schedule_type=shared.ScheduleTypeEnum.CRON,
    ),
    source_id='3a555847-8358-4423-a5b6-c7b3fd2fd307',
)

res = s.connections.create_connection(req)

if res.connection_response is not None:
    # handle response
    pass

Available Resources and Operations

connections

• create_connection - Create a connection
• delete_connection - Delete a Connection
• get_connection - Get Connection details
• list_connections - List connections
• patch_connection - Update Connection details

destinations

• create_destination - Create a destination
• delete_destination - Delete a Destination
• get_destination - Get Destination details
• list_destinations - List destinations
• patch_destination - Update a Destination
• put_destination - Update a Destination and fully overwrite it

jobs

• cancel_job - Cancel a running Job
• create_job - Trigger a sync or reset job of a connection
• get_job - Get Job status and details
• list_jobs - List Jobs by sync type

sources

• create_source - Create a source
• delete_source - Delete a Source
• get_source - Get Source details
• initiate_o_auth - Initiate OAuth for a source
• list_sources - List sources
• patch_source - Update a Source
• put_source - Update a Source and fully overwrite it

streams

• get_stream_properties - Get stream properties

workspaces

• create_or_update_workspace_o_auth_credentials - Create OAuth override credentials for a workspace and source type.
• create_workspace - Create a workspace
• delete_workspace - Delete a Workspace
• get_workspace - Get Workspace details
• list_workspaces - List workspaces
• update_workspace - Update a workspace

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

SDK Created by Speakeasy