Load Knack data to DuckDB
Build a Knack to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Knack API base URL, auth, endpoints, and incremental loading.
Knack is a resource-oriented REST API for managing records in Knack applications through object or view-based requests. Everything needed to build a working Knack → 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 Knack to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Knack 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 Knack 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.
Knack API at a glance
| Base URL | https://api.knack.com/v1 |
| Example endpoint | GET v1/objects/{object_key}/records |
| Records found at | records |
| Authentication | Requests are authenticated via HTTP headers including Application ID and either an API Key or 'knack' for view-based requests — sent in the Authorization header |
| Also required | X-Knack-Application-Id, X-Knack-REST-API-KEY, Content-Type |
| Pagination | Page-number page size via rows_per_page (default 25, max 1000) |
| API reference | https://docs.knack.com/v3/reference/introduction-to-the-api |
These values come from the Knack API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Knack API?
Authentication is handled via HTTP headers. Object-based requests require X-Knack-Application-Id and X-Knack-REST-API-KEY headers, while view-based requests use X-Knack-Application-Id, a literal 'knack' for the X-Knack-REST-API-KEY header, and an optional Authorization header for user tokens.
1. Get your credentials
- Open the Knack Builder from your main Dashboard. 2. Select 'Settings' from the left-hand navigation menu. 3. Navigate to the 'API & Code' section. 4. Locate your 'Application ID' and 'API Key' listed under the API section.
2. Add them to .dlt/secrets.toml
[sources.knack_source] knack_application_id = "your_application_id_here" knack_api_key = "your_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 Knack data can I load into DuckDB?
These are the Knack endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| object_records | v1/objects/{object_key}/records | GET | records | Retrieve all records for a specific object. |
| object_record | v1/objects/{object_key}/records/{record_id} | GET | Retrieve a specific record by ID. | |
| view_records | v1/pages/{scene_key}/views/{view_key}/records | GET | records | Retrieve records based on a view. |
| object_create | v1/objects/{object_key}/records | POST | Create a new record in an object. | |
| object_update | v1/objects/{object_key}/records/{record_id} | PUT | Update an existing record in an object. | |
| object_delete | v1/objects/{object_key}/records/{record_id} | DELETE | Delete an existing record in an object. |
How do I load only new Knack records?
The Knack 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": "object_records", "endpoint": { "path": "v1/objects/{object_key}/records", # 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 Knack pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading /objects and /pages from the Knack API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def knack_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.knack.com/v1", "auth": {"type": "api_key", "api_key": api_key, "name": "Authorization", "location": "header"}, }, "resources": [ {"name": "object_records", "endpoint": {"path": "v1/objects/{object_key}/records", "data_selector": "records"}}, {"name": "view_records", "endpoint": {"path": "v1/pages/{scene_key}/views/{view_key}/records", "data_selector": "records"}} ], } yield from rest_api_resources(config) def load_knack_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="knack_pipeline", destination="duckdb", dataset_name="knack_data", ) load_info = pipeline.run(knack_source()) print(load_info) if __name__ == "__main__": load_knack_to_duckdb()
Run it with python knack_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 Knack 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("knack_pipeline").dataset() df = data.object_records.df() print(df.head())
SQL:
SELECT * FROM knack_data.object_records LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Knack 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 Knack 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 Knack 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 Knack to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.