# VecGlypher — API Reference

Model ID: `model_vecglypher`

---

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

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | yes | - | The target text to generate as vector glyphs. |
| `styleDescription` | string | - | `italic style, 400 weight, serif, text, elegant` | Typography style guidance such as weight, style, and category. |
| `outputSize` | number | - | `512` | Maximum output dimension in pixels while preserving aspect ratio. |
| `fillColor` | string | - | `black` | SVG/CSS fill color for generated glyphs. |
| `strokeColor` | string | - | - | Optional outline color for generated glyph paths. |
| `strokeWidth` | number | - | `1` | Outline width in SVG units when a stroke color is set. |
| `temperature` | number | - | `0.1` | Sampling temperature. |
| `topP` | number | - | `0.95` | Top-p (nucleus) sampling parameter. |
| `topK` | number | - | `5` | Top-k sampling parameter. |
| `repetitionPenalty` | number | - | `1` | Penalty to reduce repeated SVG path segments. |
| `maxTokens` | number | - | `8192` | Maximum number of tokens to generate. |
| `seed` | number | - | - | Random seed for reproducibility. |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_vecglypher" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "prompt": "A fantasy landscape",
  "styleDescription": "italic style, 400 weight, serif, text, elegant",
  "outputSize": 512,
  "fillColor": "black",
  "strokeWidth": 1,
  "temperature": 0.1,
  "topP": 0.95,
  "topK": 5,
  "repetitionPenalty": 1,
  "maxTokens": 8192
}
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_vecglypher"
headers = {
    "Authorization": f"Basic {token}",
    "Content-Type": "application/json"
}
payload = {
    "prompt": "A fantasy landscape",
    "styleDescription": "italic style, 400 weight, serif, text, elegant",
    "outputSize": 512,
    "fillColor": "black",
    "strokeWidth": 1,
    "temperature": 0.1,
    "topP": 0.95,
    "topK": 5,
    "repetitionPenalty": 1,
    "maxTokens": 8192
}

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

**JavaScript**

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

const body = {
  "prompt": "A fantasy landscape",
  "styleDescription": "italic style, 400 weight, serif, text, elegant",
  "outputSize": 512,
  "fillColor": "black",
  "strokeWidth": 1,
  "temperature": 0.1,
  "topP": 0.95,
  "topK": 5,
  "repetitionPenalty": 1,
  "maxTokens": 8192
};

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