Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
input
object
required

Model-specific input, forwarded to fal verbatim. image_url is required.

model
string

A quality tier (fast, balanced, quality) or any fal.ai upscaling endpoint id. Prefer a tier — it tracks the best current model for that price point. Defaults to fal-ai/topaz/upscale/image.

Examples:

"fast"

"balanced"

"quality"

"fal-ai/seedvr/upscale/image"

"fal-ai/topaz/upscale/image"

"topaz/upscale/image/generative"

Response

Upscale job queued

id
string
required
object
string
required
type
string
required
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed,
cancelled
model
string
required
progress
integer
required
input
object
required
result
object | null
required
error
string | null
required
error_code
string | null
required
credits_used
integer | null
required
provider_request_id
string | null
required
created_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required