Pathfix Python API Docs | dltHub
Build a Pathfix-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
Pathfix is an OAuth connectivity platform that allows applications to integrate with various service providers without managing token infrastructure. The REST API base URL is https://labs.pathfix.com/api and requests are authenticated using public and private keys passed as query string parameters.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Pathfix data in under 10 minutes.
What data can I load from Pathfix?
Here are some of the endpoints you can load from Pathfix:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| connection | /api/connection | GET | Retrieves a list of user connections | |
| user_data | /api/connection/{provider}/userdata | GET | Retrieves user data for a specific provider | |
| oauth_call | /oauth/method/{provider}/call | POST | rows.data | Executes a pass-through API call to a provider |
| core_api | /functions/type/function | POST | Executes core automation API functions | |
| provider_reference | /provider-reference | GET | Retrieves the list of supported OAuth providers |
How do I authenticate with the Pathfix API?
Authentication is performed by including your Pathfix application's 'public_key' and (optionally) 'private_key' as query string parameters in your requests.
1. Get your credentials
- Log in to your Pathfix developer account at https://pathfix.com. 2. Navigate to the dashboard or settings area. 3. Locate and click on the 'Keys' section in the left navigation bar. 4. From this screen, you can copy your 'Public Key' and 'Private Key'. Note: Keep your Private Key secure and only use it for server-to-server calls or when additional security is required. Do not expose the Private Key in client-side/JavaScript code.
2. Add them to .dlt/secrets.toml
[sources.pathfix_source] public_key = "REPLACE_ME"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv init uv add "dlt[hub]"
1. Install the dlt AI harness:
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
uv run dlthub ai toolkit install rest-api-pipeline
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Pathfix API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
uv run python pathfix_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline pathfix_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset pathfix_data The duckdb destination used duckdb:/pathfix.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
uv run dlthub show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads https://labs.pathfix.com/api (for managing connections) and https://labs.pathfix.com/oauth/method/{providername}/call (for pass-through API calls to service providers). from the Pathfix API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def pathfix_source(public_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://labs.pathfix.com/api", "auth": {"type": "api_key", "api_key": public_key, "name": "Accept", "location": "header"}, }, "resources": [ {"name": "connection", "endpoint": {"path": "api/connection"}}, {"name": "user_data", "endpoint": {"path": "api/connection/{provider}/userdata"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="pathfix_pipeline", destination="duckdb", dataset_name="pathfix_data", ) load_info = pipeline.run(pathfix_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("pathfix_pipeline").dataset() sessions_df = data.connection.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM pathfix_data.connection LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("pathfix_pipeline").dataset() data.connection.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Pathfix data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI harness:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-platform— Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform
Was this page helpful?
Community Hub
Need more dlt context for Pathfix?
Request dlt skills, commands, AGENT.md files, and AI-native context.