DEVELOPER API

API overview

Learn the MeshBuilder 3D REST API URL, request format, task states and error handling.

Last updated: 2026-08-20

The MeshBuilder 3D REST API covers accounts, assets and asynchronous creation tasks. Use Swagger for the complete, interactive schema.

Open Swagger API Reference Download OpenAPI JSON

Base URL

https://meshbuilder3d.com/api/v1

Request format

Send JSON requests with Content-Type: application/json. Authenticated endpoints use the current session or the server-defined authentication method. Never place credentials in frontend code or a public repository.

curl https://meshbuilder3d.com/api/v1/user/me   --header "Accept: application/json"

Asynchronous tasks

Generation, retopology, UV and texturing endpoints do not return the final model immediately. Store the task ID and poll at a reasonable interval.

Status	Meaning	Client behavior
`WAIT`	Queued	Wait and avoid duplicate creation
`RUN`	Processing	Poll and display progress
`SAVING`	Saving	Wait for the asset URL
Complete	Result available	Load the asset and stop polling
Failed	Task could not finish	Show the error and decide whether to retry

Error handling

Check the HTTP status before parsing the business response.
Ask users to correct invalid parameters instead of retrying automatically.
Use bounded exponential backoff for temporary network failures.
Record request IDs, task IDs and errors, but never credentials or complete image data.

API schema

Fields can change with service versions. Open Swagger UI for the deployed schema or download OpenAPI JSON to generate a client.

API REFERENCEOpen the complete API schema

Inspect request parameters, response structures and interactive tools.