# Meshy Text-to-3D — API Reference

Model ID: `model_meshy-txt23d`

---

## 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-txt23d`

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `aiModel` | string | - | `latest` | Meshy model to use. |
| `prompt` | string | yes | - | Describe the object you want to generate as a 3D model. |
| `texturePrompt` | string | - | `` | Provide a text description to guide the texturing process. The Style Prompt is only used when no Style Image is provided. If you upload an image, this text prompt will be ignored. |
| `artStyle` | string | - | `realistic` | Describe your desired art style of the object. Note that 'Enable PBR'' should be set to false when using Art style. |
| `topology` | string | - | `triangle` | Choose the mesh structure type used for the generated model (e.g., triangles or quads). |
| `enablePbr` | boolean | - | `true` | Generate advanced PBR maps (metallic, roughness, normal) for more realistic materials. |
| `poseMode` | string | - | `` | Specify the pose mode for the generated model. Accepts 'a-pose', 't-pose', or empty string (default). |
| `shouldRemesh` | boolean | - | `false` | Enable remeshing to improve mesh quality and control polycount. Disable to keep the raw, unprocessed mesh. |
| `symmetryMode` | string | - | `auto` | Control how symmetry is applied during model generation for balanced, even shapes. |
| `targetPolycount` | number | - | `30000` | Specify the target number of polygons in the generated model. The actual number of polygons may deviate from the target depending on the complexity of the geometry. |
| `seed` | number | - | - | Seed for random number generator. If None, a random seed will be used. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_meshy-txt23d" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "aiModel": "latest",
  "prompt": "A fantasy landscape",
  "texturePrompt": "",
  "artStyle": "realistic",
  "topology": "triangle",
  "enablePbr": true,
  "poseMode": "",
  "shouldRemesh": false,
  "symmetryMode": "auto",
  "targetPolycount": 30000
}
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-txt23d"
headers = {
    "Authorization": f"Basic {token}",
    "Content-Type": "application/json"
}
payload = {
    "aiModel": "latest",
    "prompt": "A fantasy landscape",
    "texturePrompt": "",
    "artStyle": "realistic",
    "topology": "triangle",
    "enablePbr": True,
    "poseMode": "",
    "shouldRemesh": False,
    "symmetryMode": "auto",
    "targetPolycount": 30000
}

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

**JavaScript**

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

const body = {
  "aiModel": "latest",
  "prompt": "A fantasy landscape",
  "texturePrompt": "",
  "artStyle": "realistic",
  "topology": "triangle",
  "enablePbr": true,
  "poseMode": "",
  "shouldRemesh": false,
  "symmetryMode": "auto",
  "targetPolycount": 30000
};

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

const data = await response.json();
console.log(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)*