Introduction

Thank you for choosing the Hyper3D on-premises deployment solution. For any questions, please feel free to contact us.

This document is intended for Rodin's on-premises deployment and is not meant for public distribution We provide two kinds of APIs for different use cases:

1. All-In-One API (Recommended)

This is the public API we provide to external customers on the Hyper3D web app. It offers a single pipeline process for authentication, mesh generation, and material generation, eliminating the need to perform these steps separately. This significantly simplifies the development work.

Benefits

• Simplified Workflow: Handle all steps in a single process.

• Ease of Use: Reduces the complexity of development.

Example Workflow

1. Authentication: Automatically handled within the pipeline.

2. Generation: Integrated into the process.

3. Download Result: Included in the single pipeline.

2. Customizable API

This API is used internally for the Hyper3D web app and provides the same level of customization ability as ours. You need to handle authentication, mesh generation, material generation, and progress queries separately.

Benefits

• Customization: Full control over each step of the process.

• Flexibility: Tailor the workflow to specific needs.

Example Workflow

1. Authentication: Handle separately.

2. Mesh Generation: Execute independently.

3. Progress Query: Manage progress tracking.

4. Material Generation: Perform as a distinct step.

5. Progress Query: Manage progress tracking.

6. Download Result: Request for download preparation.

7. Progress Query: Manage progress tracking.

Additional Information

The workflow and code examples can be found in the corresponding sections with specific examples written in Python and Go. However, the provided examples are only for reference purposes and serve as a high-level guide. For detailed request and response bodies, we recommend referring to the specific endpoints in the API documentation.