# Pixal3D — API Reference

Model ID: `model_pixal3d`

---

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

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `image` | assetId | yes | - | Input image to convert into a 3D model. |
| `ssGuidanceStrength` | number | - | `7.5` | How closely the initial 3D structure follows the input image. Higher values are more faithful but may introduce noise. |
| `ssGuidanceRescale` | number | - | `0.7` | Dampens artifacts from high guidance in the structure stage. |
| `ssSamplingSteps` | number | - | `36` | Number of denoising steps for initial structure generation. |
| `shapeSlatGuidanceStrength` | number | - | `7.5` | How closely the detailed geometry follows the input image. Higher values add more detail but may introduce noise. |
| `shapeSlatGuidanceRescale` | number | - | `0.5` | Dampens artifacts from high guidance in the shape stage. |
| `shapeSlatSamplingSteps` | number | - | `36` | Number of denoising steps for shape refinement. |
| `shapeSlatRescaleT` | number | - | `3` | Controls noise schedule sharpness for shape refinement. |
| `texSlatGuidanceStrength` | number | - | `1` | How closely the texture follows the input image colors. Higher values are more vivid but may oversaturate textures. |
| `texSlatGuidanceRescale` | number | - | `0` | Dampens artifacts from high guidance in the texture stage. |
| `texSlatSamplingSteps` | number | - | `36` | Number of denoising steps for texture generation. |
| `texSlatRescaleT` | number | - | `3` | Controls noise schedule sharpness for texture generation. |
| `meshScale` | number | - | `1` | Scale factor applied to the inferred mesh. |
| `maxNumTokens` | number | - | `49152` | Maximum number of high-resolution tokens used by the shape sampler. Higher values allow finer geometry. |
| `decimationTarget` | number | - | `200000` | Target number of vertices in the final mesh. Lower values produce smaller files but less detail. |
| `generationResolution` | number | - | `1536` | Internal geometry resolution for generation. |
| `resolution` | number | - | `4096` | Texture resolution for the generated 3D model. |
| `remesh` | boolean | - | `true` | Rebuild the mesh topology for cleaner triangles. |
| `seed` | number | - | - | Random seed for reproducible results. Leave blank to use a random seed. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_pixal3d" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "image": "<asset_id>",
  "ssGuidanceStrength": 7.5,
  "ssGuidanceRescale": 0.7,
  "ssSamplingSteps": 36,
  "shapeSlatGuidanceStrength": 7.5,
  "shapeSlatGuidanceRescale": 0.5,
  "shapeSlatSamplingSteps": 36,
  "shapeSlatRescaleT": 3,
  "texSlatGuidanceStrength": 1,
  "texSlatGuidanceRescale": 0,
  "texSlatSamplingSteps": 36,
  "texSlatRescaleT": 3,
  "meshScale": 1,
  "maxNumTokens": 49152,
  "decimationTarget": 200000,
  "generationResolution": 1536,
  "resolution": 4096,
  "remesh": true
}
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 = {
    "image": "<asset_id>",
    "ssGuidanceStrength": 7.5,
    "ssGuidanceRescale": 0.7,
    "ssSamplingSteps": 36,
    "shapeSlatGuidanceStrength": 7.5,
    "shapeSlatGuidanceRescale": 0.5,
    "shapeSlatSamplingSteps": 36,
    "shapeSlatRescaleT": 3,
    "texSlatGuidanceStrength": 1,
    "texSlatGuidanceRescale": 0,
    "texSlatSamplingSteps": 36,
    "texSlatRescaleT": 3,
    "meshScale": 1,
    "maxNumTokens": 49152,
    "decimationTarget": 200000,
    "generationResolution": 1536,
    "resolution": 4096,
    "remesh": True
}

response = client.generate.run_model(
    model_id="model_pixal3d",
    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 = {
  "image": "<asset_id>",
  "ssGuidanceStrength": 7.5,
  "ssGuidanceRescale": 0.7,
  "ssSamplingSteps": 36,
  "shapeSlatGuidanceStrength": 7.5,
  "shapeSlatGuidanceRescale": 0.5,
  "shapeSlatSamplingSteps": 36,
  "shapeSlatRescaleT": 3,
  "texSlatGuidanceStrength": 1,
  "texSlatGuidanceRescale": 0,
  "texSlatSamplingSteps": 36,
  "texSlatRescaleT": 3,
  "meshScale": 1,
  "maxNumTokens": 49152,
  "decimationTarget": 200000,
  "generationResolution": 1536,
  "resolution": 4096,
  "remesh": true
};

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