Instabase Python API Docs | dltHub

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

Last updated:

Instabase's chatbot API allows integration into workflows, sending queries and tracking status. Conversations and chatbots are deprecated as of February 1, 2026. Use the API with your organization ID in the IB-Context header. The REST API base URL is https://aihub.instabase.com/api and All requests require a Bearer API token and typically the IB-Context header to select user/org context..

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


What data can I load from Instabase?

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

ResourceEndpointMethodData selectorDescription
conversations/v2/conversationsGETconversationsList all conversations (response JSON contains 'conversations' array).
conversation/v2/conversations/:conversation_idGETdocumentsGet conversation info; documents list under 'documents'.
conversation_document/v2/conversations/:conversation_id/documents/:document_idGET(object)Retrieve metadata for a single document (response is an object with keys like 'id','name','metadata').
batches/v2/batchesGETbatchesList batches (response JSON contains 'batches' array).
files_metadata/v2/files/:pathHEAD(object)Read metadata for a file or folder at path (returns object; documented sample shows empty object for HEAD/200).
runs_results/v2/apps/runs/:run_id/resultsGET(object/array per run schema)Get run results for a deployment run (GET endpoint in Runs API).
queries_status/v2/queries/:query_idGET(object)Get query status/result for an async query (queries are created via POST /v2/queries).
audit_logs/v1/auditlogsPOSTdata.resultsAudit logs response contains 'status' and 'data.results' array of entries (note: this operation is POST but returns a results list).

How do I authenticate with the Instabase API?

Use a Bearer token in the Authorization header (Authorization: Bearer <API_TOKEN>). Include IB-Context header with your user ID or organization ID to select request context; for community accounts IB-Context may be omitted.

1. Get your credentials

  1. Sign in to Instabase AI Hub. 2) Open APIs / Settings (APIs page). 3) Create or copy an API token (AI Hub‑managed) or obtain an externally managed token if your org uses OAuth providers. 4) Note your organization ID (for IB-Context) from account or admin settings.

2. Add them to .dlt/secrets.toml

[sources.instabase_chatbot_api_source] api_key = "your_api_token_here" ib_context = "your_user_or_organization_id_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 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 Instabase 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 instabase_chatbot_api_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline instabase_chatbot_api_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 conversations and conversation from the Instabase 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 instabase_chatbot_api_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://aihub.instabase.com/api", "auth": { "type": "bearer", "api_key": api_key, }, }, "resources": [ {"name": "conversations", "endpoint": {"path": "v2/conversations", "data_selector": "conversations"}}, {"name": "conversation", "endpoint": {"path": "v2/conversations/:conversation_id", "data_selector": "documents"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="instabase_chatbot_api_pipeline", destination="duckdb", dataset_name="instabase_chatbot_api_data", ) load_info = pipeline.run(instabase_chatbot_api_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("instabase_chatbot_api_pipeline").dataset() sessions_df = data.conversations.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM instabase_chatbot_api_data.conversations LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("instabase_chatbot_api_pipeline").dataset() data.conversations.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 Instabase 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 Instabase?

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