# Tripo 3.0 — API Reference

Model ID: `model_tripo-v3-0-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_tripo-v3-0-image-to-3d`

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `texture` | boolean | - | `true` | Enable texturing. Set to false for a model without textures. |
| `textureQuality` | string | - | `standard` | Texture quality level. 'Detailed' gives HD quality textures. |
| `textureAlignment` | string | - | `original_image` | Determines the prioritization of texture alignment in the 3D model. |
| `geometryQuality` | string | - | `standard` | Geometry quality level. 'Detailed' gives HD quality geometry. |
| `textureSeed` | number | - | - | Random seed for texture generation. Using the same seed will produce identical textures. |
| `orientation` | string | - | `default` | Set orientation to 'Align Image' will automatically rotate the model to align the original image. |
| `pbr` | boolean | - | `true` | Enable PBR generation. Default value is True. If this option is set to True, texture parameters will be ignored. |
| `faceLimit` | number | - | - | Limits the number of faces on the output model. If this option is not set, the face limit will be adaptively determined. |
| `autoSize` | boolean | - | `false` | Automatically scale the model to real-world dimensions, with the unit in meters. |
| `quad` | boolean | - | `false` | Set True to enable quad mesh output. |
| `smartLowPoly` | boolean | - | `false` | Generate hand-crafted low-poly topology. |
| `generateParts` | boolean | - | `false` | Generate segmented 3D model parts. Incompatible with texture, pbr, and quad. |
| `seed` | number | - | - | Random seed for model generation. The seed controls the geometry generation process, ensuring identical models when the same seed is used. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_tripo-v3-0-image-to-3d" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "texture": true,
  "textureQuality": "standard",
  "textureAlignment": "original_image",
  "geometryQuality": "standard",
  "orientation": "default",
  "pbr": true,
  "autoSize": false,
  "quad": false,
  "smartLowPoly": false,
  "generateParts": false
}
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_tripo-v3-0-image-to-3d"
headers = {
    "Authorization": f"Basic {token}",
    "Content-Type": "application/json"
}
payload = {
    "texture": True,
    "textureQuality": "standard",
    "textureAlignment": "original_image",
    "geometryQuality": "standard",
    "orientation": "default",
    "pbr": True,
    "autoSize": False,
    "quad": False,
    "smartLowPoly": False,
    "generateParts": False
}

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

**JavaScript**

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

const body = {
  "texture": true,
  "textureQuality": "standard",
  "textureAlignment": "original_image",
  "geometryQuality": "standard",
  "orientation": "default",
  "pbr": true,
  "autoSize": false,
  "quad": false,
  "smartLowPoly": false,
  "generateParts": false
};

const response = await fetch(
  "https://api.cloud.scenario.com/v1/generate/custom/model_tripo-v3-0-image-to-3d",
  {
    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)*