No logo available for Imagine API to DuckDB connector icon

Load Imagine API data to DuckDB

Build a Imagine API to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Imagine API API base URL, auth, endpoints, and incremental loading.

SourceImagine APIImagine API API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

ImagineAPI is a REST API that enables users to programmatically generate and retrieve Midjourney images. Everything needed to build a working Imagine API → 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 Imagine API to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from Imagine API 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 Imagine API 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.


Imagine API API at a glance

Base URLhttps://cl.imagineapi.dev
Example endpointGET items/images
Records found atdata
Authenticationall requests require a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer
PaginationNot paginated
Incremental fieldid
Record idid
API reference[https://api-ml.imagine.art/ or https://developers.imagine.io/](https://api-ml.imagine.art/ or https://developers.imagine.io/)

These values come from the [Imagine API API reference](https://api-ml.imagine.art/ or https://developers.imagine.io/) — the authoritative source if anything here looks out of date.


How do I authenticate with the Imagine API API?

Requests require an 'Authorization' header with the value 'Bearer '.

1. Get your credentials

  1. Log in to your account at https://cl.imagineapi.dev. 2. Click on your user avatar in the bottom-left corner. 3. Navigate to 'Admin Options' and select 'Token'. 4. Click the '+' button to generate a new token or copy an existing one. 5. Use this token in the 'Authorization: Bearer <your_token>' header for all API requests.

2. Add them to .dlt/secrets.toml

[sources.imagine_api_source] api_key = "your_token_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 Imagine API data can I load into DuckDB?

These are the Imagine API endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
images/items/imagesGETdataRetrieve list of Midjourney image generation records
images_by_id/items/images/:idGETdataRetrieve a single image generation record
images_create/items/imagesPOSTdataCreate a new Midjourney image generation
status/items/statusGETdataCheck ImagineAPI service or bot health
asset_file/assets/{asset_id}/{file}GETDirect HTTP GET for returned image asset URLs

How do I load only new Imagine API records?

Imagine API exposes id on items/images, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

{"name": "images", "endpoint": { "path": "items/images", "data_selector": "data", "incremental": {"cursor_path": "id", "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 Imagine API pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading items/images and items/images/:id from the Imagine API API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def imagine_api_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://cl.imagineapi.dev", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "images", "endpoint": {"path": "items/images", "data_selector": "data"}}, {"name": "status", "endpoint": {"path": "items/status", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_imagine_api_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="imagine_api_pipeline", destination="duckdb", dataset_name="imagine_api_data", ) load_info = pipeline.run(imagine_api_source()) print(load_info) if __name__ == "__main__": load_imagine_api_to_duckdb()

Run it with python imagine_api_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 Imagine API 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("imagine_api_pipeline").dataset() df = data.images.df() print(df.head())

SQL:

SELECT * FROM imagine_api_data.images LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the Imagine API 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 Imagine API loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load Imagine API data to?

dlt loads into any of these — only the destination argument changes:

DestinationExample 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 Imagine API to DuckDB?

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