## Basic model info

- Model name: tencent-hunyuan/tencent-hunyuan hunyuan3d-v3.1
- Model description: Generate detailed 3D models from text or images with Hunyuan3D v3.1 Pro, with optional PBR materials, part decomposition, and smart topology.
- Endpoint name: text-to-3d


## Model schema

The model schema is defined in the OpenAPI schema: [OpenAPI Schema](https://oapi.sunra.ai/main/tencent-hunyuan/hunyuan3d-v3.1/latest.json)

### Model input schema

The model input schema is:



```json
{
  "properties": {
    "prompt": {
      "description": "Text description of the 3D content to generate. Max 1024 UTF-8 characters.",
      "maxLength": 1024,
      "title": "Prompt",
      "type": "string",
      "x-sr-order": 201
    },
    "enable_pbr": {
      "default": false,
      "description": "Enable PBR material generation (metallic, roughness, normal textures). Ignored when generate_type is Geometry.",
      "title": "Enable Pbr",
      "type": "boolean",
      "x-sr-order": 501
    },
    "face_count": {
      "default": 500000,
      "description": "Target polygon face count. Range: 40,000-1,500,000. Default: 500,000.",
      "maximum": 1500000,
      "minimum": 40000,
      "title": "Face Count",
      "type": "integer",
      "x-sr-order": 401
    },
    "geometry_only": {
      "default": false,
      "description": "Generation task type. Normal: textured model. Geometry: geometry-only white model (no textures). LowPoly/Sketch are not available in v3.1.",
      "title": "Geometry Only",
      "type": "boolean",
      "x-sr-order": 502
    }
  },
  "required": [
    "prompt"
  ],
  "title": "TextTo3DInput",
  "type": "object"
}
```



### Model output schema

The model output schema is:



```json
{
  "description": "Unified output schema for Hunyuan3D V3.1.",
  "properties": {
    "model": {
      "description": "URL of the generated 3D 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"
    },
    "score": {
      "description": "Billing score for image-to-3d: base + add-ons",
      "title": "Score",
      "type": "number"
    }
  },
  "required": [
    "model"
  ],
  "title": "Hunyuan3DV31Output",
  "type": "object"
}
```



## Example inputs and outputs

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

### Input example



```json
{
  "prompt": "",
  "enable_pbr": false,
  "face_count": 500000,
  "geometry_only": false
}
```



### Output example



```json
{
}
```



## Model code examples

### JavaScript



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

const result = await sunra.subscribe("tencent-hunyuan/hunyuan3d-v3.1/text-to-3d", {
  input: {
  	prompt: '',
  	face_count: 500000,
  	enable_pbr: false,
  	geometry_only: false
  },
  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(
    "tencent-hunyuan/hunyuan3d-v3.1/text-to-3d",
    arguments={
        "prompt": "",
        "face_count": 500000,
        "enable_pbr": False,
        "geometry_only": False
    },

    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(
    "tencent-hunyuan/hunyuan3d-v3.1/text-to-3d",
    SubscribeOptions.<JsonObject>builder()
        .input(Map.of(
            "prompt", "",
            "face_count", 500000,
            "enable_pbr", false,
            "geometry_only", false))

        .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 = "tencent-hunyuan/hunyuan3d-v3.1/text-to-3d",
    input = mapOf(
            "prompt" to "",
            "face_count" to 500000,
            "enable_pbr" to false,
            "geometry_only" to false),
    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/tencent-hunyuan/hunyuan3d-v3.1/text-to-3d \
  --header "Authorization: Key $SUNRA_KEY" \
  --header "Content-Type: application/json" \
  --data '{"prompt":"","face_count":500000,"enable_pbr":false,"geometry_only":false}'
    
```



## Model readme

undefined