import requests

generation_id = "e52772ac75b..."

response = requests.request(
    "GET",
    f"https://api.stability.ai/v2beta/stable-image/upscale/creative/result/{generation_id}",
    headers={
        'accept': "image/*",  # Use 'application/json' to receive base64 encoded JSON
        'authorization': f"Bearer sk-MYAPIKEY"
    },
)

if response.status_code == 202:
    print("Generation in-progress, try again in 10 seconds.")
elif response.status_code == 200:
    print("Generation complete!")
    with open("upscaled.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))

"The bytes of the generated jpeg"

{
  "id": "a6dc6c6e20acda010fe14d71f180658f2896ed9b4ec25aa99a6ff06c796987c4",
  "status": "in-progress"
}

{
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "bad_request",
  "errors": [
    "some-field: is required"
  ]
}

{
  "id": "2bca35116bc5431d6dc4b4ea2ef3da2f",
  "name": "generation_not_found",
  "errors": [
    "id: the generation either does not exist or has expired."
  ]
}

{
  "id": "2a1b2d4eafe2bc6ab4cd4d5c6133f513",
  "name": "internal_error",
  "errors": [
    "An unexpected server error has occurred, please try again later."
  ]
}

API Reference

Fetch Creative Upscale result

Fetch the result of an upscale generation by ID.

Make sure to use the same API key to fetch the generation result that you used to create the generation, otherwise you will receive a 404 response.

How to use

Please invoke this endpoint with a GET request.

The headers of the request must include an API key in the authorization field and the ID of your generation must be in the path.

How is progress reported?

Your generation is either in-progress (i.e. status code 202) or it is complete (i.e. status code 200). We may add more fine-grained progress reporting in the future (e.g. a numerical progress).

How long are results stored?

Results are stored for 24 hours after generation. After that, the results are deleted.

GET

v2beta

stable-image

upscale

creative

result

{id}

import requests

generation_id = "e52772ac75b..."

response = requests.request(
    "GET",
    f"https://api.stability.ai/v2beta/stable-image/upscale/creative/result/{generation_id}",
    headers={
        'accept': "image/*",  # Use 'application/json' to receive base64 encoded JSON
        'authorization': f"Bearer sk-MYAPIKEY"
    },
)

if response.status_code == 202:
    print("Generation in-progress, try again in 10 seconds.")
elif response.status_code == 200:
    print("Generation complete!")
    with open("upscaled.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))

"The bytes of the generated jpeg"

{
  "id": "a6dc6c6e20acda010fe14d71f180658f2896ed9b4ec25aa99a6ff06c796987c4",
  "status": "in-progress"
}

{
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "bad_request",
  "errors": [
    "some-field: is required"
  ]
}

{
  "id": "2bca35116bc5431d6dc4b4ea2ef3da2f",
  "name": "generation_not_found",
  "errors": [
    "id: the generation either does not exist or has expired."
  ]
}

{
  "id": "2a1b2d4eafe2bc6ab4cd4d5c6133f513",
  "name": "internal_error",
  "errors": [
    "An unexpected server error has occurred, please try again later."
  ]
}

Authorizations

authorization

string

header

required

Use your Stability API key to authentication requests to this App.

Headers

authorization

string

required

Your Stability API key, used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.

Minimum string length: 1

enum<string>

default:image/*

Specify image/* to receive the bytes of the image directly. Otherwise specify application/json to receive the image as base64 encoded JSON.

Available options:

image/*,

application/json

stability-client-id

string

The name of your application, used to help us communicate app-specific debugging or moderation issues to you.

Maximum string length: 256

Example:

"my-awesome-app"

stability-client-user-id

string

A unique identifier for your end user. Used to help us communicate user-specific debugging or moderation issues to you. Feel free to obfuscate this value to protect user privacy.

Maximum string length: 256

Example:

"DiscordUser#9999"

stability-client-version

string

The version of your application, used to help us communicate version-specific debugging or moderation issues to you.

Maximum string length: 256

Example:

"1.2.1"

Path Parameters

string

required

The id of a generation, typically used for async generations, that can be used to check the status of the generation or retrieve the result.

Required string length: 64

Example:

"a6dc6c6e20acda010fe14d71f180658f2896ed9b4ec25aa99a6ff06c796987c4"

Response

Upscale finished.

The bytes of the generated image.

The finish-reason and seed will be present as headers.