Bolt API

Use the Bolt API to run, monitor, and manage Bolt schedules from outside Paradime. This lets you fold dbt™ runs into a pipeline orchestrated by tools such as Airflow, Dagster, Prefect, or Azure Data Factory (ADF), or trigger them from any system that can call an API.

Ways to call the API

You can interact with the Bolt API using any of these:

Requirements

Bolt API calls authenticate with a Paradime API key that has the Bolt schedules admin capability. Paradime supports two key types:

Account API keys (recommended) — a Bearer token that can access multiple workspaces.
Workspace API keys (legacy) — an API Key and API Secret scoped to a single workspace.

See API keys to generate one, and Authentication for how to pass credentials and the API endpoint.

Trigger a schedule from an external system

To drive a schedule entirely from the API (for example, from Airflow, Dagster, or Prefect), give it the Off trigger so it only runs when you call it. The schedule can be built either way:

In the UI — create or edit the schedule and select the Off trigger type.
As code — set schedule: "OFF" in the schedule’s YAML.

paradime_schedules.yml (as-code option)

schedules:
  - name: operations_run
    slug: operations-run-b3c4d5
    schedule: "OFF"
    environment: production
    commands:
      - dbt seed
      - dbt run -m +fact_orders
    owner_email: "fabio@paradime.io"

Then call the Bolt API from your orchestrator to trigger the run and poll its status.

What you can do

Beyond triggering, the Bolt API can check run status, retry a failed run, cancel a running one, and suspend a schedule. For the full endpoint list, see the Bolt GraphQL API reference, Python SDK, and CLI.

Schedule Anatomy

Deploy Schedules

Managing Schedules

CI/CD

Ways to call the API

Requirements

Trigger a schedule from an external system

What you can do

​Ways to call the API

​Requirements

​Trigger a schedule from an external system

​What you can do

Ways to call the API

Requirements

Trigger a schedule from an external system

What you can do