Skip to content
Overview

Our APIs

Index of every public Keboola API, the stacks and endpoints each one is served from, and how to call them with the API console, Postman or cURL.

All our Keboola services have a public API on api.keboola.com (opens in a new tab). We recommend using either the API Console or Postman Client for sending requests to our API. Most of our APIs accept and return data in JSON format. Many of these APIs require a Storage API token, specified in the X-StorageApi-Token header.

All parts of the Keboola platform can be controlled via an API. The main APIs for our components are:

APIDescription
Keboola Storage API (opens in a new tab) (source (opens in a new tab))Storage is the main Keboola component storing all data.
Keboola Management API (opens in a new tab)API managing Keboola projects and users (and notifications and features).
AI API (opens in a new tab)API for supporting AI features.
Billing API (opens in a new tab)Billing API for Pay as You Go projects.
Developer Portal API (opens in a new tab)Developer Portal is an application separated from Keboola for creating components.
Editor API (opens in a new tab)API for managing SQL editor sessions.
Encryption API (opens in a new tab)Provides Encryption.
Importer API (opens in a new tab)Importer is a helper service for easy table imports.
Notifications API (opens in a new tab)API to subscribe to events, e.g., failed orchestrations.
OAuth Broker API (opens in a new tab)OAuth Broker is a component managing OAuth authorizations of other components.
Query API (opens in a new tab)Query is a service for running SQL queries on Snowflake and BigQuery.
Queue API (opens in a new tab)Queue is a service for running components and managing Jobs.
Sandboxes Service API (opens in a new tab)API for managing Apps and Python/R workspaces.
Scheduler API (opens in a new tab)API to automate configurations.
Stream API (opens in a new tab)The Keboola Stream API allows you to ingest small and frequent events into your project’s storage.
Synchronous Actions API (opens in a new tab)API to trigger Synchronous Actions.
Vault (opens in a new tab)Service handling variables & credentials storage.

If you’re unsure which API to use, refer to our integration guide (opens in a new tab). It describes the roles of different APIs and contains examples of commonly performed actions.

Keboola is available in multiple stacks, which can be either multi-tenant or single-tenant. Current multi-tenant stacks are:

Each stack operates as an independent instance of Keboola services with its own data, users, and tokens. Single-tenant stacks are available for a single enterprise customer, with a domain name in the format connection.CUSTOMER_NAME.keboola.com.

For your own stack, the authoritative list of service hosts is the Storage API (opens in a new tab) index call, GET /v2/storage (no token needed), in its services array.

The API documentation portal (api.*) is deployed independently per stack. Always use the portal for your own stack — tokens are not valid across stacks, and using the wrong portal will cause Invalid Token errors when trying out API calls.

For agentic usage and tooling (AI agents, MCP servers, CI), each stack’s API portal also publishes a machine-readable index of its APIs at https://api.<stack>/apis.json — for example, api.keboola.com/apis.json (opens in a new tab). The index lists each available service with its base apiUrl and a link to its OpenAPI specification (openApiSpecUrl), so tools can discover and load the specs programmatically:

{
"stack": "keboola.com",
"services": [
{
"id": "storage",
"name": "Storage API",
"apiUrl": "https://connection.keboola.com",
"openApiSpecUrl": "https://api.keboola.com/specs/storage.json"
}
]
}

The index is stack-specific (excluded services are omitted). The raw specs under /specs/ keep their original servers, so consumers should use the apiUrl from the index as the base URL. The openApiSpecUrl extension mirrors the source document (.json or .yaml) — use the exact URL from the index rather than assuming one.

If you are calling the APIs directly (not through the portal), modify the hostname accordingly. Otherwise, you may encounter Invalid Token or unauthorized errors. The authoritative list of available endpoints is provided by the Storage API Index Call (opens in a new tab). The following is a sample response:

{
...,
"services": [
{
"id": "import",
"url": "https://import.keboola.com"
},
{
"id": "oauth",
"url": "https://oauth.keboola.com"
},
{
"id": "queue",
"url": "https://queue.keboola.com"
},
{
"id": "billing",
"url": "https://billing.keboola.com"
},
{
"id": "encryption",
"url": "https://encryption.keboola.com"
},
{
"id": "scheduler",
"url": "https://scheduler.keboola.com"
},
{
"id": "sync-actions",
"url": "https://sync-actions.keboola.com"
},
{
"id": "notification",
"url": "https://notification.keboola.com"
}
],
}

The services listed above are:

For convenience, the following table lists active services and their URLs, though for an authoritative answer and in application integrations, we strongly suggest using the above API call.

APIServiceRegionURL
AIaiUS Virginia AWShttps://ai.keboola.com (opens in a new tab)
AIaiUS Virginia GCPhttps://ai.us-east4.gcp.keboola.com (opens in a new tab)
AIaiEU Frankfurt AWShttps://ai.eu-central-1.keboola.com (opens in a new tab)
AIaiEU Ireland Azurehttps://ai.north-europe.azure.keboola.com (opens in a new tab)
AIaiEU Frankfurt GCPhttps://ai.europe-west3.gcp.keboola.com (opens in a new tab)
BillingbillingUS Virginia AWShttps://billing.keboola.com (opens in a new tab)
BillingbillingUS Virginia GCPhttps://billing.us-east4.gcp.keboola.com (opens in a new tab)
BillingbillingEU Frankfurt AWShttps://billing.eu-central-1.keboola.com (opens in a new tab)
BillingbillingEU Ireland Azurehttps://billing.north-europe.azure.keboola.com (opens in a new tab)
BillingbillingEU Frankfurt GCPhttps://billing.europe-west3.gcp.keboola.com (opens in a new tab)
Developer PortaldeveloperUS Virginia AWShttps://developer.keboola.com (opens in a new tab)
Developer PortaldeveloperUS Virginia GCPhttps://developer.us-east4.gcp.keboola.com (opens in a new tab)
Developer PortaldeveloperEU Frankfurt AWShttps://developer.eu-central-1.keboola.com (opens in a new tab)
Developer PortaldeveloperEU Ireland Azurehttps://developer.north-europe.azure.keboola.com (opens in a new tab)
Developer PortaldeveloperEU Frankfurt GCPhttps://developer.europe-west3.gcp.keboola.com (opens in a new tab)
EditoreditorUS Virginia AWShttps://editor.keboola.com (opens in a new tab)
EditoreditorUS Virginia GCPhttps://editor.us-east4.gcp.keboola.com (opens in a new tab)
EditoreditorEU Frankfurt AWShttps://editor.eu-central-1.keboola.com (opens in a new tab)
EditoreditorEU Ireland Azurehttps://editor.north-europe.azure.keboola.com (opens in a new tab)
EditoreditorEU Frankfurt GCPhttps://editor.europe-west3.gcp.keboola.com (opens in a new tab)
EncryptionencryptionUS Virginia AWShttps://encryption.keboola.com (opens in a new tab)
EncryptionencryptionUS Virginia GCPhttps://encryption.us-east4.gcp.keboola.com (opens in a new tab)
EncryptionencryptionEU Frankfurt AWShttps://encryption.eu-central-1.keboola.com (opens in a new tab)
EncryptionencryptionEU Ireland Azurehttps://encryption.north-europe.azure.keboola.com (opens in a new tab)
EncryptionencryptionEU Frankfurt GCPhttps://encryption.europe-west3.gcp.keboola.com (opens in a new tab)
ImporterimportUS Virginia AWShttps://import.keboola.com (opens in a new tab)
ImporterimportUS Virginia GCPhttps://import.us-east4.gcp.keboola.com (opens in a new tab)
ImporterimportEU Frankfurt AWShttps://import.eu-central-1.keboola.com (opens in a new tab)
ImporterimportEU Ireland Azurehttps://import.north-europe.azure.keboola.com (opens in a new tab)
ImporterimportEU Frankfurt GCPhttps://import.europe-west3.gcp.keboola.com (opens in a new tab)
ManagementmanagementUS Virginia AWShttps://management.keboola.com (opens in a new tab)
ManagementmanagementUS Virginia GCPhttps://management.us-east4.gcp.keboola.com (opens in a new tab)
ManagementmanagementEU Frankfurt AWShttps://management.eu-central-1.keboola.com (opens in a new tab)
ManagementmanagementEU Ireland Azurehttps://management.north-europe.azure.keboola.com (opens in a new tab)
ManagementmanagementEU Frankfurt GCPhttps://management.europe-west3.gcp.keboola.com (opens in a new tab)
NotificationnotificationUS Virginia AWShttps://notification.keboola.com (opens in a new tab)
NotificationnotificationUS Virginia GCPhttps://notification.us-east4.gcp.keboola.com (opens in a new tab)
NotificationnotificationEU Frankfurt AWShttps://notification.eu-central-1.keboola.com (opens in a new tab)
NotificationnotificationEU Ireland Azurehttps://notification.north-europe.azure.keboola.com (opens in a new tab)
NotificationnotificationEU Frankfurt GCPhttps://notification.europe-west3.gcp.keboola.com (opens in a new tab)
OAuthoauthUS Virginia AWShttps://oauth.keboola.com (opens in a new tab)
OAuthoauthUS Virginia GCPhttps://oauth.us-east4.gcp.keboola.com (opens in a new tab)
OAuthoauthEU Frankfurt AWShttps://oauth.eu-central-1.keboola.com (opens in a new tab)
OAuthoauthEU Ireland Azurehttps://oauth.north-europe.azure.keboola.com (opens in a new tab)
OAuthoauthEU Frankfurt GCPhttps://oauth.europe-west3.gcp.keboola.com (opens in a new tab)
QueryqueryUS Virginia AWShttps://query.keboola.com (opens in a new tab)
QueryqueryUS Virginia GCPhttps://query.us-east4.gcp.keboola.com (opens in a new tab)
QueryqueryEU Frankfurt AWShttps://query.eu-central-1.keboola.com (opens in a new tab)
QueryqueryEU Ireland Azurehttps://query.north-europe.azure.keboola.com (opens in a new tab)
QueryqueryEU Frankfurt GCPhttps://query.europe-west3.gcp.keboola.com (opens in a new tab)
QueuequeueUS Virginia AWShttps://queue.keboola.com (opens in a new tab)
QueuequeueUS Virginia GCPhttps://queue.us-east4.gcp.keboola.com (opens in a new tab)
QueuequeueEU Frankfurt AWShttps://queue.eu-central-1.keboola.com (opens in a new tab)
QueuequeueEU Ireland Azurehttps://queue.north-europe.azure.keboola.com (opens in a new tab)
QueuequeueEU Frankfurt GCPhttps://queue.europe-west3.gcp.keboola.com (opens in a new tab)
SchedulerschedulerUS Virginia AWShttps://scheduler.keboola.com (opens in a new tab)
SchedulerschedulerUS Virginia GCPhttps://scheduler.us-east4.gcp.keboola.com (opens in a new tab)
SchedulerschedulerEU Frankfurt AWShttps://scheduler.eu-central-1.keboola.com (opens in a new tab)
SchedulerschedulerEU Ireland Azurehttps://scheduler.north-europe.azure.keboola.com (opens in a new tab)
SchedulerschedulerEU Frankfurt GCPhttps://scheduler.europe-west3.gcp.keboola.com (opens in a new tab)
StorageUS Virginia AWShttps://connection.keboola.com/ (opens in a new tab)
StorageUS Virginia GCPhttps://connection.us-east4.gcp.keboola.com (opens in a new tab)
StorageEU Frankfurt AWShttps://connection.eu-central-1.keboola.com/ (opens in a new tab)
StorageEU Ireland Azurehttps://connection.north-europe.azure.keboola.com/ (opens in a new tab)
StorageEU Frankfurt GCPhttps://connection.europe-west3.gcp.keboola.com/ (opens in a new tab)
StreamstreamUS Virginia AWShttps://stream.keboola.com (opens in a new tab)
StreamstreamUS Virginia GCPhttps://stream.us-east4.gcp.keboola.com (opens in a new tab)
StreamstreamEU Frankfurt AWShttps://stream.eu-central-1.keboola.com (opens in a new tab)
StreamstreamEU Ireland Azurehttps://stream.north-europe.azure.keboola.com (opens in a new tab)
StreamstreamEU Frankfurt GCPhttps://stream.europe-west3.gcp.keboola.com (opens in a new tab)
Sync Actionssync-actionsUS Virginia AWShttps://sync-actions.keboola.com/ (opens in a new tab)
Sync Actionssync-actionsUS Virginia GCPhttps://sync-actions.us-east4.gcp.keboola.com (opens in a new tab)
Sync Actionssync-actionsEU Frankfurt AWShttps://sync-actions.eu-central-1.keboola.com (opens in a new tab)
Sync Actionssync-actionsEU Ireland Azurehttps://sync-actions.north-europe.azure.keboola.com (opens in a new tab)
Sync Actionssync-actionsEU Frankfurt GCPhttps://sync-actions.europe-west3.gcp.keboola.com (opens in a new tab)
VaultvaultUS Virginia AWShttps://vault.keboola.com (opens in a new tab)
VaultvaultUS Virginia GCPhttps://vault.us-east4.gcp.keboola.com (opens in a new tab)
VaultvaultEU Frankfurt AWShttps://vault.eu-central-1.keboola.com (opens in a new tab)
VaultvaultEU Ireland Azurehttps://vault.north-europe.azure.keboola.com (opens in a new tab)
VaultvaultEU Frankfurt GCPhttps://vault.europe-west3.gcp.keboola.com (opens in a new tab)

There are several ways to send requests to our APIs:

Send requests to our API directly from the Apiary console by clicking on Switch to console or Try. Fill in the request headers and parameters, then click Call Resource.

Apiary console

The Apiary console is fine if you send API requests only occasionally. It requires no application installation; however, it has no history and no other useful features.

Postman (opens in a new tab) is a generic HTTP API client, suitable for more regular API work. We also provide a collection of useful API calls (opens in a new tab) with examples. The collection contains code examples in various languages; the requests can also be imported into the Postman application.

Postman Docs

cURL (opens in a new tab) is a common library with a command-line interface (CLI) (opens in a new tab). You can use the cURL CLI to create simple scripts for interacting with Keboola APIs. For example, to run a job:

Terminal window
curl --location --request POST 'https://queue.keboola.com/jobs' \
--header 'X-StorageApi-Token: YourStorageToken' \
--header 'Content-Type: application/json' \
--data-raw '{
"mode": "run",
"component": "keboola.ex-db-mysql",
"config": "sampledatabase"
}'
Ask Kai

Hi, I'm Kai — Keboola's AI assistant for the docs. Ask me anything and I'll answer from the documentation and cite the pages I use.

Kai is an AI and can make mistakes. Check the sources it links.