Relight API

The Relight API takes an image and applies natural lighting effects to make it appear more realistic. This is especially useful for refining generated or composited images with enhanced natural illumination.

---

Authentication

header

X-Photio-Key : {PHOTIO_API_KEY}

Do you not have an API key yet?

To call the API, you first need to obtain a Photio API key. To get your API key, go to the API Dashboard. After registering your card, you can use the issued API key.

---

Request Body

Variable	Type	Require	Default	Description
image	string	✓	-	The image you want to apply relighting to. It can be either a base64-encoded PNG image or a URL. The input image should be a complete scene or a generated composite.

Shell

curl --request POST \
--url https://api.photio.io/v1/inference/relight \
--header 'X-Photio-Key: {X-Photio-Key}' \
--header 'Content-Type: application/json' \
--data '{ "image": "https://d2yiwnckkg6ukk.cloudfront.net/example/perfume_on_the_beach_output.png" }'

Python

import requests
import json

data = {
  "image": "https://d2yiwnckkg6ukk.cloudfront.net/example/perfume_on_the_beach_output.png"
}

body_data = json.dumps(data)

headers = {
  'X-Photio-Key': '{X-Photio-Key}',
  'Content-Type': 'application/json'
}

response = requests.post('https://api.photio.io/v1/inference/relight', headers=headers, data=body_data)

Java

class Relight {
  public void applyRelight() throws Exception {
    URL url = new URL("https://api.photio.io/v1/inference/relight");
    HttpURLConnection conn = (HttpURLConnection) url.openConnection();

    conn.setRequestProperty("X-Photio-Key", "${PHOTIO_API_KEY}");
    conn.setRequestProperty("Content-Type", "application/json");

    conn.setDoOutput(true);
    conn.setDoInput(true);
    conn.setRequestMethod("POST");

    JSONObject data = new JSONObject();
    data.put("image", "https://d2yiwnckkg6ukk.cloudfront.net/example/perfume_on_the_beach_output.png");

    String bodyData = data.toString();

    try (OutputStream os = conn.getOutputStream()) {
      byte[] input = bodyData.getBytes("utf-8");
      os.write(input, 0, input.length);
    }

    int responseCode = conn.getResponseCode();
    System.out.println("Response Code : " + responseCode);

    conn.disconnect();
  }
}

JS

const data = {
  image: 'https://d2yiwnckkg6ukk.cloudfront.net/example/perfume_on_the_beach_output.png'
};

const bodyData = JSON.stringify(data);

const headers = {
  'X-Photio-Key': '{X-Photio-Key}',
  'Content-Type': 'application/json'
};

fetch('https://api.photio.io/v1/inference/relight', {
  method: 'POST',
  headers: headers,
  body: bodyData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

---

Body Example

{
  "image": "https://d2yiwnckkg6ukk.cloudfront.net/example/perfume_on_the_beach_output.png"
}

Response

Variable	Type	Description
status_code	int	In the response, you can find a status value to check the status of the request. A normal response is indicated by 200, authentication issues by 401, and API status problems by a 500 error.
body	string	The relighted image data is output as a Base64-encoded string.

Response Example

{
  "status_code": 200,
  "body": "Base64 String"
}

Output Example