3D Verse Python API Docs | dltHub
Build a 3D Verse-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
3D Verse is a REST API platform that converts text or images into 3D models and manages 3D assets and sessions. The REST API base URL is https://api.3dverse.com and All requests require an API token (Bearer) 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 add "dlt[hub]" and start loading 3D Verse data in under 10 minutes.
What data can I load from 3D Verse?
Here are some of the endpoints you can load from 3D Verse:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| sessions | sessions | GET | data | List sessions for a scene or folder (real-time collaborative sessions) |
| users | users | GET | data | List users |
| folders | folders | GET | data | List folders |
| folder_source_files | folders/{folder_id}/source-files | GET | items | List source files in a folder |
| folder_assets | folders/{folder_id}/assets | GET | items | List assets in a folder |
| assets | assets/{asset_id} | GET | (object) | Get asset details (single object response) |
| upload_tasks | folders/{folder_id}/upload-tasks | GET | data | List upload tasks |
| sessions_join | sessions/{session_id}/join | POST | Join a session (non-GET included because common) | |
| authentication_generate | auth/generate-token | POST | token | Generate a user token |
How do I authenticate with the 3D Verse API?
Authentication uses a bearer token passed in the Authorization header: Authorization: Bearer . Tokens are generated from the 3dverse/ModelsLab console (user or service tokens).
1. Get your credentials
- Sign in or register at the 3dverse/ModelsLab Console (https://console.3dverse.com or https://modelslab.com/register).
- Open the Console or Account -> API keys / Tokens section.
- Create a new API token (user token or service token) and copy the token value.
- Store the token securely; use it in the Authorization header for API calls.
2. Add them to .dlt/secrets.toml
[sources.three_d_verse_source] api_token = "your_api_token_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 init uv add "dlt[hub]"
1. Install the dlt AI Workbench:
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 3D Verse 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 three_d_verse_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline three_d_verse_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset three_d_verse_data The duckdb destination used duckdb:/three_d_verse.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 sessions and assets from the 3D Verse 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 three_d_verse_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.3dverse.com", "auth": { "type": "bearer", "token": api_token, }, }, "resources": [ {"name": "sessions", "endpoint": {"path": "sessions", "data_selector": "data"}}, {"name": "assets", "endpoint": {"path": "folders/{folder_id}/assets", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="three_d_verse_pipeline", destination="duckdb", dataset_name="three_d_verse_data", ) load_info = pipeline.run(three_d_verse_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("three_d_verse_pipeline").dataset() sessions_df = data.sessions.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM three_d_verse_data.sessions LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("three_d_verse_pipeline").dataset() data.sessions.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 3D Verse 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 a valid bearer token: Authorization: Bearer . Ensure the token has not expired and that you copied it exactly from the Console.
Rate limits and throttling
The API enforces rate limits; on 429 Too Many Requests responses, implement exponential backoff and retry. Check response headers for X-RateLimit-* where provided.
Pagination
List endpoints return paginated results. Check the response for keys like data, items, and a pagination object (next, page, limit) and follow the next link or page token when present.
Common errors
400 Bad Request â malformed request or invalid parameters. 401 Unauthorized â invalid or missing token. 403 Forbidden â insufficient permissions. 404 Not Found â resource missing. 429 Too Many Requests â rate limit exceeded. 500/502/503 â server error; retry with exponential backoff.
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.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-runtime
Was this page helpful?
Community Hub
Need more dlt context for 3D Verse?
Request dlt skills, commands, AGENT.md files, and AI-native context.