Orbit Python API Docs | dltHub
Build a Orbit-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Orbit API is a REST API for managing forms, submissions, contacts, scheduling pages, meetings and related resources for the Orbit platform. The REST API base URL is https://orbitforms.ai/api/v1 and all requests require a Bearer API key in the Authorization header.
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 Orbit data in under 10 minutes.
What data can I load from Orbit?
Here are some of the endpoints you can load from Orbit:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| forms | /forms | GET | forms | List all forms in the account |
| form_submissions | /forms/:formId/submissions | GET | submissions | List submissions for a specific form |
| contacts | /contacts | GET | contacts | List contacts (supports filters like form_id, limit) |
| contact | /contacts/:contactId | GET | (object) | Get single contact by id |
| contact_tags | /contact-tags | GET | contact_tags | List contact tags |
| scheduling_pages | /scheduling-pages | GET | scheduling_pages | List scheduling pages |
| meetings | /meetings | GET | meetings | List meetings (supports status, limit filters) |
| availability_schedules | /availability-schedules | GET | availability_schedules | List availability schedules |
| submissions_delete | /submissions/:submissionId | DELETE | Delete a submission (included for relevance) |
How do I authenticate with the Orbit API?
The API uses API keys passed as a Bearer token in the Authorization header: Authorization: Bearer YOUR_API_KEY
1. Get your credentials
- Sign in to the Orbit dashboard (https://orbitforms.ai) 2) Open Settings or Developer/API Keys section 3) Create a new API key (name it, set scopes) 4) Copy the generated key and store it securely; use it as a Bearer token in requests
2. Add them to .dlt/secrets.toml
[sources.orbit_love_source] api_key = "your_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 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 Orbit 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 orbit_love_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline orbit_love_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset orbit_love_data The duckdb destination used duckdb:/orbit_love.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline orbit_love_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 forms and contacts from the Orbit 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 orbit_love_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://orbitforms.ai/api/v1", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "forms", "endpoint": {"path": "forms", "data_selector": "forms"}}, {"name": "contacts", "endpoint": {"path": "contacts", "data_selector": "contacts"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="orbit_love_pipeline", destination="duckdb", dataset_name="orbit_love_data", ) load_info = pipeline.run(orbit_love_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("orbit_love_pipeline").dataset() sessions_df = data.forms.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM orbit_love_data.forms LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("orbit_love_pipeline").dataset() data.forms.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 Orbit 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.
Troubleshooting
Authentication failures
If you receive 401 Unauthorized: verify the Authorization header contains Bearer <API_KEY>, ensure the API key is active and has required scopes. Rotate the key if compromised.
Rate limits and 429 responses
The API returns 429 Too Many Requests when rate limits are exceeded. Inspect rate limit headers included in responses and implement exponential backoff and retries.
Pagination
List endpoints support limit/offset or cursor pagination; check endpoint docs and follow returned pagination fields (next cursor or links). Ensure you request an appropriate limit and iterate until no further pages are returned.
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 Orbit?
Request dlt skills, commands, AGENT.md files, and AI-native context.