UI Bakery Firebase Python API Docs | dltHub
Build a UI Bakery Firebase-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
UI Bakery provides native integration connectors for Firebase services including Firestore, Firebase Auth, and Realtime Database using service account credentials. The REST API base URL is https://your_project.firebaseio.com/ and Firebase services are authenticated using a service account private 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 UI Bakery Firebase data in under 10 minutes.
What data can I load from UI Bakery Firebase?
Here are some of the endpoints you can load from UI Bakery Firebase:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| apps | /api/instance/app/{app_id}/pull | POST | Pull latest commits for specified app/branch | |
| apps | /api/instance/app/{app_id}/release | POST | Release the app to specified environments | |
| instance_status | /api/instance/status | GET | Retrieve instance operational status | |
| instance_config | /api/instance/config | GET | Retrieve instance configuration details | |
| app_list | /api/instance/apps | GET | List all applications on the instance |
How do I authenticate with the UI Bakery Firebase API?
Authentication to Firebase services in UI Bakery is handled by providing a private key (generated from the Firebase Admin SDK) and, for Realtime DB, the database URL. This configuration is done via UI Bakery's native Firebase data source connector, not a generic REST API endpoint.
1. Get your credentials
To obtain the necessary credentials for Firebase integration, navigate to the Firebase console and select your project. For service account-based authentication (commonly used for Firestore and Realtime DB access), go to Project settings > Service accounts, select Firebase Admin SDK, and click Generate new private key to download the JSON key file. Additionally, for Realtime Database, obtain your database URL (https://your_project.firebaseio.com/) from the Realtime Database section in the Firebase console. If your integration specifically requires a Web API Key, you can find this in your project settings under General.
2. Add them to .dlt/secrets.toml
[sources.ui_bakery_firebase_source] private_key = "REPLACE_ME"
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 UI Bakery Firebase 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 ui_bakery_firebase_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline ui_bakery_firebase_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset ui_bakery_firebase_data The duckdb destination used duckdb:/ui_bakery_firebase.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 documents and users from the UI Bakery Firebase 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 ui_bakery_firebase_source(private_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://your_project.firebaseio.com/", "auth": {"type": "bearer", "token": private_key}, }, "resources": [ {"name": "app_list", "endpoint": {"path": "api/instance/apps"}}, {"name": "app_release", "endpoint": {"path": "api/instance/app/{app_id}/release"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="ui_bakery_firebase_pipeline", destination="duckdb", dataset_name="ui_bakery_firebase_data", ) load_info = pipeline.run(ui_bakery_firebase_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("ui_bakery_firebase_pipeline").dataset() sessions_df = data.app_list.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM ui_bakery_firebase_data.app_list LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("ui_bakery_firebase_pipeline").dataset() data.app_list.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 UI Bakery Firebase 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 UI Bakery Firebase?
Request dlt skills, commands, AGENT.md files, and AI-native context.