KosmoKrator

data

Airbyte Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Airbyte KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.airbyte.*. Use lua_read_doc("integrations.airbyte") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Airbyte workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.airbyte.health_check({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("airbyte"))' --json
kosmo integrations:lua --eval 'print(docs.read("airbyte.health_check"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local airbyte = app.integrations.airbyte
local result = airbyte.health_check({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.airbyte, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.airbyte.default.* or app.integrations.airbyte.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Airbyte, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Airbyte Lua Docs

Airbyte tools are exposed under app.integrations.airbyte. This package is generated from Airbyte’s official OpenAPI specification and exposes all 37 operations found in that spec.

Configure access_token and optionally url. The default URL is https://api.airbyte.com/v1; self-managed hosts can use their public API base URL.

Pass path, query, and header parameters as top-level snake_case arguments. Pass JSON request bodies under body.

local health = app.integrations.airbyte.airbyte_get_health_check({})
local connections = app.integrations.airbyte.airbyte_list_connections({ workspace_ids = { 'workspace-id' } })

Coverage Notes

The manifest airbyte-openapi-manifest.json records source URL, operation IDs, methods, paths, tool slugs, and classes.

Representative Tools

  • airbyte_get_health_check - GET /health
  • airbyte_list_jobs - GET /jobs
  • airbyte_create_job - POST /jobs
  • airbyte_get_job - GET /jobs/{jobId}
  • airbyte_cancel_job - DELETE /jobs/{jobId}
  • airbyte_list_sources - GET /sources
  • airbyte_create_source - POST /sources
  • airbyte_get_source - GET /sources/{sourceId}
  • airbyte_patch_source - PATCH /sources/{sourceId}
  • airbyte_put_source - PUT /sources/{sourceId}
  • airbyte_delete_source - DELETE /sources/{sourceId}
  • airbyte_list_destinations - GET /destinations
  • airbyte_create_destination - POST /destinations
  • airbyte_get_destination - GET /destinations/{destinationId}
  • airbyte_delete_destination - DELETE /destinations/{destinationId}
  • airbyte_patch_destination - PATCH /destinations/{destinationId}
  • airbyte_put_destination - PUT /destinations/{destinationId}
  • airbyte_initiate_oauth - POST /sources/initiateOAuth
  • airbyte_create_connection - POST /connections
  • airbyte_list_connections - GET /connections
Raw agent markdown 
# Airbyte Lua Docs

Airbyte tools are exposed under `app.integrations.airbyte`. This package is generated from Airbyte's official OpenAPI specification and exposes all 37 operations found in that spec.

Configure `access_token` and optionally `url`. The default URL is `https://api.airbyte.com/v1`; self-managed hosts can use their public API base URL.

Pass path, query, and header parameters as top-level snake_case arguments. Pass JSON request bodies under `body`.

```lua
local health = app.integrations.airbyte.airbyte_get_health_check({})
local connections = app.integrations.airbyte.airbyte_list_connections({ workspace_ids = { 'workspace-id' } })
```

## Coverage Notes

The manifest `airbyte-openapi-manifest.json` records source URL, operation IDs, methods, paths, tool slugs, and classes.

## Representative Tools

- `airbyte_get_health_check` - GET `/health`
- `airbyte_list_jobs` - GET `/jobs`
- `airbyte_create_job` - POST `/jobs`
- `airbyte_get_job` - GET `/jobs/{jobId}`
- `airbyte_cancel_job` - DELETE `/jobs/{jobId}`
- `airbyte_list_sources` - GET `/sources`
- `airbyte_create_source` - POST `/sources`
- `airbyte_get_source` - GET `/sources/{sourceId}`
- `airbyte_patch_source` - PATCH `/sources/{sourceId}`
- `airbyte_put_source` - PUT `/sources/{sourceId}`
- `airbyte_delete_source` - DELETE `/sources/{sourceId}`
- `airbyte_list_destinations` - GET `/destinations`
- `airbyte_create_destination` - POST `/destinations`
- `airbyte_get_destination` - GET `/destinations/{destinationId}`
- `airbyte_delete_destination` - DELETE `/destinations/{destinationId}`
- `airbyte_patch_destination` - PATCH `/destinations/{destinationId}`
- `airbyte_put_destination` - PUT `/destinations/{destinationId}`
- `airbyte_initiate_oauth` - POST `/sources/initiateOAuth`
- `airbyte_create_connection` - POST `/connections`
- `airbyte_list_connections` - GET `/connections`
Metadata-derived Lua example 
local result = app.integrations.airbyte.health_check({})
print(result)

Functions

health_check Read

Health Check Official Airbyte endpoint: GET /health

Lua path
app.integrations.airbyte.health_check
Full name
airbyte.airbyte_get_health_check
ParameterTypeRequiredDescription
No parameters.
list_jobs_sync_type Read

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

Lua path
app.integrations.airbyte.list_jobs_sync_type
Full name
airbyte.airbyte_list_jobs
ParameterTypeRequiredDescription
No parameters.
trigger_sync_or_reset_job_connection Write

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

Lua path
app.integrations.airbyte.trigger_sync_or_reset_job_connection
Full name
airbyte.airbyte_create_job
ParameterTypeRequiredDescription
No parameters.
get_job_status_and_details Read

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

Lua path
app.integrations.airbyte.get_job_status_and_details
Full name
airbyte.airbyte_get_job
ParameterTypeRequiredDescription
No parameters.
cancel_running_job Write

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

Lua path
app.integrations.airbyte.cancel_running_job
Full name
airbyte.airbyte_cancel_job
ParameterTypeRequiredDescription
No parameters.
list_sources Read

List sources Official Airbyte endpoint: GET /sources

Lua path
app.integrations.airbyte.list_sources
Full name
airbyte.airbyte_list_sources
ParameterTypeRequiredDescription
No parameters.
create_source Write

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.

Lua path
app.integrations.airbyte.create_source
Full name
airbyte.airbyte_create_source
ParameterTypeRequiredDescription
No parameters.
get_source_details Read

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

Lua path
app.integrations.airbyte.get_source_details
Full name
airbyte.airbyte_get_source
ParameterTypeRequiredDescription
No parameters.
update_source Write

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

Lua path
app.integrations.airbyte.update_source
Full name
airbyte.airbyte_patch_source
ParameterTypeRequiredDescription
No parameters.
update_source_and_fully_overwrite_it Write

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

Lua path
app.integrations.airbyte.update_source_and_fully_overwrite_it
Full name
airbyte.airbyte_put_source
ParameterTypeRequiredDescription
No parameters.
delete_source Write

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

Lua path
app.integrations.airbyte.delete_source
Full name
airbyte.airbyte_delete_source
ParameterTypeRequiredDescription
No parameters.
list_destinations Read

List destinations Official Airbyte endpoint: GET /destinations

Lua path
app.integrations.airbyte.list_destinations
Full name
airbyte.airbyte_list_destinations
ParameterTypeRequiredDescription
No parameters.
create_destination Write

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.

Lua path
app.integrations.airbyte.create_destination
Full name
airbyte.airbyte_create_destination
ParameterTypeRequiredDescription
No parameters.
get_destination_details Read

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

Lua path
app.integrations.airbyte.get_destination_details
Full name
airbyte.airbyte_get_destination
ParameterTypeRequiredDescription
No parameters.
delete_destination Write

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

Lua path
app.integrations.airbyte.delete_destination
Full name
airbyte.airbyte_delete_destination
ParameterTypeRequiredDescription
No parameters.
update_destination Write

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

Lua path
app.integrations.airbyte.update_destination
Full name
airbyte.airbyte_patch_destination
ParameterTypeRequiredDescription
No parameters.
update_destination_and_fully_overwrite_it Write

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

Lua path
app.integrations.airbyte.update_destination_and_fully_overwrite_it
Full name
airbyte.airbyte_put_destination
ParameterTypeRequiredDescription
No parameters.
initiate_oauth_source Write

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

Lua path
app.integrations.airbyte.initiate_oauth_source
Full name
airbyte.airbyte_initiate_oauth
ParameterTypeRequiredDescription
No parameters.
create_connection Write

Create a connection Official Airbyte endpoint: POST /connections

Lua path
app.integrations.airbyte.create_connection
Full name
airbyte.airbyte_create_connection
ParameterTypeRequiredDescription
No parameters.
list_connections Read

List connections Official Airbyte endpoint: GET /connections

Lua path
app.integrations.airbyte.list_connections
Full name
airbyte.airbyte_list_connections
ParameterTypeRequiredDescription
No parameters.
get_connection_details Read

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

Lua path
app.integrations.airbyte.get_connection_details
Full name
airbyte.airbyte_get_connection
ParameterTypeRequiredDescription
No parameters.
update_connection_details Write

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

Lua path
app.integrations.airbyte.update_connection_details
Full name
airbyte.airbyte_patch_connection
ParameterTypeRequiredDescription
No parameters.
delete_connection Write

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

Lua path
app.integrations.airbyte.delete_connection
Full name
airbyte.airbyte_delete_connection
ParameterTypeRequiredDescription
No parameters.
get_stream_properties Read

Get stream properties Official Airbyte endpoint: GET /streams

Lua path
app.integrations.airbyte.get_stream_properties
Full name
airbyte.airbyte_get_stream_properties
ParameterTypeRequiredDescription
No parameters.
list_workspaces Read

List workspaces Official Airbyte endpoint: GET /workspaces

Lua path
app.integrations.airbyte.list_workspaces
Full name
airbyte.airbyte_list_workspaces
ParameterTypeRequiredDescription
No parameters.
create_workspace Write

Create a workspace Official Airbyte endpoint: POST /workspaces

Lua path
app.integrations.airbyte.create_workspace
Full name
airbyte.airbyte_create_workspace
ParameterTypeRequiredDescription
No parameters.
get_workspace_details Read

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

Lua path
app.integrations.airbyte.get_workspace_details
Full name
airbyte.airbyte_get_workspace
ParameterTypeRequiredDescription
No parameters.
update_workspace Write

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

Lua path
app.integrations.airbyte.update_workspace
Full name
airbyte.airbyte_update_workspace
ParameterTypeRequiredDescription
No parameters.
delete_workspace Write

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

Lua path
app.integrations.airbyte.delete_workspace
Full name
airbyte.airbyte_delete_workspace
ParameterTypeRequiredDescription
No parameters.
create_oauth_override_credentials_workspace_and_source_type Write

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

Lua path
app.integrations.airbyte.create_oauth_override_credentials_workspace_and_source_type
Full name
airbyte.airbyte_create_or_update_workspace_oauth_credentials
ParameterTypeRequiredDescription
No parameters.
get_permission_details Read

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

Lua path
app.integrations.airbyte.get_permission_details
Full name
airbyte.airbyte_get_permission
ParameterTypeRequiredDescription
No parameters.
update_permission Write

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

Lua path
app.integrations.airbyte.update_permission
Full name
airbyte.airbyte_update_permission
ParameterTypeRequiredDescription
No parameters.
delete_permission Write

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

Lua path
app.integrations.airbyte.delete_permission
Full name
airbyte.airbyte_delete_permission
ParameterTypeRequiredDescription
No parameters.
list_permissions_user_id Read

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

Lua path
app.integrations.airbyte.list_permissions_user_id
Full name
airbyte.airbyte_list_permissions
ParameterTypeRequiredDescription
No parameters.
create_permission Write

Create a permission Official Airbyte endpoint: POST /permissions

Lua path
app.integrations.airbyte.create_permission
Full name
airbyte.airbyte_create_permission
ParameterTypeRequiredDescription
No parameters.
list_all_organizations_user Read

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

Lua path
app.integrations.airbyte.list_all_organizations_user
Full name
airbyte.airbyte_list_organizations_for_user
ParameterTypeRequiredDescription
No parameters.
list_all_users_within_organization Read

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

Lua path
app.integrations.airbyte.list_all_users_within_organization
Full name
airbyte.airbyte_list_users_within_an_organization
ParameterTypeRequiredDescription
No parameters.