# Ideogram Character API Documentation

> LLM-optimized documentation for Ideogram Character. Copy into your AI assistant for integration help.

## Overview

**Model ID:** `ideogram-character`
**Type:** Image Generation
**Credit Cost:** 5 credits per image

Generate consistent characters from a single reference image in many styles.

## Endpoint

```
POST https://pixeldojo.ai/api/v1/models/ideogram-character/run
```

## Authentication

All requests require an API key in the Authorization header:

```
Authorization: Bearer YOUR_API_KEY
```

Get your API key: https://pixeldojo.ai/api-platform/api-keys

## Input Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | Yes | - | Text instruction describing what to generate or edit. |
| `character_reference_image` | url | Yes | - | Reference image of the character to preserve across generations. |
| `rendering_speed` | enum | No | Default | Speed / quality tradeoff. "Turbo" is fastest; "Quality" is slowest but highest fidelity. (Options: Turbo, Default, Quality) |
| `style_type` | enum | No | - | Style preset. (Options: Auto, Fiction, Realistic) |
| `aspect_ratio` | enum | No | - | Output aspect ratio. (Options: 1:1, 16:9, 9:16, 4:3, 3:4...) |
| `resolution` | enum | No | - | Output resolution. (Options: None, 1024x1024, 1152x864, 864x1152, 1248x832...) |
| `magic_prompt_option` | enum | No | - | Magic-prompt rewriting. "Auto" lets the model decide, "On" always rewrites for richer detail, "Off" sends the prompt verbatim. (Options: Auto, On, Off) |
| `seed` | number | No | - | Random seed for reproducibility. Same seed + inputs yields similar results. |
| `numberOfImages` | integer | No | 1 | Number of output images. (min: 1, max: 4) |



## Capabilities

- Image to Image

## Quick Start

### 1. Submit a Job

```bash
curl -X POST "https://pixeldojo.ai/api/v1/models/ideogram-character/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "same character in medieval armor",
    "character_reference_image": "https://...",
    "rendering_speed": "Default"
  }'
```

**Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123",
  "creditCost": 5,
  "creditsRemaining": 95
}
```

### 2. Poll for Results

```bash
curl "https://pixeldojo.ai/api/v1/jobs/job_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

**Completed Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "completed",
  "output": {
    "images": ["https://temp.pixeldojo.ai/..."]
  },
  "creditCost": 5
}
```

## Python Example

```python
import requests
import time

API_KEY = "YOUR_API_KEY"

# Submit job
response = requests.post(
    "https://pixeldojo.ai/api/v1/models/ideogram-character/run",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "prompt": "same character in medieval armor",
        "character_reference_image": "https://...",
        "rendering_speed": "Default"
    }
)

job = response.json()
job_id = job["jobId"]

# Poll for completion
while True:
    status_response = requests.get(
        f"https://pixeldojo.ai/api/v1/jobs/{'{job_id}'}",
        headers={"Authorization": f"Bearer {API_KEY}"}
    )
    status = status_response.json()
    
    if status["status"] == "completed":
        print("Output:", status["output"])
        break
    elif status["status"] == "failed":
        print("Error:", status.get("error"))
        break
    
    time.sleep(2)
```

## JavaScript Example

```javascript
const API_KEY = 'YOUR_API_KEY';

// Submit job
const submitResponse = await fetch('https://pixeldojo.ai/api/v1/models/ideogram-character/run', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "prompt": "same character in medieval armor",
    "character_reference_image": "https://...",
    "rendering_speed": "Default"
  })
});

const job = await submitResponse.json();

// Poll for completion
const pollForResult = async (jobId) => {
  while (true) {
    const statusResponse = await fetch(`https://pixeldojo.ai/api/v1/jobs/${jobId}`, {
      headers: { 'Authorization': `Bearer ${API_KEY}` }
    });
    const status = await statusResponse.json();
    
    if (status.status === 'completed') return status.output;
    if (status.status === 'failed') throw new Error(status.error);
    
    await new Promise(r => setTimeout(r, 2000));
  }
};

const output = await pollForResult(job.jobId);
console.log('Output:', output);
```

## Error Codes

| Code | Status | Description |
|------|--------|-------------|
| `unauthorized` | 401 | Invalid or missing API key |
| `insufficient_credits` | 402 | Not enough credits |
| `invalid_request` | 400 | Invalid parameters |
| `model_not_found` | 404 | Model ID not found |
| `rate_limited` | 429 | Too many requests |
| `internal_error` | 500 | Server error |

## Links

- **Full Documentation:** https://pixeldojo.ai/api-platform/ideogram-character
- **API Keys:** https://pixeldojo.ai/api-platform/api-keys
- **Buy Credits:** https://pixeldojo.ai/api-platform/buy-credits
- **All Models:** https://pixeldojo.ai/api/v1/models
- **OpenAPI Spec:** https://pixeldojo.ai/api/openapi