Use Meshy 5 with Comfy Router

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

Quick start

Create a key at platform.comfy.org/profile/api-keys 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-5 Endpoint: POST https://api.comfy.org/v2/models/meshy/meshy-5

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Each call sends a fresh
# Idempotency-Key and waits up to 10 minutes for the finished result.
with Comfy() as client:
    result = client.models.run(
        "meshy/meshy-5",
        {
            # Request fields are the provider's own — see Input below.
        },
    )

print(result)

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

// Reads COMFY_API_KEY from the environment. Each call sends a fresh
// Idempotency-Key and waits up to 10 minutes for the finished result.
const { data } = await comfy.models.run("meshy/meshy-5", {
  // Request fields are the provider's own — see Input below.
});

console.log(data);

# Request fields are the provider's own — see Input below.
curl https://api.comfy.org/v2/models/meshy/meshy-5 \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Schema

Input

Router has not published an authored input schema for this model yet: GET /v2/models/meshy/meshy-5/openapi.json returns an open object with x-comfy-input-schema-authored: false. Router forwards the body to Meshy unchanged, so Meshy’s own API reference is authoritative for the request fields, and nothing is validated server side.

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

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 snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send an Idempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.

Headers

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

Quick Start

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

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 5 with Comfy Router

Quick start

Schema

Input

Output

Examples

Output

Before you ship

Headers

Quick Start

Limitations

​Quick start

​Schema

​Input

​Output

​Examples

​Output

​Before you ship

Headers

Quick Start

Limitations

Quick start

Schema

Input

Output

Examples

Output

Before you ship