# Rodin Gen-1 — API Reference

Model ID: `model_rodin-hyper3d`

---

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

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | - | - | A textual prompt to guide model generation. Required for Text-to-3D mode. Optional for Image-to-3D mode. |
| `images` | assetId[] | - | - | Images to use while generating the 3D model. Required for Image-to-3D mode. Optional for Text-to-3D mode. |
| `conditionMode` | string | - | `concat` | For fuse mode, One or more images are required. It will generate a model by extracting and fusing features of objects from multiple images. For concat mode, need to upload multiple multi-view images of the same object and generate the model.(You can upload multi-view images in any order, regardless of the order of view.) Default value: 'concat' |
| `material` | string | - | `PBR` | Material type. Possible values: PBR, Shaded. |
| `quality` | string | - | `high` | Generation quality. |
| `useHyper` | boolean | - | `false` | Whether to export the model using hyper mode. |
| `tier` | string | - | `Regular` | Tier of generation. For Rodin Sketch, set to Sketch. For Rodin Regular, set to Regular. |
| `TAPose` | boolean | - | `false` | When generating the human-like model, this parameter control the generation result to T/A Pose. |
| `seed` | number | - | - | Seed value for randomization, leave blank to use a random seed |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_rodin-hyper3d" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "conditionMode": "concat",
  "material": "PBR",
  "quality": "high",
  "useHyper": false,
  "tier": "Regular",
  "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 = {
    "conditionMode": "concat",
    "material": "PBR",
    "quality": "high",
    "useHyper": False,
    "tier": "Regular",
    "TAPose": False
}

response = client.generate.run_model(
    model_id="model_rodin-hyper3d",
    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 = {
  "conditionMode": "concat",
  "material": "PBR",
  "quality": "high",
  "useHyper": false,
  "tier": "Regular",
  "TAPose": false
};

const response = await client.generate.runModel("model_rodin-hyper3d", { 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)*