DataXPipe
← Back to app

Integrations

API reference

REST endpoints for catalog, runs, checks, imports, and AI assistance.

Base URL

Catalog API: https://api.dataxpipe.com

Versioned routes: /api/v1/. Interactive OpenAPI docs: /docs on the same host.

Authentication

Send your organization API key as the X-API-KEY header on protected routes.

Find your key under Settings in the app after signup.

curl https://api.dataxpipe.com/api/v1/organizations/me \
  -H "X-API-KEY: dxp_your_key_here"

Organizations

  • POST /api/v1/organizations/register — create org, returns api_key (no auth)
  • GET /api/v1/organizations/me — current org + plan limits (auth)

Pipelines & specs

  • GET /api/v1/pipelines/ — list pipelines
  • POST /api/v1/pipelines/ — register catalog JSON
  • GET /api/v1/pipelines/{id} — fetch pipeline metadata
  • POST /api/v1/specs/validate — validate YAML (no auth)
  • POST /api/v1/specs/register — validate + register YAML (auth)

Runs

Orchestrators POST run lifecycle events here.

  • POST /api/v1/runs/ — create run (pipeline_id required)
  • GET /api/v1/runs/{run_id} — run detail + linked checks
  • GET /api/v1/runs/pipeline/{pipeline_id} — list runs

Checks & connections

  • POST /api/v1/checks/execute — run SQL against a registered connection
  • POST /api/v1/checks/ — store a check result
  • GET /api/v1/checks/{check_result_id} — fetch check result
  • POST /api/v1/connections/ — register warehouse connection
  • GET /api/v1/connections/{id} — fetch connection

Lineage

  • GET /api/v1/lineage/{dataset_id} — upstream/downstream edges

Import

  • GET /api/v1/import/demo/stale-table — demo catalog (no auth)
  • POST /api/v1/import/dbt-manifest — dbt manifest.json
  • POST /api/v1/import/airflow-dag — Airflow DAG source
  • POST /api/v1/import/discover/postgres — Postgres table discovery

AI assistance

  • POST /api/v1/ai/explain-failure — explain a failed check
  • POST /api/v1/ai/suggest-spec — suggest YAML from catalog (auth)

Interactive docs

← All documentation