Background changer API
Product background changer API
Keep the model and the outfit exactly as they are and put them somewhere else: a studio color, a hotel lobby, a Paris street or a marble surface. The light on the subject is matched to the new place, in one request per photo.
Test keys are free and need no pack.
- 17 ready scenes, a description in words, or a photo of your own place.
- Several scenes in one request: one image per scene.
- Square, 4:5 or 9:16: the scene is extended so nothing is cut off.



{
"scenes": [
"coast"
],
"description": "a whitewashed Greek island lane with a blue door",
"format": "same"
}One request
Every request is asynchronous: the request returns a job in about two seconds, the images follow in 20 to 90 seconds by webhook or by polling.
curl https://api.garmo.studio/v1/edit/background \
-H "Authorization: Bearer $GARMO_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"image_url": "https://shop.example/products/linen-set-12.jpg",
"scenes": [
"coast"
],
"description": "a whitewashed Greek island lane with a blue door",
"format": "same"
}'const r = await fetch("https://api.garmo.studio/v1/edit/background", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.GARMO_API_KEY}`,
"Idempotency-Key": "order-123-background",
"Content-Type": "application/json",
},
body: JSON.stringify({"image_url": "https://shop.example/products/linen-set-12.jpg", "scenes": ["coast"], "description": "a whitewashed Greek island lane with a blue door", "format": "same"}),
});
const job = await r.json();
console.log(job.id, job.status);import os, requests
r = requests.post(
"https://api.garmo.studio/v1/edit/background",
headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-background"},
json={
"image_url": "https://shop.example/products/linen-set-12.jpg",
"scenes": ["coast"],
"description": "a whitewashed Greek island lane with a blue door",
"format": "same",
},
)
job = r.json()
print(job["id"], job["status"])<?php
$ch = curl_init("https://api.garmo.studio/v1/edit/background");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/linen-set-12.jpg", "scenes" => ["coast"], "description" => "a whitewashed Greek island lane with a blue door", "format" => "same"]),
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-background", "Content-Type: application/json"],
]);
$job = json_decode(curl_exec($ch), true);
echo $job["id"], " ", $job["status"];require "net/http"
require "json"
uri = URI("https://api.garmo.studio/v1/edit/background")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}"
req["Idempotency-Key"] = "order-123-background"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
{
"image_url": "https://shop.example/products/linen-set-12.jpg",
"scenes": [
"coast"
],
"description": "a whitewashed Greek island lane with a blue door",
"format": "same"
}
JSON
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
job = JSON.parse(res.body)
puts job["id"], job["status"]package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"image_url": "https://shop.example/products/linen-set-12.jpg",
"scenes": [
"coast"
],
"description": "a whitewashed Greek island lane with a blue door",
"format": "same"
}`)
req, _ := http.NewRequest("POST", "https://api.garmo.studio/v1/edit/background", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("GARMO_API_KEY"))
req.Header.Set("Idempotency-Key", "order-123-background")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Garmo {
public static void main(String[] args) throws Exception {
String body = """
{
"image_url": "https://shop.example/products/linen-set-12.jpg",
"scenes": [
"coast"
],
"description": "a whitewashed Greek island lane with a blue door",
"format": "same"
}
""";
HttpRequest req = HttpRequest.newBuilder(URI.create("https://api.garmo.studio/v1/edit/background"))
.header("Authorization", "Bearer " + System.getenv("GARMO_API_KEY"))
.header("Idempotency-Key", "order-123-background")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());
System.out.println(res.statusCode() + " " + res.body());
}
}{
"id": "job_8Kq2xV7mPz4LtR9wNc3B",
"object": "job",
"tool": "background",
"status": "completed",
"livemode": true,
"outputs": [
{
"id": "out_1",
"status": "succeeded",
"label": "Your scene",
"url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…",
"url_expires_at": "2026-11-20T14:00:00Z"
},
{
"id": "out_2",
"status": "succeeded",
"label": "Coast at sunset",
"url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…1.webp?X-Amz-Signature=…",
"url_expires_at": "2026-11-20T14:00:00Z"
}
],
"credits_charged": 2,
"credits_refunded": 0,
"metadata": {
"sku": "DR-123"
},
"created_at": "2026-11-19T14:02:11Z",
"completed_at": "2026-11-19T14:02:58Z"
}Parameters
scenes | Scene ids from GET /catalog/scenes. |
description | Your own scene in words (up to 300 characters). |
scene_image_url | A photo of the place to use as the new background (or scene_image_base64, scene_image_upload_id). |
format | Shape of the result; the scene is extended so nothing of the subject is cut off. |
Cost
1 credit per scene
1 API credit = 1 image. Failed and canceled images are refunded automatically.
API pricingWhat people build with it
One shoot, many places
Studio shots for the product page and lifestyle shots for ads from the same photo.
Seasonal refresh
Move the whole catalog to a summer terrace without a new shoot.
Channel formats
4:5 for the feed and 9:16 for stories from one portrait photo.
Questions, answered.
What developers ask before connecting Garmo to a shop or a workflow.
Still stuck? Email usDoes the product change?
No. The prompt behind the endpoint keeps the subject exactly, with every detail and edge, and only replaces what is behind it and the light on it.
Can I use my own location?
Yes. Send scene_image_url with a photo of the place, or describe it in up to 300 characters.
What does it cost?
One credit per scene: three scenes on one photo make three images and cost three credits.
Other edits in the API
POST /generateClothes color changer APIEvery colorway from one photo, to the exact hex.POST /edit/colorPose changer APIThe back view and the walking shot from one photo.POST /edit/poseModel swap APIThe same outfit and pose on another model.POST /edit/model-swapGhost mannequin APIThe invisible-mannequin shot, without the mannequin.POST /edit/ghost-mannequinBackground remover APICut out products onto transparent, white or a brand color.POST /edit/remove-backgroundImage upscaler API2K or 4K product photos with real material detail.POST /edit/upscaleGet an API key
Test keys are free and need no pack.




