# VTracer — API Reference

Model ID: `model_visioncortex-vtracer`

---

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

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `presetName` | string | - | `poster` | Preset configuration. When using a preset, custom parameters are ignored. |
| `colorMode` | string | - | `color` | Color mode: 'color' or 'binary'. Only used with preset is Custom. |
| `colorPrecision` | number | - | `6` | Number of significant bits for RGB channels (1-8). Higher values preserve more color detail. Phoenix param: colorPrecision. Only used with preset is Custom. |
| `layerDifference` | number | - | `16` | Color difference between gradient layers (0-255). Phoenix param: layerDifference. Only used with preset is Custom. |
| `hierarchical` | string | - | `stacked` | Hierarchical clustering mode: 'stacked' or 'cutout'. Only used with preset is Custom. |
| `mode` | string | - | `spline` | Curve fitting mode: 'spline' (smooth curves), 'polygon' (straight lines), 'pixel' (pixelated), or 'none'. Only used with preset='custom'. |
| `filterSpeckle` | number | - | `4` | Discard patches smaller than X pixels. Only used with preset is Custom. |
| `cornerThreshold` | number | - | `60` | Minimum angle (degrees) to be considered a corner (0-180). Only used with preset is Custom. |
| `lengthThreshold` | number | - | `4` | Maximum segment length for curve smoothing (3.5-10). Only used with preset is Custom. |
| `spliceThreshold` | number | - | `45` | Minimum angle displacement for splines (0-180 degrees). Only used with preset is Custom. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_visioncortex-vtracer" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "presetName": "poster",
  "colorMode": "color",
  "colorPrecision": 6,
  "layerDifference": 16,
  "hierarchical": "stacked",
  "mode": "spline",
  "filterSpeckle": 4,
  "cornerThreshold": 60,
  "lengthThreshold": 4,
  "spliceThreshold": 45
}
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_visioncortex-vtracer"
headers = {
    "Authorization": f"Basic {token}",
    "Content-Type": "application/json"
}
payload = {
    "presetName": "poster",
    "colorMode": "color",
    "colorPrecision": 6,
    "layerDifference": 16,
    "hierarchical": "stacked",
    "mode": "spline",
    "filterSpeckle": 4,
    "cornerThreshold": 60,
    "lengthThreshold": 4,
    "spliceThreshold": 45
}

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

**JavaScript**

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

const body = {
  "presetName": "poster",
  "colorMode": "color",
  "colorPrecision": 6,
  "layerDifference": 16,
  "hierarchical": "stacked",
  "mode": "spline",
  "filterSpeckle": 4,
  "cornerThreshold": 60,
  "lengthThreshold": 4,
  "spliceThreshold": 45
};

const response = await fetch(
  "https://api.cloud.scenario.com/v1/generate/custom/model_visioncortex-vtracer",
  {
    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)*