Load Algolia data to DuckDB
Build a Algolia to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Algolia API base URL, auth, endpoints, and incremental loading.
Algolia is a search-as-a-service platform providing various APIs to index, search, and manage data. Everything needed to build a working Algolia → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.
Build your Algolia to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Algolia to DuckDB and run it on dltHub
That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Algolia API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →
Prefer to write it yourself? Every fact the agent uses is below.
Algolia API at a glance
| Base URL | https://{APPLICATION_ID}.algolia.net |
| Example endpoint | POST 1/indexes/{indexName}/query |
| Records found at | hits |
| Authentication | all requests require x-algolia-application-id and x-algolia-api-key headers — sent in the request header |
| Also required | x-algolia-application-id, x-algolia-api-key |
| Pagination | Cursor-based via cursor, next cursor at cursor, page size via hitsPerPage (default 20, max 1000). For search/browse cursor-based pagination, send the cursor parameter value exactly as returned in a previous response. The last page does not return a cursor attribute. For Search single index, hitsPerPage controls results per page (required range 1..1000) and page is zero-based. For browse, hitsPerPage/page parameters are ignored when using browse; use cursor to paginate via the browse endpoint. |
| API reference | https://www.algolia.com/doc/rest-api/search |
These values come from the Algolia API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Algolia API?
Algolia uses header-based authentication, requiring both 'x-algolia-application-id' and 'x-algolia-api-key' headers in every request.
1. Get your credentials
To obtain your API credentials, log in to your Algolia dashboard. Navigate to the API Keys section (found in the settings menu). There, you will find your Application ID and existing API keys, such as the Admin API key, which has full administrative access, and Search-only keys. You can view, edit, or create new API keys with specific permissions (Access Control Lists) based on your integration requirements.
2. Add them to .dlt/secrets.toml
[sources.algolia_source] algolia_application_id = "your_application_id_here" algolia_api_key = "your_admin_or_search_api_key_here"
dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.
What Algolia data can I load into DuckDB?
These are the Algolia endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| search | /1/indexes/{indexName}/query | POST | hits | Searches an index using query string. |
| search_multiple | /1/indexes/*/queries | POST | results | Searches across multiple indices. |
| browse | /1/indexes/{indexName}/browse | POST | hits | Retrieves all records in an index. |
| get_objects | /1/indexes/*/objects | POST | results | Retrieves specific objects by ID. |
| get_object | /1/indexes/{indexName}/{objectID} | GET | Retrieves a single object by ID. |
How do I load only new Algolia records?
The Algolia API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.
{"name": "search", "endpoint": { "path": "1/indexes/{indexName}/query", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}
On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.
What does the generated Algolia pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading /indexes/{indexName}/query and /indexes/{indexName}/browse from the Algolia API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def algolia_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{APPLICATION_ID}.algolia.net", "auth": {"type": "api_key", "api_key": api_key, "name": "x-algolia-api-key", "location": "header"}, }, "resources": [ {"name": "search", "endpoint": {"path": "1/indexes/{indexName}/query", "data_selector": "hits"}}, {"name": "browse", "endpoint": {"path": "1/indexes/{indexName}/browse", "data_selector": "hits"}} ], } yield from rest_api_resources(config) def load_algolia_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="algolia_pipeline", destination="duckdb", dataset_name="algolia_data", ) load_info = pipeline.run(algolia_source()) print(load_info) if __name__ == "__main__": load_algolia_to_duckdb()
Run it with python algolia_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.
How do I query Algolia data in DuckDB?
dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("algolia_pipeline").dataset() df = data.search.df() print(df.head())
SQL:
SELECT * FROM algolia_data.search LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Algolia to DuckDB pipeline in production?
The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.
- Deploy & schedule — run the pipeline as a managed job with automatic retries.
- Monitor — observable job queues, alerting, and load metrics for every run.
- Transform — promote raw Algolia loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load Algolia data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example value |
|---|---|
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.
Next steps
Was this page helpful?
Community Hub
Need more dlt context for Algolia to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.