Skip to main content
API Reference for meshy/relief, served by Comfy Router from Meshy. Input: Image · Output: Image + 3D

Quick start

Create a key in your Comfy workspace and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk and npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: meshy/relief Endpoint: POST https://api.comfy.org/v2/models/meshy/relief
The same body, sent to POST https://api.comfy.org/v2/models/meshy/relief/requests. Router answers 201 with a request_id as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. Queued delivery walks through status, cancellation and collection.

Schema

Input

number
Base plate thickness in millimeters, 0.1 to 10. With remove_base true, omit it or send 0.Range: 0 to 10
number
default:"60"
Bend angle in degrees. Below 1 the relief stays flat.Range: 0 to 360
string
xz (default, bends the left and right edges) or yz (bends the top and bottom edges). Applies only when bend_mode is convex or concave.
string
off (default), convex or concave.
number
Carving depth in millimeters. The default is 6 for variant high and 3 for variant low.Range: 0 to 60
string
emboss (default) or engrave.
boolean
default:"false"
Color the model from the image. GLB, OBJ, FBX and USDZ carry the color; STL and 3MF stay white. The cost does not change.
string
required
A public URL or data URI of a jpg, jpeg, png or webp image. At most 20 MB and at least 32 x 32 pixels. Transparent areas are filled with black.
integer
default:"1024"
Points along the longer side. Larger values give much larger files (about 150 MB GLB and 300 MB STL at 2048).Range: 512 to 2048
number
default:"0.01"
Background removal threshold. Applies only when remove_base is true.Range: 0.01 to 1
boolean
default:"false"
Cut away the background so the relief has no base plate.
boolean
default:"true"
Set to false for a depth map only, with no model and no preview. The cost does not change.
number
default:"60"
Length of the longer side in millimeters.Range: 20 to 250
string[]
The model formats to generate. One or more of glb, obj, fbx, stl, usdz and 3mf. The default is glb and stl.
string
low (default) gives slight depth and finer detail, for laser or CNC work. high gives deeper, sculptural relief, for 3D printing. It also sets the default carving_depth_mm.
Generated from the schema Router serves at GET /v2/models/meshy/relief/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

integer
Meshy credits the task used. 0 for a failed task.
integer
Timestamp of when the task was created, in milliseconds.Format: int64
string
Downloadable URL to the 2k 16-bit grayscale depth map PNG. The values are relative, not millimeters.
integer
Timestamp of when the task result expires, in milliseconds. 0 if not finished.Format: int64
integer
Timestamp of when the task was finished, in milliseconds. 0 if not finished.Format: int64
string
required
Unique identifier for the task.
object
Downloadable URLs to the relief model files, one per requested format. Empty for a depth-map-only task.
string
Downloadable URL to the 3MF file.
string
Downloadable URL to the FBX file.
string
Downloadable URL to the GLB file, in meters.
string
Downloadable URL to the MTL material file for the OBJ file.
string
Downloadable URL to the OBJ file.
string
Downloadable URL to the binary STL file, in millimeters.
string
Downloadable URL to the USDZ file.
integer
The count of preceding tasks. Only meaningful when status is PENDING.
integer
Progress of the task. 0 if not started, 100 when succeeded.Range: 0 to 100
integer
Timestamp of when the task was started, in milliseconds. 0 if not started.Format: int64
string
required
Possible values: SUCCEEDED
object
Error object that contains the error message if the task failed.
string
Detailed error message.
object[]
Texture URLs. Present only with color_mapping true.
string
Downloadable URL to the base color map image.
string
Downloadable URL to the metallic map image.
string
Downloadable URL to the normal map image.
string
Downloadable URL to the roughness map image.
string
Downloadable URL to the preview image. Empty for a depth-map-only task.
string
Type of the task. Always relief.

Examples

Input

Output

Before you ship

The SDKs create an Idempotency-Key and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes. When a request fails, Router sends an X-Comfy-Error-Type response header explaining why. A 422 means Router rejected the input before calling the provider, and a 413 means the request body was larger than Router accepts. Download generated assets promptly because result URLs can expire. Any size limit named in a field description above is the provider’s own bound on that field, quoted from the provider’s specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see request body size. This page documents one partner model called through Comfy Router. The same comfy-sdk / @comfyorg/sdk package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: Comfy(api_key=...) / new Comfy({ apiKey }), with client.workflows, client.assets and client.jobs. See Comfy SDKs.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.