# Ideogram Character — API Reference

Model ID: `model_ideogram-character`

---

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

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | yes | - | Text prompt for image generation |
| `renderingSpeed` | string | - | `Default` | Turbo for faster and cheaper generation, quality for higher quality and more expensive generation, default for balanced. |
| `characterReferenceImage` | assetId | yes | - | An image to use as a character reference. |
| `styleType` | string | - | `Auto` | The character style type. Auto, Fiction, or Realistic. |
| `aspectRatio` | string | - | `4:3` | Aspect ratio. Ignored if a resolution or inpainting image is given. |
| `resolution` | string | - | `None` | Resolution. Overrides aspect ratio. Ignored if an inpainting image is given. |
| `image` | assetId | - | - | An image file to use for inpainting. You must also use a mask. |
| `mask` | assetId | - | - | A black and white image. Black pixels are inpainted, white pixels are preserved. The mask will be resized to match the image size. |
| `seed` | number | - | - | Use a 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_ideogram-character" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "prompt": "A fantasy landscape",
  "renderingSpeed": "Default",
  "characterReferenceImage": "<asset_id>",
  "styleType": "Auto",
  "aspectRatio": "4:3",
  "resolution": "None"
}
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",
    "renderingSpeed": "Default",
    "characterReferenceImage": "<asset_id>",
    "styleType": "Auto",
    "aspectRatio": "4:3",
    "resolution": "None"
}

response = client.generate.run_model(
    model_id="model_ideogram-character",
    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",
  "renderingSpeed": "Default",
  "characterReferenceImage": "<asset_id>",
  "styleType": "Auto",
  "aspectRatio": "4:3",
  "resolution": "None"
};

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