Image Upscale
Enlarge and enhance existing images — realistic or creative.
The image upscale endpoint takes an existing image and returns a higher-resolution copy. Pick the model based on the content: Topaz Image Upscale preserves detail for realistic photos, while Clarity Upscaler invents detail with an optional steering prompt for AI art and illustration.
It lives on a dedicated route alongside image generation, with its own request shape and pricing.
| Endpoint | Description |
|---|---|
POST /v2/images/upscale | Enlarge and enhance an image (Topaz or Clarity). |
Like generation, this endpoint returns immediately with a jobId, deducts credits at submission, and emits the same webhook events. Refunds on failure work the same way.
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
model | string | Yes | Model identifier — "topaz-image-upscale" or "clarity-upscale". |
<modelParams> | object | Yes | Per-model params object — topazUpscaleParams or clarityUpscaleParams. Always carries the source image URL plus model-specific knobs; see each model's page. |
webhookUrl | string | No | URL to receive webhook notifications. |
webhookEvents | string[] | No | Events to subscribe to: "progress", "completed", "failed". |
Idempotency
Include an Idempotency-Key header to prevent duplicate jobs if the same request is sent twice.
Response
Status: 202 Accepted
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "QUEUED"
}Poll GET /v2/jobs/:id — the completed job carries an images array on result (single entry) hosted on the Apiframe CDN with the standard 90-day retention.
Available models
| Model | Identifier | Description |
|---|---|---|
| Topaz Image Upscale | "topaz-image-upscale" | Photo and forensic upscaler — best for realistic content. |
| Clarity Upscaler | "clarity-upscale" | Creative "hi-res fix" — invents detail with a steering prompt. |
Error responses
| Status | Error | Meaning |
|---|---|---|
400 | Validation error | Invalid parameters — check details. |
401 | Unauthorized | Missing or invalid API key. |
402 | Insufficient credits | Not enough credits to run this model. |
503 | Service unavailable | Job queue is temporarily down. |