Segmind Python API Docs | dltHub

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

Last updated:

Segmind is a developer platform providing hosted machine learning model APIs for inference and model‑serving. The REST API base URL is https://api.segmind.com/v1 and All requests require an x-api-key header for authentication..

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


What data can I load from Segmind?

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

ResourceEndpointMethodData selectorDescription
fast_flux_schnell/v1/fast-flux-schnellPOSTImage binary or JSON response for image generation
face_to_sticker/v1/face-to-stickerPOSTImage/sticker generation endpoint
instantid/v1/instantidPOSTID/face related generation endpoint
sdxl_newreality/v1/sdxl1.0-newreality-lightningPOSTSDXL image generation endpoint
consistent_character_neolemon_v2/v1/consistent-character-AI-neolemon-v2POSTConsistent Character model inference endpoint (image generation)
models_page/v1/models/GETHuman‑readable model metadata page (HTML)

How do I authenticate with the Segmind API?

Segmind uses an API key passed in the HTTP header named x-api-key. Include Content-Type: application/json for JSON requests; image‑generation endpoints may return binary (image/*) responses.

1. Get your credentials

  1. Sign in to https://www.segmind.com and open your account/dashboard.
  2. Navigate to the "API keys" or "Create an API key" section in the developer/docs area.
  3. Create a new key, copy the key value and store it securely.
  4. Use the key as the value of the x-api-key header in requests.

2. Add them to .dlt/secrets.toml

[sources.segmind_consistent_character_ai_source] api_key = "YOUR_SEGMIND_API_KEY"

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 Segmind 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 segmind_consistent_character_ai_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline segmind_consistent_character_ai_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 consistent_character_neolemon_v2 and fast_flux_schnell from the Segmind 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 segmind_consistent_character_ai_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.segmind.com/v1", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "consistent_character_neolemon_v2", "endpoint": {"path": "consistent-character-AI-neolemon-v2"}}, {"name": "fast_flux_schnell", "endpoint": {"path": "fast-flux-schnell"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="segmind_consistent_character_ai_pipeline", destination="duckdb", dataset_name="segmind_consistent_character_ai_data", ) load_info = pipeline.run(segmind_consistent_character_ai_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("segmind_consistent_character_ai_pipeline").dataset() sessions_df = data.consistent_character_neolemon_v2.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM segmind_consistent_character_ai_data.consistent_character_neolemon_v2 LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("segmind_consistent_character_ai_pipeline").dataset() data.consistent_character_neolemon_v2.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 Segmind 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.


Troubleshooting

Authentication failures

If you receive HTTP 401 Unauthorized, verify you set the x-api-key header with a valid API key. Ensure there are no extra quotes or whitespace around the key.

Rate limits and credits

Responses with HTTP 406 indicate insufficient credits. The docs also list 405 Method Not Allowed, 404 Not Found and 500 Server Error; handle these by retry/backoff and ensure correct endpoint/method.

Binary/image responses and content-type

Image-generation endpoints commonly return image/* (e.g., image/jpeg) or binary content. When expecting images set response handling to binary (stream) rather than JSON.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


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 Segmind?

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