Use Meshy 6 with Comfy Router

API Reference for meshy/meshy-6, served by Comfy Router from Meshy.

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, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: meshy/meshy-6 Endpoint: POST https://api.comfy.org/v2/models/meshy/meshy-6

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "meshy/meshy-6",
        {
            "art_style": "realistic",
            "mode": "preview",
            "prompt": "a red cube",
        },
    )

print(result)

import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// The SDK automatically creates an idempotency key and reuses it for automatic retries.
const { data } = await comfy.models.run("meshy/meshy-6", {
  art_style: "realistic",
  mode: "preview",
  prompt: "a red cube",
});

console.log(data);

curl https://api.comfy.org/v2/models/meshy/meshy-6 \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"art_style\": \"realistic\", \"mode\": \"preview\", \"prompt\": \"a red cube\"}"

Schema

Input

`preview` variant

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. On the v1 /proxy route see MeshyTextTo3DPreviewRequest, which constrains it to MeshyAiModel.

string

default:"\"realistic\""

Describe your desired art style of the object.Possible values: realistic, sculpture

boolean

default:"false"

Deprecated. Use pose_mode instead. Whether to generate the model in an A/T pose.

string

required

This field should be set to “preview” when creating a preview task.Possible values: preview

boolean

default:"false"

When true, input content will be screened for potentially harmful content.

string

Specify the pose mode for the generated model.Possible values: a-pose, t-pose, “

string

required

Describe what kind of object the 3D model is. Maximum 600 characters.

boolean

default:"true"

Controls whether to enable the remesh phase. When false, returns highest-precision triangular mesh.

string

default:"\"auto\""

Controls symmetry behavior during model generation.Possible values: off, auto, on

integer

default:"30000"

Specify the target number of polygons in the generated model. Valid range is 100 to 300,000.Range: 100 to 300000

string

default:"\"triangle\""

Specify the topology of the generated model.Possible values: quad, triangle

boolean

default:"false"

Enables Ultra generation for higher-fidelity geometry with finer surface detail. Only supported when ai_model is meshy-7 or latest.

`refine` variant

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. On the v1 /proxy route see MeshyTextTo3DRefineRequest, which constrains it to MeshyAiModel.

boolean

default:"false"

Generate PBR Maps (metallic, roughness, normal) in addition to the base color. Note that enable_pbr should be set to false when using Sculpture style.

string

required

This field should be set to “refine” when creating a refine task.Possible values: refine

boolean

default:"false"

When true, input content will be screened for potentially harmful content.

string

required

The corresponding preview task id. The status of the given preview task must be SUCCEEDED.

string

Provide a 2d image to guide the texturing process. Supports .jpg, .jpeg, .png formats or base64-encoded data URI.

string

Provide an additional text prompt to guide the texturing process. Maximum 600 characters.

string

default:"\"2k\""

Texture resolution of the generated textures. One of 2k, 4k or 8k. 4k and 8k require ai_model meshy-6, meshy-7 or latest.Possible values: 2k, 4k, 8k

Generated from the schema Router serves at GET /v2/models/meshy/meshy-6/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

string

The unmodified art_style that was used to create the preview task.

integer

Timestamp of when the task was created, in milliseconds.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 textured 3D model files generated by Meshy.

string

Downloadable URL to the FBX file.

string

Downloadable URL to the GLB file.

string

Downloadable URL to the MTL file.

string

Downloadable URL to the OBJ file.

string

Downloadable URL to the USDZ file.

string

Deprecated field maintained for backward compatibility.

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

string

The unmodified prompt that was used to create the task.

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.

string

Downloadable URL to the texture image that was used to guide the texturing process.

string

Additional text prompt provided to guide the texturing process during the refine stage.

string

Deprecated field maintained for backward compatibility.

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 Text to 3D task.Possible values: text-to-3d-preview, text-to-3d-refine

string

Deprecated field returning the downloadable URL to the preview video.

Examples

Input

{
  "art_style": "realistic",
  "mode": "preview",
  "prompt": "a red cube"
}

Output

{
  "art_style": "realistic",
  "created_at": 1767225600000,
  "finished_at": 1767225719000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "model_urls": {
    "fbx": "https://example.invalid/meshy/text-to-3d/model.fbx",
    "glb": "https://example.invalid/meshy/text-to-3d/model.glb",
    "mtl": "https://example.invalid/meshy/text-to-3d/model.mtl",
    "obj": "https://example.invalid/meshy/text-to-3d/model.obj",
    "usdz": "https://example.invalid/meshy/text-to-3d/model.usdz"
  },
  "progress": 100,
  "prompt": "a red cube",
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "thumbnail_url": "https://example.invalid/meshy/text-to-3d/thumbnail.png",
  "type": "text-to-3d-preview"
}

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. Download generated assets promptly because result URLs can expire.

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.

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Use Meshy 6 with Comfy Router

Quick start

Schema

Input

`preview` variant

`refine` variant

Output

Examples

Input

Output

Before you ship

Headers

Using the Router API

Limitations

​Quick start

​Schema

​Input

​preview variant

​refine variant

​Output

​Examples

​Input

​Output

​Before you ship

Headers

Using the Router API

Limitations

Quick start

Schema

Input

`preview` variant

`refine` variant

Output

Examples

Input

Output

Before you ship