HARPA AI Python API Docs | dltHub

HARPA AI is a browser-orchestration and web-automation platform exposing a Grid REST API to run scraping, search (SERP), AI command and prompt actions on connected browser Nodes. The REST API base URL is https://api.harpa.ai/api/v1/grid and all requests require a Bearer token in the Authorization header.

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 pip install "dlt[workspace]" and start loading HARPA AI data in under 10 minutes.

---

What data can I load from HARPA AI?

Here are some of the endpoints you can load from HARPA AI:

---

How do I authenticate with the HARPA AI API?

Authentication is via an API key that must be provided in the Authorization header as a Bearer token: Authorization: Bearer $HARPA_API_KEY

1. Get your credentials

1. Install or open the HARPA AI Chrome extension (get.harpa.ai).
2. Open the extension and go to the AUTOMATE tab.
3. Copy the API key shown there (HARPA API Key).
4. Use that key as a Bearer token in the Authorization header for API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.harpa_ai_source]
api_key = "your_harpa_api_key_here"

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:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt 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:

Copy
dlt ai toolkit rest-api-pipeline install

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 HARPA AI 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:

Copy
python harpa_ai_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline harpa_ai_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset harpa_ai_data
The duckdb destination used duckdb:/harpa_ai.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline harpa_ai_pipeline 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 scrape and serp from the HARPA AI API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def harpa_ai_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.harpa.ai/api/v1/grid",
            "auth": {
                "type": "bearer",
                "token": api_key,
            },
        },
        "resources": [
            {"name": "scrape", "endpoint": {"path": "api/v1/grid"}},
            {"name": "serp", "endpoint": {"path": "api/v1/grid"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="harpa_ai_pipeline",
        destination="duckdb",
        dataset_name="harpa_ai_data",
    )
    load_info = pipeline.run(harpa_ai_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):

Copy
import dlt

data = dlt.pipeline("harpa_ai_pipeline").dataset()
sessions_df = data.scrape.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM harpa_ai_data.scrape LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("harpa_ai_pipeline").dataset()
data.scrape.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 HARPA AI data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If requests return 401/403, verify the Authorization header is present and the API key is correct. Ensure the key copied from the HARPA AI Chrome extension AUTOMATE tab is active. Use: Authorization: Bearer <YOUR_API_KEY>.

Timeouts and long-running tasks

Synchronous actions have a default/max timeout of 300000 ms (5 minutes). For long-running tasks or unreliable Nodes, use resultsWebhook to receive asynchronous results; HARPA GRID will keep the action for up to 30 days and deliver results when Nodes become available.

Response shape and data selection

Synchronous responses are returned as a single array of result objects (top-level array). For scrape actions that use grab with "all", individual result fields may themselves be arrays. When using command actions, specify resultParam to target a particular field (dot notation supported, e.g., "g.data.email").

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack