Skip to main content
POST
Upscale an image
Use a completed image as the source. This endpoint uses SeedVR with a 4K (2160p) target. Send an empty JSON object to use the defaults:
Read result.width and result.height for the actual output dimensions. Check fine product details in the result before publishing. A successful request returns HTTP 202 with a jobs array. Save each id, then get the job until it finishes. Read the completed media from result.url and its reusable ID from result.id. Use an Idempotency-Key when submitting work that may be retried.

Authorizations

Authorization
string
header
required

Create an API key in Studio → account menu → API Keys. Keep it on your server.

Headers

Idempotency-Key
string

Use a unique key for each intended creation. Retry the same method, path and JSON with the same key to replay its response for 24 hours after completion. Conflicting requests and unfinished or uncertain outcomes return 409. An uncertain receipt is never automatically rerun.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Path Parameters

id
string<uuid>
required

Source resource ID.

Body

application/json
target_resolution
enum<string>
default:4k

Output target. Defaults to 4K (2160p) using SeedVR. Read result.width and result.height for the actual dimensions.

Available options:
4k

Response

Accepted; poll each job.

jobs
object[]
required
Minimum array length: 1