# Rodin Gen-2.5 — API Reference

Model ID: `model_rodin-hyper3d-v2-5`

---

## Authentication

- **API_KEY** and **API_SECRET** are found in your [Scenario Project Settings](https://app.scenario.com/team&tab=project_api_keys) under API Keys.
- Set them as environment variables `SCENARIO_SDK_API_KEY` and `SCENARIO_SDK_API_SECRET` — both SDKs pick them up by default.
- For raw HTTP (cURL), use Basic Auth: `Authorization: Basic base64("<API_KEY>:<API_SECRET>")`.

### Install the SDK

- JavaScript / TypeScript: `npm install @scenario-labs/sdk`
- Python: `pip install scenario-sdk`

---

## Generate

**Endpoint:** `POST https://api.cloud.scenario.com/v1/generate/custom/model_rodin-hyper3d-v2-5`

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `images` | assetId[] | yes | - | Images to use while generating the 3D model. Up to 5 images are supported. |
| `prompt` | string | - | `` | Optional text prompt to guide model generation. If empty, Rodin auto-generates a prompt from the images. |
| `tier` | string | - | `Gen-2.5-Medium` | Generation tier. Higher tiers produce more detailed meshes; Extreme High bills at double the base rate. |
| `addons` | string | - | `` | Possible values are HighPack. HighPack provides 4K resolution textures and high-poly geometry, instead of default 2K. If in Quality Mesh Option, Quad is selected, the number of faces will be ~16 times of the number of faces selected in the quality part. |
| `qualityMeshOption` | string | - | `500K Triangle` | Combined quality and mesh type selection. |
| `material` | string | - | `All` | Material type for the generated model. |
| `geometryInstructMode` | string | - | `faithful` | Faithful mode follows the input closely; creative mode permits more variation. |
| `textureMode` | string | - | `` | Texture generation quality. Leave blank to let the model pick the tier-appropriate default. |
| `isSymmetric` | string | - | `unknown` | Symmetry mode for the generated mesh. |
| `hdTexture` | boolean | - | `false` | Enable enhanced texture post-processing for higher visual fidelity. |
| `textureDelight` | boolean | - | `false` | Remove baked lighting and highlights from generated textures. |
| `isMicro` | boolean | - | `false` | Generate finer micro-scale geometric detail. Only effective with Extreme High tier. |
| `useOriginalAlpha` | boolean | - | `false` | Preserve the transparency channel from input images during 3D generation. |
| `previewRender` | boolean | - | `false` | Generate a preview render image along with the model files. |
| `TAPose` | boolean | - | `false` | Generate characters in T-pose or A-pose format for easier rigging and animation. |
| `seed` | number | - | - | Seed value for randomization. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_rodin-hyper3d-v2-5" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "images": [
    "<asset_id>"
  ],
  "prompt": "",
  "tier": "Gen-2.5-Medium",
  "addons": "",
  "qualityMeshOption": "500K Triangle",
  "material": "All",
  "geometryInstructMode": "faithful",
  "textureMode": "",
  "isSymmetric": "unknown",
  "hdTexture": false,
  "textureDelight": false,
  "isMicro": false,
  "useOriginalAlpha": false,
  "previewRender": false,
  "TAPose": false
}
EOF
```

**Python**

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),
)

body = {
    "images": [
        "<asset_id>"
    ],
    "prompt": "",
    "tier": "Gen-2.5-Medium",
    "addons": "",
    "qualityMeshOption": "500K Triangle",
    "material": "All",
    "geometryInstructMode": "faithful",
    "textureMode": "",
    "isSymmetric": "unknown",
    "hdTexture": False,
    "textureDelight": False,
    "isMicro": False,
    "useOriginalAlpha": False,
    "previewRender": False,
    "TAPose": False
}

response = client.generate.run_model(
    model_id="model_rodin-hyper3d-v2-5",
    body=body,
)
print(response)
```

**JavaScript**

```javascript
import Scenario from "@scenario-labs/sdk";

const client = new Scenario({
  apiKey: process.env["SCENARIO_SDK_API_KEY"],
  apiSecret: process.env["SCENARIO_SDK_API_SECRET"],
});

const body = {
  "images": [
    "<asset_id>"
  ],
  "prompt": "",
  "tier": "Gen-2.5-Medium",
  "addons": "",
  "qualityMeshOption": "500K Triangle",
  "material": "All",
  "geometryInstructMode": "faithful",
  "textureMode": "",
  "isSymmetric": "unknown",
  "hdTexture": false,
  "textureDelight": false,
  "isMicro": false,
  "useOriginalAlpha": false,
  "previewRender": false,
  "TAPose": false
};

const response = await client.generate.runModel("model_rodin-hyper3d-v2-5", { body });
console.info(response);
```

---

## Retrieve Results

After submitting a generation request, you receive a `jobId`. Poll the job until `job.status` is `"success"`. The generated asset IDs are in `job.metadata.assetIds`.

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

### Example Requests

**cURL**

```bash
curl -X GET "https://api.cloud.scenario.com/v1/jobs/<JOB_ID>" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)"
```

**Python**

```python
job = client.jobs.retrieve(job_id="<JOB_ID>")
print(job.status)
print(job.metadata.asset_ids)
```

**JavaScript**

```javascript
// Option 1 — wait on the response from runModel using the SDK helper
const completed = await response.job.wait();
console.info(completed.status);
console.info(completed.metadata?.assetIds);

// Option 2 — retrieve a job by its ID
const job = await client.jobs.retrieve("<JOB_ID>");
console.info(job.status);
console.info(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/get-started/documentation/content-delivery-network-cdn).

---

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