Introduction
Integrate Rodin image-to-3D and text-to-3D generation into your products and pipelines.
This site is the reference for the Rodin API. It covers authentication, generation, task status, downloads, errors, and integration examples. Share documentation feedback in our Discord community.
Overview
Rodin is an HTTP API for creating 3D assets from images or text. Protected endpoints use Bearer authentication, file-based generation requests use multipart/form-data, and responses use JSON.
All API v2 endpoints use this base URL:
https://api.hyper3d.com/api/v2How to Use These Docs
Start with the guide that matches what you need:
Quick Start
Make your first authenticated request and download the result.
Features
Understand Rodin model families, the task lifecycle, and credits.
API Specification
Look up endpoint fields, responses, errors, and examples.
Data Retention Policy
Understand data handling for API payloads and generated output.
Just Getting Started?
Create an API key in the API dashboard, then follow the Quick Start. It walks through authentication, task submission, status polling, failure handling, and downloading the completed asset.
Rodin generation is asynchronous. The Quick Start also explains when to use jobs.subscription_key, when to use the top-level uuid, and how to back off repeated status checks.
Resources
- Pricing: check current credit pricing before submitting paid workloads.
- Discord Community: discuss integrations and report documentation issues.
- Contact Hyper3D: reach the team for account or business questions.