KosmoKrator

data

Airbyte CLI for AI Agents

Use the Airbyte CLI from KosmoKrator to call Airbyte tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Airbyte CLI Setup

Airbyte can be configured headlessly with `kosmokrator integrations:configure airbyte`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure airbyte --set access_token="$AIRBYTE_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor airbyte --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token AIRBYTE_ACCESS_TOKEN Secret secret yes Access Token
url AIRBYTE_URL URL url no API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call airbyte.airbyte_get_health_check '{}' --json
Provider shortcut
kosmo integrations:airbyte airbyte_get_health_check '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs airbyte --json
kosmo integrations:docs airbyte.airbyte_get_health_check --json
kosmo integrations:schema airbyte.airbyte_get_health_check --json
kosmo integrations:search "Airbyte" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

airbyte.airbyte_get_health_check

Health Check Official Airbyte endpoint: GET /health

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_health_check '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_health_check '{}' --json

airbyte.airbyte_list_jobs

List Jobs by sync type Official Airbyte endpoint: GET /jobs

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_jobs '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_jobs '{}' --json

airbyte.airbyte_create_job

Trigger a sync or reset job of a connection Official Airbyte endpoint: POST /jobs

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_job '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_job '{}' --json

airbyte.airbyte_get_job

Get Job status and details Official Airbyte endpoint: GET /jobs/{jobId}

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_job '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_job '{}' --json

airbyte.airbyte_cancel_job

Cancel a running Job Official Airbyte endpoint: DELETE /jobs/{jobId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_cancel_job '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_cancel_job '{}' --json

airbyte.airbyte_list_sources

List sources Official Airbyte endpoint: GET /sources

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_sources '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_sources '{}' --json

airbyte.airbyte_create_source

Create a source Official Airbyte endpoint: POST /sources Creates a source given a name, workspace id, and a json blob containing the configuration for the source.

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_source '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_source '{}' --json

airbyte.airbyte_get_source

Get Source details Official Airbyte endpoint: GET /sources/{sourceId}

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_source '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_source '{}' --json

airbyte.airbyte_patch_source

Update a Source Official Airbyte endpoint: PATCH /sources/{sourceId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_patch_source '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_patch_source '{}' --json

airbyte.airbyte_put_source

Update a Source and fully overwrite it Official Airbyte endpoint: PUT /sources/{sourceId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_put_source '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_put_source '{}' --json

airbyte.airbyte_delete_source

Delete a Source Official Airbyte endpoint: DELETE /sources/{sourceId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_delete_source '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_delete_source '{}' --json

airbyte.airbyte_list_destinations

List destinations Official Airbyte endpoint: GET /destinations

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_destinations '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_destinations '{}' --json

airbyte.airbyte_create_destination

Create a destination Official Airbyte endpoint: POST /destinations Creates a destination given a name, workspace id, and a json blob containing the configuration for the source.

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_destination '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_destination '{}' --json

airbyte.airbyte_get_destination

Get Destination details Official Airbyte endpoint: GET /destinations/{destinationId}

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_destination '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_destination '{}' --json

airbyte.airbyte_delete_destination

Delete a Destination Official Airbyte endpoint: DELETE /destinations/{destinationId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_delete_destination '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_delete_destination '{}' --json

airbyte.airbyte_patch_destination

Update a Destination Official Airbyte endpoint: PATCH /destinations/{destinationId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_patch_destination '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_patch_destination '{}' --json

airbyte.airbyte_put_destination

Update a Destination and fully overwrite it Official Airbyte endpoint: PUT /destinations/{destinationId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_put_destination '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_put_destination '{}' --json

airbyte.airbyte_initiate_oauth

Initiate OAuth for a source Official Airbyte endpoint: POST /sources/initiateOAuth Given a source ID, workspace ID, and redirect URL, initiates OAuth for the source. This returns a fully formed URL for performing user...

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_initiate_oauth '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_initiate_oauth '{}' --json

airbyte.airbyte_create_connection

Create a connection Official Airbyte endpoint: POST /connections

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_connection '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_connection '{}' --json

airbyte.airbyte_list_connections

List connections Official Airbyte endpoint: GET /connections

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_connections '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_connections '{}' --json

airbyte.airbyte_get_connection

Get Connection details Official Airbyte endpoint: GET /connections/{connectionId}

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_connection '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_connection '{}' --json

airbyte.airbyte_patch_connection

Update Connection details Official Airbyte endpoint: PATCH /connections/{connectionId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_patch_connection '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_patch_connection '{}' --json

airbyte.airbyte_delete_connection

Delete a Connection Official Airbyte endpoint: DELETE /connections/{connectionId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_delete_connection '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_delete_connection '{}' --json

airbyte.airbyte_get_stream_properties

Get stream properties Official Airbyte endpoint: GET /streams

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_stream_properties '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_stream_properties '{}' --json

airbyte.airbyte_list_workspaces

List workspaces Official Airbyte endpoint: GET /workspaces

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_workspaces '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_workspaces '{}' --json

airbyte.airbyte_create_workspace

Create a workspace Official Airbyte endpoint: POST /workspaces

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_workspace '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_workspace '{}' --json

airbyte.airbyte_get_workspace

Get Workspace details Official Airbyte endpoint: GET /workspaces/{workspaceId}

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_workspace '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_workspace '{}' --json

airbyte.airbyte_update_workspace

Update a workspace Official Airbyte endpoint: PATCH /workspaces/{workspaceId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_update_workspace '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_update_workspace '{}' --json

airbyte.airbyte_delete_workspace

Delete a Workspace Official Airbyte endpoint: DELETE /workspaces/{workspaceId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_delete_workspace '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_delete_workspace '{}' --json

airbyte.airbyte_create_or_update_workspace_oauth_credentials

Create OAuth override credentials for a workspace and source type. Official Airbyte endpoint: PUT /workspaces/{workspaceId}/oauthCredentials Create/update a set of OAuth credentials to override the Airbyte-provided OA...

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_or_update_workspace_oauth_credentials '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_or_update_workspace_oauth_credentials '{}' --json

airbyte.airbyte_get_permission

Get Permission details Official Airbyte endpoint: GET /permissions/{permissionId}

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_get_permission '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_get_permission '{}' --json

airbyte.airbyte_update_permission

Update a permission Official Airbyte endpoint: PATCH /permissions/{permissionId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_update_permission '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_update_permission '{}' --json

airbyte.airbyte_delete_permission

Delete a Permission Official Airbyte endpoint: DELETE /permissions/{permissionId}

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_delete_permission '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_delete_permission '{}' --json

airbyte.airbyte_list_permissions

List Permissions by user id Official Airbyte endpoint: GET /permissions

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_permissions '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_permissions '{}' --json

airbyte.airbyte_create_permission

Create a permission Official Airbyte endpoint: POST /permissions

Write write
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_create_permission '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_create_permission '{}' --json

airbyte.airbyte_list_organizations_for_user

List all organizations for a user Official Airbyte endpoint: GET /organizations Lists users organizations.

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_organizations_for_user '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_organizations_for_user '{}' --json

airbyte.airbyte_list_users_within_an_organization

List all users within an organization Official Airbyte endpoint: GET /users Organization Admin user can list all users within the same organization. Also provide filtering on a list of user IDs or/and a list of user e...

Read read
Parameters
none
Generic call
kosmo integrations:call airbyte.airbyte_list_users_within_an_organization '{}' --json
Shortcut
kosmo integrations:airbyte airbyte_list_users_within_an_organization '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

airbyte.airbyte_get_health_check 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_health_check --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_jobs 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_jobs --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_job 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_job --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_job 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_job --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_cancel_job 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_cancel_job --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_sources 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_sources --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_source 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_source --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_source 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_source --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_patch_source 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_patch_source --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_put_source 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_put_source --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_delete_source 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_delete_source --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_destinations 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_destinations --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_destination 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_destination --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_destination 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_destination --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_delete_destination 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_delete_destination --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_patch_destination 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_patch_destination --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_put_destination 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_put_destination --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_initiate_oauth 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_initiate_oauth --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_connection 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_connection --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_connections 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_connections --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_connection 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_connection --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_patch_connection 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_patch_connection --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_delete_connection 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_delete_connection --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_stream_properties 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_stream_properties --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_workspaces 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_workspaces --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_workspace 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_workspace --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_workspace 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_workspace --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_update_workspace 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_update_workspace --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_delete_workspace 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_delete_workspace --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_or_update_workspace_oauth_credentials 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_or_update_workspace_oauth_credentials --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_get_permission 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_get_permission --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_update_permission 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_update_permission --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_delete_permission 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_delete_permission --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_permissions 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_permissions --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_create_permission 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_create_permission --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_organizations_for_user 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_organizations_for_user --json
ParameterTypeRequiredDescription
No parameters.
airbyte.airbyte_list_users_within_an_organization 0 parameters
Schema command
kosmo integrations:schema airbyte.airbyte_list_users_within_an_organization --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.