# Topaz Image Upscale API

> Topaz Image Upscale — fast, high-fidelity AI image generation & editing.

- **Provider**: Topaz
- **Model id**: `topaz-image-upscale`
- **Modality**: image
- **Price**: 6.68–13.35 credits

## Overview

Topaz Image Upscale is called in two steps: create a generation task, then poll the task until the result is ready.

## Authentication

All requests require a Bearer Token in the request header:

```
Authorization: Bearer YOUR_API_KEY
```

## Create Task

`POST https://you.bot/api/v1/generate`

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| modelId | string | Yes | Model id: `topaz-image-upscale` |
| input | object | Yes | Input parameters object (see below) |
| callbackUrl | string | No | https URL we POST the finished task to. Signed with `X-Webhook-Signature` once you create a webhook signing key in Dashboard → Settings |

### input object parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| image_url | string | Yes | Url of the image to be upscaled.The longest side of the uploaded image resolution × upscale_factor cannot exceed 20,000 pixels. (image URL) |
| upscale_factor | string | Yes | The uploaded image's longest side x this factor must stay under 20,000 pixels. (options: 1 \| 2 \| 4) (default: 2) |
| nsfw_checker | boolean | No | A configurable parameter. Defaults to true in the Playground. (true/false) (default: true) |

### Request example

```json
{
  "modelId": "topaz-image-upscale",
  "input": {
    "image_url": "https://you.bot/examples/grok-imagine-text-to-image.jpg",
    "upscale_factor": "2",
    "nsfw_checker": true
  }
}
```

### Response example

```json
{
  "taskId": "281e5b0…f39b9",
  "creditsCharged": 6.68
}
```

## Query Task

`GET https://you.bot/api/v1/task/{taskId}?model=topaz-image-upscale`

When `state` is `success`, the output is in `resultUrls`: `{ "state": "success", "resultUrls": [ ... ] }`. (Text models return inline in the create response.)

## Error Codes

| Code | Description |
|------|-------------|
| 200 | Request successful |
| 400 | Invalid request parameters |
| 401 | Authentication failed — check API Key |
| 402 | Insufficient account balance |
| 403 | IP not allowed for this key, or the key is restricted to other models |
| 404 | Task not found, or it has expired |
| 409 | Duplicate request — an identical submit arrived moments ago. Nothing was charged; retry is safe |
| 413 | Payload too large — see the character and file-size limits for this model |
| 429 | Rate limit exceeded — retry after the Retry-After header |
| 500 | Internal server error |
| 504 | Upstream timed out — nothing was delivered; retry is safe |