Crawl4AI Python API Docs | dltHub

Build a Crawl4AI-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Crawl4AI is an open-source web crawler and scraper for large language models. It uses adaptive crawling and supports asynchronous operations. It includes URL seeding and custom hook integration. The REST API base URL is http://localhost:11235 and No authentication required..

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 Crawl4AI data in under 10 minutes.


What data can I load from Crawl4AI?

Here are some of the endpoints you can load from Crawl4AI:

ResourceEndpointMethodData selectorDescription
hooks_info/hooks/infoGET
job_status/job/{task_id}GETresultCheck the status and retrieve results of a submitted job.
health/healthGETSimple uptime monitoring.
metrics/metricsGETPrometheus metrics.
schema/schemaGETFull API schema.
html/htmlPOST
screenshot/screenshotPOST
pdf/pdfPOST
execute_js/execute_jsPOST
crawl_job/crawl/jobPOST
llm_job/llm/jobPOST

How do I authenticate with the Crawl4AI API?

No authentication information is provided in the documentation, suggesting that no specific authentication mechanism or headers are required.

1. Get your credentials

No information on obtaining API credentials is provided in the available documentation.

2. Add them to .dlt/secrets.toml

[sources.crawl4ai_source] No authentication required, so no `secrets.toml` example for credentials.

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 venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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:

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 Crawl4AI 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:

python crawl4ai_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline crawl4ai_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 crawl_job and job_status from the Crawl4AI 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 crawl4ai_source(None=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "http://localhost:11235", "auth": { "type": "None", "None": None, }, }, "resources": [ {"name": "crawl_job", "endpoint": {"path": "crawl/job"}}, {"name": "job_status", "endpoint": {"path": "job/{task_id}", "data_selector": "result"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="crawl4ai_pipeline", destination="duckdb", dataset_name="crawl4ai_data", ) load_info = pipeline.run(crawl4ai_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("crawl4ai_pipeline").dataset() sessions_df = data.crawl_job.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM crawl4ai_data.crawl_job LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("crawl4ai_pipeline").dataset() data.crawl_job.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 Crawl4AI data to?

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

DestinationExample 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 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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Crawl4AI?

Request dlt skills, commands, AGENT.md files, and AI-native context.