Skip to main content
POST
/
v1
/
upscale
Upscale or restore an image (async)
curl --request POST \
  --url https://api.rimp.io/v1/upscale \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "image_url": "<string>",
  "face_enhance": true
}
'
{
  "id": "<string>",
  "prompt": "<string>",
  "params": {},
  "reserved_credits": 123,
  "charged_credits": 123,
  "refunded_credits": 123,
  "cache_hit": true,
  "outputs": [
    {
      "id": "<string>",
      "mime": "<string>",
      "width": 123,
      "height": 123,
      "duration_s": "<string>",
      "url": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.rimp.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
model
string
required
​
image_url
string<uri>
required
​
scale_factor
enum<string>
Available options:
2,
4
​
face_enhance
boolean

Response

202 - application/json

Upscale queued. Poll /v1/generations/{id} or subscribe via webhook.

​
id
string
​
object
enum<string>
Available options:
generation
​
status
enum<string>
Available options:
queued,
running,
succeeded,
failed,
canceled
​
modality
enum<string>
Available options:
image,
video,
voice,
music,
avatar,
chat,
3d,
upscale
​
prompt
string
​
params
object
​
reserved_credits
integer
​
charged_credits
integer
​
refunded_credits
integer
​
cache_hit
boolean
​
outputs
object[]