Legend
GET read POST create/action PUT update DELETE delete
Auth: Required bearer token required · Optional works without a token, counts toward guest quota · Public no token needed.
Health
GET
/api/health
Public
Returns service status, uptime, and environment.
Auth & user
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/user/register | Public | Create an email account. |
| POST | /api/user/login | Public | Login and receive a token. |
| POST | /api/user/forgot-password | Public | Request a password reset. |
| POST | /api/user/reset-password | Public | Reset password with a reset token. |
| GET | /api/user/profile | Required | Get the current user. |
| PUT | /api/user/profile | Required | Update the current user's name. |
| GET | /api/user/usage | Required | Get daily quota usage and limits. |
| GET | /api/user/history | Required | Paged conversion history. |
Converter
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/converter/convert | Optional | Upload a file and start a conversion (asynchronous). |
| GET | /api/converter/status/:id | Public | Get conversion job status. |
| GET | /api/converter/download/:id | Public | Get a signed download URL. |
See Converters for full details and examples.
Mesh
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/mesh/decimate | Required | Reduce polygon count. |
| POST | /api/mesh/repair | Required | Repair mesh defects. |
| POST | /api/mesh/analyze | Required | Return mesh statistics. |
| POST | /api/mesh/recalculate | Required | Recalculate normals. |
| POST | /api/mesh/lod | Required | Generate LOD levels. |
| POST | /api/mesh/bake | Required | Bake maps from high to low poly. |
HDRI
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/hdri/convert | Required | Convert HDRI to cubemap or image. |
| POST | /api/hdri/filter | Required | Generate IBL mipmaps. |
| POST | /api/hdri/lighting | Required | Generate a lighting rig. |
| POST | /api/hdri/probe | Required | Bake light-probe data. |
Batch
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/batch/convert | Required | Convert up to 50 files in one request (returns a zip). |
Texture
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/texture/seamless | Required | Make an image tile seamlessly. |
| POST | /api/texture/seamless/export | Required | Export seamless result to TIFF/BMP/AVIF/EXR. |
| POST | /api/texture/to-png | Optional | Convert TIFF/BMP/AVIF/GIF to PNG. |
| POST | /api/texture/channel-pack/export | Required | Export channel-packed texture. |
| POST | /api/texture/export | Required | Export texture to TIFF/BMP/AVIF/EXR. |
| POST | /api/texture/resize/export | Required | Resize and export texture. |
Color
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /api/color/info?hex=… | Public | Full color info. |
| GET | /api/color/name?hex=… | Public | Nearest color name. |
| GET | /api/color/shades?hex=… | Public | Color shades. |
| GET | /api/color/harmonies?hex=… | Public | Color harmonies. |
| GET | /api/color/accessibility?hex=… | Public | Contrast and accessibility. |
| GET | /api/color/random?count=… | Public | Random colors. |
| POST | /api/color/palettes | Required | Save a palette. |
| GET | /api/color/palettes | Required | List saved palettes. |
| DELETE | /api/color/palettes/:id | Required | Delete a saved palette. |
UV
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/uv/extract | Optional | Extract UV layout data from a model. |
Panorama
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/panorama/share | Optional | Upload and share a panorama. |
| GET | /api/panorama/shared/:publicId | Public | View shared panorama metadata. |
| GET | /api/panorama/image/:publicId | Public | Get shared panorama image. |