# Meshy - Multi Image to 3D — API Reference

Model ID: `model_meshy-multi-image-to-3d`

---

## Authentication

Scenario API uses HTTP Basic Auth. Encode your credentials in Base64 and pass them as the `Authorization` header.

```
Authorization: Basic base64("<API_KEY>:<API_SECRET>")
```

- **API_KEY** and **API_SECRET** are found in your [Scenario Project Settings](https://app.scenario.com/team&tab=project_api_keys) under API Keys.
- In shell: `$(echo -n '<API_KEY>:<API_SECRET>' | base64)`
- In JavaScript: `btoa("<API_KEY>:<API_SECRET>")`
- In Python: `base64.b64encode(f"{api_key}:{api_secret}".encode()).decode()`

---

## Generate

**Endpoint:** `POST https://api.cloud.scenario.com/v1/generate/custom/model_meshy-multi-image-to-3d`

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `image` | assetId[] | yes | - | Provide 1–4 images from multiple angles for higher-quality 3D. |
| `aiModel` | string | - | `meshy-6` | Meshy generation model. meshy-6 and latest use Meshy 6 pricing; meshy-5 uses standard pricing. |
| `shouldTexture` | boolean | - | `true` | Generate textures for a fully colored model. Disable for an untextured mesh (lower cost). |
| `enablePbr` | boolean | - | `false` | Generate PBR maps (metallic, roughness, normal, emission) in addition to base color. Requires texture generation. |
| `hdTexture` | boolean | - | `false` | Generate a 4K base color texture. Supported on Meshy 6 only. |
| `texturePrompt` | string | - | `` | Optional text to guide texturing (max 600 characters). |
| `textureImage` | assetId | - | - | Optional 2D image to guide texturing (.jpg, .jpeg, .png). Requires texture generation. |
| `topology` | string | - | `triangle` | Mesh topology for the generated model. |
| `targetPolycount` | number | - | `30000` | Target polygon count; actual count may vary with geometry complexity. |
| `savePreRemeshedModel` | boolean | - | `false` | Store the GLB before the remesh phase. |
| `symmetryMode` | string | - | `auto` | Symmetry behavior during generation. |
| `poseMode` | string | - | `` | Pose for the generated model: A-Pose, T-Pose, or none. |
| `imageEnhancement` | boolean | - | `true` | Optimize input images. Supported on Meshy 6 only. |
| `removeLighting` | boolean | - | `true` | Remove highlights and shadows from input images. Supported on Meshy 6 only. |
| `autoSize` | boolean | - | `false` | Estimate real-world scale for the generated model. |
| `originAt` | string | - | `bottom` | Place the model origin at the bottom or center. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_meshy-multi-image-to-3d" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "image": [
    "<asset_id>"
  ],
  "aiModel": "meshy-6",
  "shouldTexture": true,
  "enablePbr": false,
  "hdTexture": false,
  "texturePrompt": "",
  "topology": "triangle",
  "targetPolycount": 30000,
  "savePreRemeshedModel": false,
  "symmetryMode": "auto",
  "poseMode": "",
  "imageEnhancement": true,
  "removeLighting": true,
  "autoSize": false,
  "originAt": "bottom"
}
EOF
```

**Python**

```python
import requests
import base64

api_key = "<API_KEY>"
api_secret = "<API_SECRET>"
token = base64.b64encode(f"{api_key}:{api_secret}".encode()).decode()

url = "https://api.cloud.scenario.com/v1/generate/custom/model_meshy-multi-image-to-3d"
headers = {
    "Authorization": f"Basic {token}",
    "Content-Type": "application/json"
}
payload = {
    "image": [
        "<asset_id>"
    ],
    "aiModel": "meshy-6",
    "shouldTexture": True,
    "enablePbr": False,
    "hdTexture": False,
    "texturePrompt": "",
    "topology": "triangle",
    "targetPolycount": 30000,
    "savePreRemeshedModel": False,
    "symmetryMode": "auto",
    "poseMode": "",
    "imageEnhancement": True,
    "removeLighting": True,
    "autoSize": False,
    "originAt": "bottom"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

**JavaScript**

```javascript
const token = btoa("<API_KEY>:<API_SECRET>");

const body = {
  "image": [
    "<asset_id>"
  ],
  "aiModel": "meshy-6",
  "shouldTexture": true,
  "enablePbr": false,
  "hdTexture": false,
  "texturePrompt": "",
  "topology": "triangle",
  "targetPolycount": 30000,
  "savePreRemeshedModel": false,
  "symmetryMode": "auto",
  "poseMode": "",
  "imageEnhancement": true,
  "removeLighting": true,
  "autoSize": false,
  "originAt": "bottom"
};

const response = await fetch(
  "https://api.cloud.scenario.com/v1/generate/custom/model_meshy-multi-image-to-3d",
  {
    method: "POST",
    headers: {
      "Authorization": `Basic ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify(body),
  }
);

const data = await response.json();
console.info(data);
```

---

## Retrieve Results

After submitting a generation request, you receive a `jobId`. Poll the job status endpoint until the job completes.

**Endpoint:** `GET https://api.cloud.scenario.com/v1/jobs/{jobId}`

**Headers:**
```
Authorization: Basic base64("<API_KEY>:<API_SECRET>")
```

Poll until `job.status` is `"success"`. The generated asset IDs are in `job.metadata.assetIds`.

**Example response:**
```json
{
  "job": {
    "jobId": "job_abc123",
    "status": "success",
    "metadata": {
      "assetIds": [
        "asset_abc123"
      ]
    }
  }
}
```

> **Important:** Generated asset URLs are **temporary** and expire after a short period. Download and store any images you wish to keep before the URL expires. More info: [Content Delivery Network (CDN)](https://docs.scenario.com/docs/content-delivery-network-cdn).

---

*Generated by [Scenario](https://app.scenario.com)*