Skip to main content
API Reference for meshy/meshy-n1, served by Comfy Router from Meshy. Input: Image, 3D · Output: 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/meshy-n1 Endpoint: POST https://api.comfy.org/v2/models/meshy/meshy-n1
The same body, sent to POST https://api.comfy.org/v2/models/meshy/meshy-n1/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

string
The Meshy model to run. On the Comfy Router route this is supplied by the path (/v2/models/meshy/{model}) and may be omitted or sent as null; Router writes the path’s model here after validation.
boolean
Use the original UV of the model instead of generating new UVs.
boolean
default:"false"
meshy-n1 does not generate PBR maps, so only false is accepted.Possible values: false
string
One reference image, used as the front view. Supports jpg, jpeg, png and webp, or a base64 data URI. Do not send with multiview_image_urls.
string
The ID of a completed Meshy task whose mesh to texture. Required if model_url is not provided.
string
A publicly accessible URL or data URI to a 3D model. Supported formats glb, gltf, obj, fbx, stl. Required if input_task_id is not provided. At most 7,999,999 triangle faces.
string[]
One to four reference images of the same object. The first image is the front view. Do not send with image_style_url.
string[]
The model formats to generate. One or more of glb, obj, fbx, stl, usdz and 3mf.
string
default:"\"2k\""
Texture resolution of the base color map. meshy-n1 supports 2k only.Possible values: 2k
Generated from the schema Router serves at GET /v2/models/meshy/meshy-n1/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

integer
Timestamp of when the task was created, in milliseconds.
integer
Timestamp of when the task result expires, in milliseconds.
integer
Timestamp of when the task was finished, in milliseconds. 0 if not finished.
string
required
Unique identifier for the task.
string
The image input that was used to create the texturing task.
object
Downloadable URLs to the textured 3D model files.
string
Downloadable URL to the FBX file.
string
Downloadable URL to the GLB file.
string
Downloadable URL to the MTL material file for the OBJ file.
string
Downloadable URL to the OBJ file.
string
Downloadable URL to the STL file.
string
Downloadable URL to the USDZ file.
string[]
The reference images that were used to create the texturing task.
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.
string
required
Possible values: SUCCEEDED
object
Error object that contains the error message if the task failed.
string
Detailed error message.
string
The text prompt that was used to create the texturing task.
object[]
An array of texture URL objects that are generated from the task.
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 thumbnail image of the model file.
string
Type of the Retexture task.Possible values: retexture

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.