Load Readable data to DuckDB
Build a Readable to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Readable API base URL, auth, endpoints, and incremental loading.
Readable is a text analysis service that evaluates readability, profanity, and content metrics for text and URLs. Everything needed to build a working Readable → 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 Readable to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Readable 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 Readable 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.
Readable API at a glance
| Base URL | https://api.readable.com/api |
| Example endpoint | POST text/ |
| Authentication | All requests require two custom HTTP headers for request signing — sent in the Authorization header, prefixed Bearer |
| Pagination | Cursor-based via cursor_param, page size via limit. For cursor pagination, you must provide either cursor_param or cursor_body_path, but not both. If neither is provided, cursor_param defaults to 'cursor'. In dlt, paginator configuration allows specifying the type (e.g., 'cursor', 'offset', 'page_number') and parameters. |
| API reference | https://dlthub.com/docs/dlt-ecosystem/verified-sources/rest_api/basic |
These values come from the Readable API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Readable API?
Authentication is performed by including two HTTP headers: 'API_REQUEST_TIME' (the current UTC Unix timestamp) and 'API_SIGNATURE' (an MD5 hash of the API key concatenated with the timestamp). Requests are rejected if the timestamp is more than 30 seconds old or if the signature is invalid.
1. Get your credentials
- Log in to your account dashboard at app.readable.io. 2. Navigate to the account administration area (often labeled as API Settings or Integrations). 3. Locate the API key section to generate a new key or copy an existing one. Store this key securely, as it is used to compute the mandatory API_SIGNATURE header.
2. Add them to .dlt/secrets.toml
[sources.readable_source] api_key = "YOUR_READABLE_API_KEY"
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 Readable data can I load into DuckDB?
These are the Readable endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| text | /text/ | POST | Analyze raw text for readability and other metrics. | |
| url | /url/ | POST | Analyze the content of a URL. | |
| highlight | /highlight/ | POST | Return highlighted portions of the analyzed text. | |
| profanity | /profanity/ | POST | Detect profane words in the submitted text. | |
| metadata | /metadata/ | POST | Retrieve metadata about the submitted content. |
How do I load only new Readable records?
The Readable 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": "text", "endpoint": { "path": "text/", # 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 Readable pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading text and url from the Readable API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def readable_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.readable.com/api", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "text", "endpoint": {"path": "text/"}}, {"name": "url", "endpoint": {"path": "url/"}} ], } yield from rest_api_resources(config) def load_readable_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="readable_pipeline", destination="duckdb", dataset_name="readable_data", ) load_info = pipeline.run(readable_source()) print(load_info) if __name__ == "__main__": load_readable_to_duckdb()
Run it with python readable_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 Readable 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("readable_pipeline").dataset() df = data.text.df() print(df.head())
SQL:
SELECT * FROM readable_data.text LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Readable 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 Readable 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 Readable 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 Readable to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.