ImageKit Python API Docs | dltHub
Build a ImageKit-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
ImageKit is a media CDN and Digital Asset Management platform that provides REST APIs for file management and media transformations. The REST API base URL is https://api.imagekit.io and all requests require HTTP Basic authentication with a private API key.
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 add "dlt[hub]" and start loading ImageKit data in under 10 minutes.
What data can I load from ImageKit?
Here are some of the endpoints you can load from ImageKit:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| files | /v1/files | GET | List and search assets (files and folders). | |
| url_endpoints | /v1/accounts/url-endpoints | GET | List all URL endpoints configured for the account. | |
| custom_metadata_fields | /v1/customMetadataFields | GET | List custom metadata fields. | |
| cache_purge_status | /v1/purges/ | GET | Get the status of a cache purge request. | |
| file_metadata | /v1/files//details | GET | Get details/metadata for a specific file. |
How do I authenticate with the ImageKit API?
Authentication is performed via HTTP Basic Auth. Provide your private API key as the username, followed by a colon, leaving the password field empty.
1. Get your credentials
- Log in to your ImageKit.io dashboard. 2. In the left-hand navigation menu, click on Developers. 3. Select API Options to view your Public Key, Private Key, and URL Endpoint. 4. If your keys are masked, click the reveal icon next to the key and enter your account password to authorize the display.
2. Add them to .dlt/secrets.toml
[sources.imagekit_source] private_api_key = "your_private_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:
uv init uv add "dlt[hub]"
1. Install the dlt AI harness:
uv run dlthub 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:
uv run dlthub ai toolkit install rest-api-pipeline
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 ImageKit 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:
uv run python imagekit_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline imagekit_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset imagekit_data The duckdb destination used duckdb:/imagekit.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
uv run dlthub 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 v1/files and v1/files/show from the ImageKit 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 imagekit_source(private_api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.imagekit.io", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": private_api_key}, }, "resources": [ {"name": "files", "endpoint": {"path": "v1/files"}}, {"name": "url_endpoints", "endpoint": {"path": "v1/accounts/url-endpoints"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="imagekit_pipeline", destination="duckdb", dataset_name="imagekit_data", ) load_info = pipeline.run(imagekit_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("imagekit_pipeline").dataset() sessions_df = data.files.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM imagekit_data.files LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("imagekit_pipeline").dataset() data.files.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 ImageKit data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 harness:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-platform— Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform
Was this page helpful?
Community Hub
Need more dlt context for ImageKit?
Request dlt skills, commands, AGENT.md files, and AI-native context.