# PATINA Material — API Reference

Model ID: `model_patina-material`

---

## Authentication

- **API_KEY** and **API_SECRET** are found in your [Scenario Project Settings](https://app.scenario.com/team&tab=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_patina-material`

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | yes | - | Text description of the material to generate, for example weathered copper patina or mossy stone wall. |
| `image` | assetId | - | - | An optional starting texture. Without a mask, PATINA creates variations. With a mask, it inpaints the marked region. |
| `imageStrength` | number | - | `0.6` | How much to transform the input image. Higher values change it more. Only used when an image is provided. |
| `mask` | assetId | - | - | A black-and-white mask for inpainting. White regions are regenerated, black regions are preserved. Requires an input image. |
| `width` | number | - | `1024` | Output width in pixels. Upscaling applies to PBR maps only, not the base texture. |
| `height` | number | - | `1024` | Output height in pixels. Upscaling applies to PBR maps only, not the base texture. |
| `maps` | string[] | - | `basecolor,normal,roughness,metalness,height` | Which PBR maps to predict. Deselect all to skip PBR estimation and only generate the texture. |
| `upscaleFactor` | number | - | `0` | Seamless upscale for predicted PBR maps. 0 keeps map resolution, 2 doubles it, 4 quadruples it (up to 8K from a 2048 texture). The base texture is not upscaled. |
| `tilingMode` | string | - | `both` | Which directions the material repeats seamlessly. Both repeats in every direction; Horizontal repeats left-to-right; Vertical repeats top-to-bottom. |
| `numOutputs` | number | - | `1` | Number of texture images to generate from the same prompt. |
| `numInferenceSteps` | number | - | `8` | Number of denoising steps for texture generation. Higher values take longer. |
| `enablePromptExpansion` | boolean | - | `true` | Expand the prompt with an LLM for richer material detail. |
| `tileSize` | number | - | `128` | Seamless-tiling window in latent space. 64 ≈ 512px, 128 ≈ 1024px, 256 ≈ 2048px. Match this to the output resolution for cleaner repeats. |
| `tileStride` | number | - | `64` | How far the tiling window steps between passes. Smaller than tile size adds overlap and usually smoother seams; larger is faster but can show a grid. |
| `seed` | number | - | - | A number that makes results repeatable. Reusing the same seed and settings produces the same material; leave it empty for a different result each time. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_patina-material" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "prompt": "A fantasy landscape",
  "imageStrength": 0.6,
  "width": 1024,
  "height": 1024,
  "maps": [
    "basecolor",
    "normal",
    "roughness",
    "metalness",
    "height"
  ],
  "upscaleFactor": 0,
  "tilingMode": "both",
  "numOutputs": 1,
  "numInferenceSteps": 8,
  "enablePromptExpansion": true,
  "tileSize": 128,
  "tileStride": 64
}
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 = {
    "prompt": "A fantasy landscape",
    "imageStrength": 0.6,
    "width": 1024,
    "height": 1024,
    "maps": [
        "basecolor",
        "normal",
        "roughness",
        "metalness",
        "height"
    ],
    "upscaleFactor": 0,
    "tilingMode": "both",
    "numOutputs": 1,
    "numInferenceSteps": 8,
    "enablePromptExpansion": True,
    "tileSize": 128,
    "tileStride": 64
}

response = client.generate.run_model(
    model_id="model_patina-material",
    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 = {
  "prompt": "A fantasy landscape",
  "imageStrength": 0.6,
  "width": 1024,
  "height": 1024,
  "maps": [
    "basecolor",
    "normal",
    "roughness",
    "metalness",
    "height"
  ],
  "upscaleFactor": 0,
  "tilingMode": "both",
  "numOutputs": 1,
  "numInferenceSteps": 8,
  "enablePromptExpansion": true,
  "tileSize": 128,
  "tileStride": 64
};

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