Get started with Rodin
Last updated
Was this helpful?
Last updated
Was this helpful?
Rodin's API uses API keys to authenticate requests. To access Rodin services programmatically, you need to generate an API key. Here’s how to authenticate and use the API keys securely.
Navigate to the API Key Management Page
Log into your Rodin account and go to the API Key Management section.
Click on the "+Create new API Keys" button to generate a new key.
Store Your API Key Securely
Once created, the API key will be displayed only once. Ensure you copy and store it securely. If you lose the key, you will need to generate a new one.
Revoke Keys When Necessary
You can manage your existing API keys and revoke any that are no longer needed directly from the API Key Management page.
For every API request, include the API key in the Authorization HTTP header. Here’s an example of how to structure your request:
Replace YOUR_RODIN_API_KEY
with the actual API key you generated.
Once you’ve generated your API key, you can trigger your first request to generate high-quality 3D assets using the example code provided below.
When you send a POST request to the Rodin API, the server returns a JSON response. Here is the structure of the response and an explanation of its components.
Example of a Successful Response
Fields in the Response
error: This field will be null
if the request is successful. If there is an error, it will contain a string describing the error.
message: A string message indicating the status of the request. For successful submissions, this will typically be "Submitted."
uuid: A unique identifier for the task spawned by your request. This uuid
is used to track the overall task.
jobs: An array of job objects. Each job object represents a step in the task and includes:
uuids: An array of unique identifiers for the individual jobs. Each job corresponds to a specific process involved in the task, such as model generation or texture generation.
subscription_key: A key used to query the status of each job. This key allows you to track the progress and completion of the jobs.
The Generation APIs are time and resource consuming, so we designed them to be asynchronous. This means that you submit a task without getting the result immediately.
As a quick and dirty example in this quick start, we will show you how to get a list of URL to download your results, assuming your task is ready for download.
You will got an JSON response like the following
This is an array of files with a url
to download it from and a human-friendly name
of the file. You can download them with your browser or with a script programmingly. The following Bash script parses the return with jq
and download them with subsequent calls to curl
.
After successfully submitting a task to the Rodin API, here are some recommended next steps to further explore Rodin's capabilities:
Explore Adjustable Parameters
Track Progress
Retrieve Generated Assets
Stay Updated
With the and API endpoint, you can check the status of your submitted job and download results from the task. You are advised to use the Progress Check API to ensure if your task is ready before downloading as we demostrated in the to avoid unexpected results.
Check our for more adjustable parameters for 3D asset generation. Fine-tune your requests to achieve the desired output with various customizable options.
Explore Other Rodin Generation Models Explore our other to find the best fit for your needs. Since the default tier is Rodin Sketch, consider looking into other models that might offer additional features or better suit your project requirements
Use our to track the status of your 3D asset generation. Monitor each job and ensure everything is progressing as expected.
Once the 3D asset generation is complete, query our to package and download the generated assets. Ensure you have all necessary files for your project.
Follow us on , , and for the latest updates on Rodin Gen-1 and ChatAvatar.