API Reference

Use the Supaflow API to automate pipeline runs from outside the app - an orchestrator such as Airflow or Azure Data Factory, a CI job, or a plain cron entry. Calls are made over HTTPS and authenticated with an API key, so any tool that can make an HTTP request can drive Supaflow.

Enable access before calling the API

Enable API-key access before you begin

An organization administrator or personal-account owner must select the intended account in Supaflow, open Settings > API Keys > Permissions, check Enable API access and Allow API keys, then click Save changes and Save access settings after reviewing. Return to Keys to create a key. Existing keys also require these permissions; administrator status alone does not bypass them.

See API access settings for the setup steps, OAuth alternatives and token-expiry limits.

Authentication

Authentication is a two-step exchange:

1. Exchange your API key for a short-lived access token. Send your ak_... key to the bootstrap endpoint. It returns a token (valid one hour), plus the API host and public key for your account's region.

   curl -sS -X POST https://app.supa-flow.io/api/cli/bootstrap \
     -H "Authorization: Bearer ak_XXXXXXXXXXXXXXXXXXXX"

2. Call operations with that token. Pass the returned token as a Bearer token and the returned supabase_anon_key as an apikey header, against the returned supabase_url host.

Exchanging the key per region means the same script works across US, EU, and other regions without hardcoding hosts. Create and manage keys in Settings -> API Keys.

Operations

Operation	Description
Trigger a pipeline run	Start a pipeline sync, get a job ID back, and poll the job to completion.

More operations will be documented here over time. In the meantime, the Supaflow CLI covers the full surface area (datasources, pipelines, schedules, and jobs) and uses the same authentication model under the hood.

Related pages

• Trigger a pipeline run via the API - the most common automation use case
• API Keys - create and manage API keys
• CLI - the supaflow command-line tool

Support

Questions about the Supaflow API? Contact us at support@supa-flow.io.