> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Meshy 7.1 with Comfy Router

> Call meshy/meshy-7.1 through Comfy Router: endpoint, request shape and the response Router returns.

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

**Input:** Text · **Output:** 3D

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys?onboarding=router) 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-7.1`

**Endpoint:** `POST https://api.comfy.org/v2/models/meshy/meshy-7.1`

**Wait for the result**

```python Python theme={null}
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-7.1",
        {
            "art_style": "realistic",
            "mode": "preview",
            "prompt": "a red cube",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
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-7.1", {
  art_style: "realistic",
  mode: "preview",
  prompt: "a red cube",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/meshy/meshy-7.1 \
  -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\"}"
```

**Queue and collect later**

The same body, sent to `POST https://api.comfy.org/v2/models/meshy/meshy-7.1/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](https://docs.comfy.org/development/comfy-router/queue.md) walks through status, cancellation and collection.

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# Reads COMFY_API_KEY from the environment.
# Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "meshy/meshy-7.1",
            {
                "art_style": "realistic",
                "mode": "preview",
                "prompt": "a red cube",
            },
        )
        print("request_id:", handle.request_id)  # with the model ID, all another process needs

        # Poll until the request completes, waiting the Retry-After the server names.
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # The provider's own payload, the same value models.run() returns.
        # A request that failed or was cancelled raises the typed Router error here.
        result = await handle.get()

    print(result)

asyncio.run(main())
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
const handle = await comfy.models.submit("meshy/meshy-7.1", {
  art_style: "realistic",
  mode: "preview",
  prompt: "a red cube",
});
console.log("requestId:", handle.requestId); // with the model ID, all another process needs

// Poll until the request completes, waiting the Retry-After the server names.
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// The same result models.run() returns. A request that failed or was cancelled rejects here.
const result = await handle.get();

console.log(result.data);
```

```bash cURL theme={null}
# 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
curl https://api.comfy.org/v2/models/meshy/meshy-7.1/requests \
  -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\"}"

# 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/meshy/meshy-7.1/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
curl https://api.comfy.org/v2/models/meshy/meshy-7.1/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Schema

### Input

#### `preview` variant

**ai\_model** `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.

**art\_style** `string` (default: "realistic")

Describe your desired art style of the object.

Possible values: `realistic`, `sculpture`

**geometry\_resolution** `string` (default: "standard")

Geometry resolution of the generated mesh. 2k and 4k run the Ultra pass for finer surface detail. 2k and 4k require ai\_model meshy-7.1 or latest.

Possible values: `standard`, `2k`, `4k`

**is\_a\_t\_pose** `boolean` (default: false)

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

**mode** `string` *required*

This field should be set to "preview" when creating a preview task.

Possible values: `preview`

**moderation** `boolean` (default: false)

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

**pose\_mode** `string`

Specify the pose mode for the generated model.

Possible values: `a-pose`, `t-pose`, \`\`

**prompt** `string` *required*

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

**should\_remesh** `boolean` (default: false)

Controls whether to enable the remesh phase. When false, returns highest-precision triangular mesh. Defaults to true for Meshy 5 and false for Meshy 6 and 7.

**symmetry\_mode** `string` (default: "auto")

Controls symmetry behavior during model generation.

Possible values: `off`, `auto`, `on`

**target\_polycount** `integer` (default: 30000)

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

Range: `100` to `300000`

**topology** `string` (default: "triangle")

Specify the topology of the generated model.

Possible values: `quad`, `triangle`

**ultra\_mode** `boolean` (default: false)

Deprecated. Use geometry\_resolution instead; true is equivalent to geometry\_resolution 2k. Only supported when ai\_model is meshy-7, meshy-7.1 or latest. The exception is meshy-7: geometry\_resolution 2k requires meshy-7.1 or latest, so on meshy-7 ultra\_mode true is the way to request the Ultra pass.

#### `refine` variant

**ai\_model** `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.

**enable\_pbr** `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.

**mode** `string` *required*

This field should be set to "refine" when creating a refine task.

Possible values: `refine`

**moderation** `boolean` (default: false)

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

**preview\_task\_id** `string` *required*

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

**texture\_image\_url** `string`

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

**texture\_prompt** `string`

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

**texture\_resolution** `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, meshy-7.1 or latest.

Possible values: `2k`, `4k`, `8k`

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

### Output

**art\_style** `string`

The unmodified art\_style that was used to create the preview task.

**created\_at** `integer`

Timestamp of when the task was created, in milliseconds.

Format: `int64`

**finished\_at** `integer`

Timestamp of when the task was finished, in milliseconds. 0 if not finished.

Format: `int64`

**id** `string` *required*

Unique identifier for the task.

**model\_urls** `object`

Downloadable URLs to the textured 3D model files generated by Meshy.

**model\_urls.fbx** `string`

Downloadable URL to the FBX file.

**model\_urls.glb** `string`

Downloadable URL to the GLB file.

**model\_urls.mtl** `string`

Downloadable URL to the MTL file.

**model\_urls.obj** `string`

Downloadable URL to the OBJ file.

**model\_urls.usdz** `string`

Downloadable URL to the USDZ file.

**negative\_prompt** `string`

Deprecated field maintained for backward compatibility.

**preceding\_tasks** `integer`

The count of preceding tasks. Only meaningful when status is PENDING.

**progress** `integer`

Progress of the task. 0 if not started, 100 when succeeded.

Range: `0` to `100`

**prompt** `string`

The unmodified prompt that was used to create the task.

**started\_at** `integer`

Timestamp of when the task was started, in milliseconds. 0 if not started.

Format: `int64`

**status** `string` *required*

Possible values: `SUCCEEDED`

**task\_error** `object`

Error object that contains the error message if the task failed.

**task\_error.message** `string`

Detailed error message.

**texture\_image\_url** `string`

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

**texture\_prompt** `string`

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

**texture\_richness** `string`

Deprecated field maintained for backward compatibility.

**texture\_urls** `object[]`

An array of texture URL objects that are generated from the task.

**texture\_urls\[].base\_color** `string`

Downloadable URL to the base color map image.

**texture\_urls\[].metallic** `string`

Downloadable URL to the metallic map image.

**texture\_urls\[].normal** `string`

Downloadable URL to the normal map image.

**texture\_urls\[].roughness** `string`

Downloadable URL to the roughness map image.

**thumbnail\_url** `string`

Downloadable URL to the thumbnail image of the model file.

**type** `string`

Type of the Text to 3D task.

Possible values: `text-to-3d-preview`, `text-to-3d-refine`

**video\_url** `string`

Deprecated field returning the downloadable URL to the preview video.

## Examples

### Input

```json theme={null}
{
  "art_style": "realistic",
  "mode": "preview",
  "prompt": "a red cube"
}
```

### Output

```json theme={null}
{
  "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, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](https://docs.comfy.org/development/comfy-router/reference.md#result-assets).

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](https://docs.comfy.org/development/comfy-router/limitations.md#request-bodies-are-capped).

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](https://docs.comfy.org/development/api-development/sdks.md).

> **[Headers](https://docs.comfy.org/development/comfy-router/headers.md)**
>
> Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

> **[Using the Router API](https://docs.comfy.org/development/comfy-router/api.md)**
>
> Model discovery, validation errors, retries, and billing.

> **[Limitations](https://docs.comfy.org/development/comfy-router/limitations.md)**
>
> What Router does not do today, and what to use instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.