## Basic model info

- Model name: meshy/meshy meshy-v6
- Model description: Meshy-6 is the latest model from Meshy. It generates realistic and production ready 3D models.
- Endpoint name: image-to-3d


## Model schema

The model schema is defined in the OpenAPI schema: [OpenAPI Schema](https://oapi.sunra.ai/main/meshy/meshy-v6/latest.json)

### Model input schema

The model input schema is:



```json
{
  "description": "Input schema for Meshy V6 image-to-3D generation.",
  "properties": {
    "animation_action_id": {
      "default": 1001,
      "description": "Animation preset ID from Meshy's library. Only used when enable_animation is true.",
      "title": "Animation Action Id",
      "type": "integer",
      "x-sr-order": 504
    },
    "enable_animation": {
      "default": false,
      "description": "Apply an animation preset to the rigged model. Requires enable_rigging to be true.",
      "title": "Enable Animation",
      "type": "boolean",
      "x-sr-order": 503
    },
    "enable_pbr": {
      "default": false,
      "description": "Generate PBR Maps (metallic, roughness, normal) in addition to base color.",
      "title": "Enable Pbr",
      "type": "boolean",
      "x-sr-order": 406
    },
    "enable_rigging": {
      "default": false,
      "description": "Automatically rig the generated model as a humanoid character. Best results with humanoid characters.",
      "title": "Enable Rigging",
      "type": "boolean",
      "x-sr-order": 501
    },
    "enable_safety_checker": {
      "default": true,
      "description": "If set to true, input data will be checked for safety before processing.",
      "title": "Enable Safety Checker",
      "type": "boolean",
      "x-sr-order": 601
    },
    "image": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "Image URL or base64 data URI for 3D model creation. Supports JPG, JPEG, PNG, AVIF, HEIF formats.",
      "title": "Image",
      "x-sr-order": 301
    },
    "pose_mode": {
      "default": "default",
      "description": "Pose mode for the generated model. 'a-pose' or 't-pose' for specific poses, empty for no specific pose.",
      "enum": [
        "default",
        "a-pose",
        "t-pose"
      ],
      "title": "Pose Mode",
      "type": "string",
      "x-sr-order": 407
    },
    "rigging_height_meters": {
      "default": 1.7,
      "description": "Approximate height of the character in meters. Only used when enable_rigging is true.",
      "title": "Rigging Height Meters",
      "type": "number",
      "x-sr-order": 502
    },
    "should_remesh": {
      "default": true,
      "description": "Whether to enable the remesh phase.",
      "title": "Should Remesh",
      "type": "boolean",
      "x-sr-order": 404
    },
    "should_texture": {
      "default": true,
      "description": "Whether to generate textures.",
      "title": "Should Texture",
      "type": "boolean",
      "x-sr-order": 405
    },
    "symmetry_mode": {
      "default": "auto",
      "description": "Controls symmetry behavior during model generation.",
      "enum": [
        "off",
        "auto",
        "on"
      ],
      "title": "Symmetry Mode",
      "type": "string",
      "x-sr-order": 403
    },
    "target_polycount": {
      "default": 30000,
      "description": "Target number of polygons in the generated model.",
      "maximum": 300000,
      "minimum": 100,
      "title": "Target Polycount",
      "type": "integer",
      "x-sr-order": 402
    },
    "texture_image": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "2D image URL to guide the texturing process.",
      "title": "Texture Image",
      "x-sr-order": 409
    },
    "texture_prompt": {
      "description": "Text prompt to guide the texturing process.",
      "title": "Texture Prompt",
      "type": "string",
      "x-sr-order": 408
    },
    "topology": {
      "default": "triangle",
      "description": "Specify the topology of the generated model. Quad for smooth surfaces, Triangle for detailed geometry.",
      "enum": [
        "quad",
        "triangle"
      ],
      "title": "Topology",
      "type": "string",
      "x-sr-order": 401
    }
  },
  "required": [
    "image"
  ],
  "title": "ImageTo3DInput",
  "type": "object"
}
```



### Model output schema

The model output schema is:



```json
{
  "properties": {
    "model": {
      "properties": {
        "content_type": {
          "description": "The mime type of the file.",
          "title": "Content Type",
          "type": "string"
        },
        "file_name": {
          "description": "The name of the file. It will be auto-generated if not provided.",
          "title": "File Name",
          "type": "string"
        },
        "file_size": {
          "description": "The size of the file in bytes.",
          "title": "File Size",
          "type": "integer"
        },
        "url": {
          "description": "The URL where the file can be downloaded from.",
          "title": "Url",
          "type": "string"
        }
      },
      "required": [
        "content_type",
        "file_name",
        "file_size",
        "url"
      ],
      "title": "SunraFile",
      "type": "object"
    }
  },
  "required": [
    "model"
  ],
  "title": "ModelOutput",
  "type": "object"
}
```



## Example inputs and outputs

Use the following example inputs and outputs to understand the model.

### Input example



```json
{
  "animation_action_id": 1001,
  "enable_animation": false,
  "enable_pbr": false,
  "enable_rigging": false,
  "enable_safety_checker": true,
  "image": "",
  "pose_mode": "default",
  "rigging_height_meters": 1.7,
  "should_remesh": true,
  "should_texture": true,
  "symmetry_mode": "auto",
  "target_polycount": 30000,
  "texture_image": "",
  "texture_prompt": "",
  "topology": "triangle"
}
```



### Output example



```json
{
}
```



## Model code examples

### JavaScript



```javascript
import { sunra } from "@sunra/client";

const result = await sunra.subscribe("meshy/meshy-v6/image-to-3d", {
  input: {
  	image: '',
  	topology: 'triangle',
  	target_polycount: 30000,
  	symmetry_mode: 'auto',
  	should_remesh: true,
  	should_texture: true,
  	enable_pbr: false,
  	pose_mode: 'default',
  	texture_prompt: '',
  	texture_image: '',
  	enable_rigging: false,
  	rigging_height_meters: 1.7,
  	enable_animation: false,
  	animation_action_id: 1001,
  	enable_safety_checker: true
  },
  logs: true,
  onQueueUpdate: (update) => {
    console.log(`Status Update: ${update.status}, Request ID: ${update.request_id}`);
  },
});
console.log(result.data);
console.log(result.requestId);
```



### Python



```python
import sunra_client

result = sunra_client.subscribe(
    "meshy/meshy-v6/image-to-3d",
    arguments={
        "image": "",
        "topology": "triangle",
        "target_polycount": 30000,
        "symmetry_mode": "auto",
        "should_remesh": True,
        "should_texture": True,
        "enable_pbr": False,
        "pose_mode": "default",
        "texture_prompt": "",
        "texture_image": "",
        "enable_rigging": False,
        "rigging_height_meters": 1.7,
        "enable_animation": False,
        "animation_action_id": 1001,
        "enable_safety_checker": True
    },
    with_logs=True,
    on_enqueue=print,
    on_queue_update=print,
)
print(result)
```



### Java



```java
import ai.sunra.client.*;
import java.util.Map;
import com.google.gson.JsonObject;

var client = SunraClient.withEnvCredentials();

var response = client.subscribe(
    "meshy/meshy-v6/image-to-3d",
    SubscribeOptions.<JsonObject>builder()
        .input(Map.of(
            "image", "",
            "topology", "triangle",
            "target_polycount", 30000,
            "symmetry_mode", "auto",
            "should_remesh", true,
            "should_texture", true,
            "enable_pbr", false,
            "pose_mode", "default",
            "texture_prompt", "",
            "texture_image", "",
            "enable_rigging", false,
            "rigging_height_meters", 1.7,
            "enable_animation", false,
            "animation_action_id", 1001,
            "enable_safety_checker", true))
        .resultType(JsonObject.class)
        .onQueueUpdate(update -> System.out.printf(
            "\nStatus Update: %s, Request ID: %s%n",
            update.getStatus(),
            update.getRequestId()
        ))
        .logs(true)
        .build()
);

System.out.println("Completed!");
System.out.println(response.getData());
  
```



### Kotlin



```kotlin
import ai.sunra.client.kt.*
import com.google.gson.JsonObject

val client = createSunraClient()

val response = client.subscribe<JsonObject>(
    endpointId = "meshy/meshy-v6/image-to-3d",
    input = mapOf(
            "image" to "",
            "topology" to "triangle",
            "target_polycount" to 30000,
            "symmetry_mode" to "auto",
            "should_remesh" to true,
            "should_texture" to true,
            "enable_pbr" to false,
            "pose_mode" to "default",
            "texture_prompt" to "",
            "texture_image" to "",
            "enable_rigging" to false,
            "rigging_height_meters" to 1.7,
            "enable_animation" to false,
            "animation_action_id" to 1001,
            "enable_safety_checker" to true),
    options = ai.sunra.client.kt.SubscribeOptions(logs = true),
    onUpdate = { update ->
        println("\nStatus Update: ${update.status}, Request ID: ${update.requestId}")
    }
)

println("Completed!")
println(response.data)
  
```



### Curl



```bash

curl --request POST \
  --url https://api.sunra.ai/v1/queue/meshy/meshy-v6/image-to-3d \
  --header "Authorization: Key $SUNRA_KEY" \
  --header "Content-Type: application/json" \
  --data '{"image":"","topology":"triangle","target_polycount":30000,"symmetry_mode":"auto","should_remesh":true,"should_texture":true,"enable_pbr":false,"pose_mode":"default","texture_prompt":"","texture_image":"","enable_rigging":false,"rigging_height_meters":1.7,"enable_animation":false,"animation_action_id":1001,"enable_safety_checker":true}'
    
```



## Model readme

>